blob: a5ff937e080e92b01a639e36beb3a4099e7d8103 [file] [log] [blame]
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001*options.txt* For Vim version 8.2. Last change: 2021 Dec 11
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
90 comma separated list, a comma is added, unless the
91 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
100 comma separated list, a comma is added, unless the
101 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
173 E846: Key code not set: t_kb
174
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 Moolenaar071d4272004-06-13 20:20:40 +0000372Note: In the future more global options can be made global-local. Using
373":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)}
386 " set using a funcref variable
387 let Fn = function('MyTagFunc')
388 let &tagfunc = string(Fn)
389 " set using a lambda expression
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000390 let &tagfunc = {t -> MyTagFunc(t)}
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000391 " set using a variable with lambda expression
392 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000393 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000394
395In Vim9 script, in a compiled function, you can use a lambda, but a
396closured does not work, because the function will be called without the
397context of where it was defined.
398
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000399
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400Setting the filetype
401
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200402:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000403 Set the 'filetype' option to {filetype}, but only if
404 not done yet in a sequence of (nested) autocommands.
405 This is short for: >
406 :if !did_filetype()
407 : setlocal filetype={filetype}
408 :endif
409< This command is used in a filetype.vim file to avoid
410 setting the 'filetype' option twice, causing different
411 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200412
413 When the optional FALLBACK argument is present, a
414 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100415 'filetype'. This is to be used for filetype
416 detections that are just a guess. |did_filetype()|
417 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200418
Bram Moolenaard58e9292011-02-09 17:07:58 +0100419 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
421:opt[ions] Open a window for viewing and setting all options.
422 Options are grouped by function.
423 Offers short help for each option. Hit <CR> on the
424 short help to open a help window with more help for
425 the option.
426 Modify the value of the option and hit <CR> on the
427 "set" line to set the new value. For window and
428 buffer specific options, the last accessed window is
429 used to set the option value in, unless this is a help
430 window, in which case the window below help window is
431 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100432 {not available when compiled without the |+eval|
433 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434
435 *$HOME*
436Using "~" is like using "$HOME", but it is only recognized at the start of an
437option and after a space or comma.
438
439On Unix systems "~user" can be used too. It is replaced by the home directory
440of user "user". Example: >
441 :set path=~mool/include,/usr/include,.
442
443On Unix systems the form "${HOME}" can be used too. The name between {} can
444contain non-id characters then. Note that if you want to use this for the
445"gf" command, you need to add the '{' and '}' characters to 'isfname'.
446
447NOTE: expanding environment variables and "~/" is only done with the ":set"
448command, not when assigning a value to an option with ":let".
449
Bram Moolenaarc572da52017-08-27 16:52:01 +0200450 *$HOME-windows*
451On MS-Windows, if $HOME is not defined as an environment variable, then
452at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200453If $HOMEDRIVE is not set then $USERPROFILE is used.
454
455This expanded value is not exported to the environment, this matters when
456running an external command: >
457 :echo system('set | findstr ^HOME=')
458and >
459 :echo luaeval('os.getenv("HOME")')
460should echo nothing (an empty string) despite exists('$HOME') being true.
461When setting $HOME to a non-empty string it will be exported to the
462subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200463
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464
465Note the maximum length of an expanded option is limited. How much depends on
466the system, mostly it is something like 256 or 1024 characters.
467
468 *:fix* *:fixdel*
469:fix[del] Set the value of 't_kD':
470 't_kb' is 't_kD' becomes ~
471 CTRL-? CTRL-H
472 not CTRL-? CTRL-?
473
Bram Moolenaar82be4842021-01-11 19:40:15 +0100474 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
476 If your delete key terminal code is wrong, but the
477 code for backspace is alright, you can put this in
478 your .vimrc: >
479 :fixdel
480< This works no matter what the actual code for
481 backspace is.
482
483 If the backspace key terminal code is wrong you can
484 use this: >
485 :if &term == "termname"
486 : set t_kb=^V<BS>
487 : fixdel
488 :endif
489< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000490 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000491 with your terminal name.
492
493 If your <Delete> key sends a strange key sequence (not
494 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
495 :if &term == "termname"
496 : set t_kD=^V<Delete>
497 :endif
498< Where "^V" is CTRL-V and "<Delete>" is the delete key
499 (don't type eight characters!). Replace "termname"
500 with your terminal name.
501
502 *Linux-backspace*
503 Note about Linux: By default the backspace key
504 produces CTRL-?, which is wrong. You can fix it by
505 putting this line in your rc.local: >
506 echo "keycode 14 = BackSpace" | loadkeys
507<
508 *NetBSD-backspace*
509 Note about NetBSD: If your backspace doesn't produce
510 the right code, try this: >
511 xmodmap -e "keycode 22 = BackSpace"
512< If this works, add this in your .Xmodmap file: >
513 keysym 22 = BackSpace
514< You need to restart for this to take effect.
515
516==============================================================================
5172. Automatically setting options *auto-setting*
518
519Besides changing options with the ":set" command, there are three alternatives
520to set options automatically for one or more files:
521
5221. When starting Vim initializations are read from various places. See
523 |initialization|. Most of them are performed for all editing sessions,
524 and some of them depend on the directory where Vim is started.
525 You can create an initialization file with |:mkvimrc|, |:mkview| and
526 |:mksession|.
5272. If you start editing a new file, the automatic commands are executed.
528 This can be used to set options for files matching a particular pattern and
529 many other things. See |autocommand|.
5303. If you start editing a new file, and the 'modeline' option is on, a
531 number of lines at the beginning and end of the file are checked for
532 modelines. This is explained here.
533
534 *modeline* *vim:* *vi:* *ex:* *E520*
535There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100536 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100538[text{white}] empty or any text followed by at least one blank
539 character (<Space> or <Tab>); "ex:" always requires at
540 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200541{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200542[white] optional white space
543{options} a list of option settings, separated with white space
544 or ':', where each part between ':' is the argument
545 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546
Bram Moolenaar14b69452013-06-29 23:05:20 +0200547Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000548 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200549 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
551The second form (this is compatible with some versions of Vi):
552
Bram Moolenaarade0d392020-01-21 22:33:58 +0100553 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
Bram Moolenaarade0d392020-01-21 22:33:58 +0100555[text{white}] empty or any text followed by at least one blank
556 character (<Space> or <Tab>); "ex:" always requires at
557 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200558{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
559[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200560se[t] the string "set " or "se " (note the space); When
561 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200562{options} a list of options, separated with white space, which
563 is the argument for a ":set" command
564: a colon
565[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566
Bram Moolenaar14b69452013-06-29 23:05:20 +0200567Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000568 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200569 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200571The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
572chance that a normal word like "lex:" is caught. There is one exception:
573"vi:" and "vim:" can also be at the start of the line (for compatibility with
574version 3.0). Using "ex:" at the start of the line will be ignored (this
575could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
Hu Jialun9dcd3492021-08-28 20:42:50 +0200577If the modeline is disabled within a modeline, subsequent modelines will be
578ignored. This is to allow turning off modeline on a per-file basis. This is
579useful when a line looks like a modeline but isn't. For example, it would be
580good to start a YAML file containing strings like "vim:" with
581 # vim: nomodeline ~
582so as to avoid modeline misdetection. Following options on the same line
583after modeline deactivation, if any, are still evaluated (but you would
584normally not have any).
585
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586 *modeline-local*
587The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000588buffer and window that contain the file. Although it's possible to set global
589options from a modeline, this is unusual. If you have two windows open and
590the files in it set the same global option to a different value, the result
591depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000593When editing a file that was already loaded, only the window-local options
594from the modeline are used. Thus if you manually changed a buffer-local
595option after opening the file, it won't be changed if you edit the same buffer
596in another window. But window-local options will be set.
597
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598 *modeline-version*
599If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200600number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601 vim{vers}: version {vers} or later
602 vim<{vers}: version before {vers}
603 vim={vers}: version {vers}
604 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100605{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
606For example, to use a modeline only for Vim 7.0:
607 /* vim700: set foldmethod=marker */ ~
608To use a modeline for Vim after version 7.2:
609 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610There can be no blanks between "vim" and the ":".
611
612
613The number of lines that are checked can be set with the 'modelines' option.
614If 'modeline' is off or 'modelines' is 0 no lines are checked.
615
616Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000617like:
618 /* vi:ts=4: */ ~
619will give an error message for the trailing "*/". This line is OK:
620 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
622If an error is detected the rest of the line is skipped.
623
624If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000625backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100626 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
627This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
628before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200629 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000631might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200632can be set. For some options a flag is set, so that when the value is used
633the |sandbox| is effective. Some options can only be set from the modeline
634when 'modelineexpr' is set (the default is off).
635
636Still, there is always a small risk that a modeline causes trouble. E.g.,
637when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
638So disable modelines before editing untrusted text. The mail ftplugin does
639this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640
641Hint: If you would like to do something else than setting an option, you could
642define an autocommand that checks the file for a specific string. For
643example: >
644 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
645And define a function SetVar() that does something with the line containing
646"VAR".
647
648==============================================================================
6493. Options summary *option-summary*
650
651In the list below all the options are mentioned with their full name and with
652an abbreviation if there is one. Both forms may be used.
653
654In this document when a boolean option is "set" that means that ":set option"
655is entered. When an option is "reset", ":set nooption" is used.
656
657For some options there are two default values: The "Vim default", which is
658used when 'compatible' is not set, and the "Vi default", which is used when
659'compatible' is set.
660
661Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000662are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663different value in each window. For example the 'list' option can be set in
664one window and reset in another for the same text, giving both types of view
665at the same time. There are a few options that are specific to a certain
666file. These can have a different value for each file or buffer. For example
667the 'textwidth' option can be 78 for a normal text file and 0 for a C
668program.
669
670 global one option for all buffers and windows
671 local to window each window has its own copy of this option
672 local to buffer each buffer has its own copy of this option
673
674When creating a new window the option values from the currently active window
675are used as a default value for the window-specific options. For the
676buffer-specific options this depends on the 's' and 'S' flags in the
677'cpoptions' option. If 's' is included (which is the default) the values for
678buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000679first entered. If 'S' is present the options are copied each time the buffer
680is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681present, the options are copied from the currently active buffer when the
682buffer is created.
683
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000684Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000686Not all options are supported in all versions. This depends on the supported
687features and sometimes on the system. A remark about this is in curly braces
688below. When an option is not supported it may still be set without getting an
689error, this is called a hidden option. You can't get the value of a hidden
690option though, it is not stored.
691
692To test if option "foo" can be used with ":set" use something like this: >
693 if exists('&foo')
694This also returns true for a hidden option. To test if option "foo" is really
695supported use something like this: >
696 if exists('+foo')
697<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698 *E355*
699A jump table for the options with a short description can be found at |Q_op|.
700
701 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100702'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704 {only available when compiled with the |+rightleft|
705 feature}
706 The ASCII code for the first letter of the Hebrew alphabet. The
707 routine that maps the keyboard in Hebrew mode, both in Insert mode
708 (when hkmap is set) and on the command-line (when hitting CTRL-_)
709 outputs the Hebrew characters in the range [aleph..aleph+26].
710 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
711 See |rileft.txt|.
712
713 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
714'allowrevins' 'ari' boolean (default off)
715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 {only available when compiled with the |+rightleft|
717 feature}
718 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
719 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
720 into reverse Insert mode, and don't know how to get out. See
721 'revins'.
722 NOTE: This option is reset when 'compatible' is set.
723
724 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
725'altkeymap' 'akm' boolean (default off)
726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727 {only available when compiled with the |+farsi|
728 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100729 This option was for using Farsi, which has been removed. See
730 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'ambiwidth'* *'ambw'*
733'ambiwidth' 'ambw' string (default: "single")
734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
736 Tells Vim what to do with characters with East Asian Width Class
737 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
738 letters, Cyrillic letters).
739
740 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000741 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742 expected by most users.
743 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200744 *E834* *E835*
745 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100746 contains a character that would be double width. These errors may
747 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200748
749 The values are overruled for characters specified with
750 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751
752 There are a number of CJK fonts for which the width of glyphs for
753 those characters are solely based on how many octets they take in
754 legacy/traditional CJK encodings. In those encodings, Euro,
755 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000756 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000758 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759 Vim is running inside a terminal (emulators) that uses a CJK font
760 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
761 this option should be set to "double" to match the width perceived
762 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100763 to be set to "double" under CJK MS-Windows when the system locale is
764 set to one of CJK locales. See Unicode Standard Annex #11
765 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100767 Vim may set this option automatically at startup time when Vim is
768 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200769 escape sequence to request cursor position report. The response can
770 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100771
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
773'antialias' 'anti' boolean (default: off)
774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200776 on macOS}
777 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
779 which can be easier to read at certain sizes on certain displays.
780 Setting this option can sometimes cause problems if 'guifont' is set
781 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100782 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783
784 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
785'autochdir' 'acd' boolean (default off)
786 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200787 {only available when compiled with it, use
788 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000789 When on, Vim will change the current working directory whenever you
790 open a file, switch buffers, delete a buffer or open/close a window.
791 It will change to the directory containing the file which was opened
792 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000793 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200795 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
796'autoshelldir' 'asd' boolean (default off)
797 global
798 When on, Vim will change the current working directory whenever you
799 change the directory of the shell running in a terminal window. You
800 need proper setting-up, so whenever the shell's pwd changes an OSC 7
801 escape sequence will be emitted. For example, on Linux, you can source
802 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
803
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
805'arabic' 'arab' boolean (default off)
806 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 {only available when compiled with the |+arabic|
808 feature}
809 This option can be set to start editing Arabic text.
810 Setting this option will:
811 - Set the 'rightleft' option, unless 'termbidi' is set.
812 - Set the 'arabicshape' option, unless 'termbidi' is set.
813 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
814 between typing English and Arabic key mapping.
815 - Set the 'delcombine' option
816 Note that 'encoding' must be "utf-8" for working with Arabic text.
817
818 Resetting this option will:
819 - Reset the 'rightleft' option.
820 - Disable the use of 'keymap' (without changing its value).
821 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200822 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100823 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824 Also see |arabic.txt|.
825
826 *'arabicshape'* *'arshape'*
827 *'noarabicshape'* *'noarshape'*
828'arabicshape' 'arshape' boolean (default on)
829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 {only available when compiled with the |+arabic|
831 feature}
832 When on and 'termbidi' is off, the required visual character
833 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200834 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 one which encompasses:
836 a) the changing/morphing of characters based on their location
837 within a word (initial, medial, final and stand-alone).
838 b) the enabling of the ability to compose characters
839 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100840 When disabled the display shows each character's true stand-alone
841 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 Arabic is a complex language which requires other settings, for
843 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100844 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845
846 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
847'autoindent' 'ai' boolean (default off)
848 local to buffer
849 Copy indent from current line when starting a new line (typing <CR>
850 in Insert mode or when using the "o" or "O" command). If you do not
851 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000852 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
853 to another line has the same effect, unless the 'I' flag is included
854 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000855 When autoindent is on, formatting (with the "gq" command or when you
856 reach 'textwidth' in Insert mode) uses the indentation of the first
857 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858 When 'smartindent' or 'cindent' is on the indent is changed in
859 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200860 The 'autoindent' option is reset when the 'paste' option is set and
861 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862
863 *'autoread'* *'ar'* *'noautoread'* *'noar'*
864'autoread' 'ar' boolean (default off)
865 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 When a file has been detected to have been changed outside of Vim and
867 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200868 When the file has been deleted this is not done, so you have the text
869 from before it was deleted. When it appears again then it is read.
870 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 If this option has a local value, use this command to switch back to
872 using the global value: >
873 :set autoread<
874<
875 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
876'autowrite' 'aw' boolean (default off)
877 global
878 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000879 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
880 `:suspend`, `:tag, `:!`, ``:make`, CTRL-] and CTRL-^ command; and when
881 a :buffer, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
882 to another file.
883 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
884 set to "hide" and `:next` is used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 Note that for some commands the 'autowrite' option is not used, see
886 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200887 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200888 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889
890 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
891'autowriteall' 'awa' boolean (default off)
892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
894 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
895 Setting this option also implies that Vim behaves like 'autowrite' has
896 been set.
897
898 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200899'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 When set to "dark", Vim will try to use colors that look good on a
902 dark background. When set to "light", Vim will try to use colors that
903 look good on a light background. Any other value is illegal.
904 Vim tries to set the default value according to the terminal used.
905 This will not always be correct.
906 Setting this option does not change the background color, it tells Vim
907 what the background color looks like. For changing the background
908 color, see |:hi-normal|.
909
910 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000911 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000912 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100913 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 setting 'background' will cause the color scheme to be reloaded. If
915 the color scheme adjusts to the value of 'background' this will work.
916 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100917 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918
919 When setting 'background' to the default value with: >
920 :set background&
921< Vim will guess the value. In the GUI this should work correctly,
922 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200923 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200924 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200926 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200927 color from the terminal. If the returned RGB value is dark/light and
928 'background' is not dark/light, 'background' will be set and the
929 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200930 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100931 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200932
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 When starting the GUI, the default value for 'background' will be
934 "light". When the value is not set in the .gvimrc, and Vim detects
935 that the background is actually quite dark, 'background' is set to
936 "dark". But this happens only AFTER the .gvimrc file has been read
937 (because the window needs to be opened to find the actual background
938 color). To get around this, force the GUI window to be opened by
939 putting a ":gui" command in the .gvimrc file, before where the value
940 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200941
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100942 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200943 For other systems "dark" is used when 'term' is "linux",
944 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
945 background. Otherwise the default is "light".
946
Bram Moolenaarc572da52017-08-27 16:52:01 +0200947 The |:terminal| command and the |term_start()| function use the
948 'background' value to decide whether the terminal window will start
949 with a white or black background.
950
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 Normally this option would be set in the .vimrc file. Possibly
952 depending on the terminal name. Example: >
953 :if &term == "pcterm"
954 : set background=dark
955 :endif
956< When this option is set, the default settings for the highlight groups
957 will change. To use other settings, place ":highlight" commands AFTER
958 the setting of the 'background' option.
959 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
960 to select the colors for syntax highlighting. After changing this
961 option, you must load syntax.vim again to see the result. This can be
962 done with ":syntax on".
963
964 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200965'backspace' 'bs' string (default "", set to "indent,eol,start"
966 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
969 mode. This is a list of items, separated by commas. Each item allows
970 a way to backspace over something:
971 value effect ~
972 indent allow backspacing over autoindent
973 eol allow backspacing over line breaks (join lines)
974 start allow backspacing over the start of insert; CTRL-W and CTRL-U
975 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200976 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
977 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978
979 When the value is empty, Vi compatible backspacing is used.
980
981 For backwards compatibility with version 5.4 and earlier:
982 value effect ~
983 0 same as ":set backspace=" (Vi compatible)
984 1 same as ":set backspace=indent,eol"
985 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200986 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987
988 See |:fixdel| if your <BS> or <Del> key does not do what you want.
989 NOTE: This option is set to "" when 'compatible' is set.
990
991 *'backup'* *'bk'* *'nobackup'* *'nobk'*
992'backup' 'bk' boolean (default off)
993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 Make a backup before overwriting a file. Leave it around after the
995 file has been successfully written. If you do not want to keep the
996 backup file, but you do want a backup while the file is being
997 written, reset this option and set the 'writebackup' option (this is
998 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000999 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 |backup-table| for more explanations.
1001 When the 'backupskip' pattern matches, a backup is not made anyway.
1002 When 'patchmode' is set, the backup may be renamed to become the
1003 oldest version of a file.
1004 NOTE: This option is reset when 'compatible' is set.
1005
1006 *'backupcopy'* *'bkc'*
1007'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001008 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009 When writing a file and a backup is made, this option tells how it's
1010 done. This is a comma separated list of words.
1011
1012 The main values are:
1013 "yes" make a copy of the file and overwrite the original one
1014 "no" rename the file and write a new one
1015 "auto" one of the previous, what works best
1016
1017 Extra values that can be combined with the ones above are:
1018 "breaksymlink" always break symlinks when writing
1019 "breakhardlink" always break hardlinks when writing
1020
1021 Making a copy and overwriting the original file:
1022 - Takes extra time to copy the file.
1023 + When the file has special attributes, is a (hard/symbolic) link or
1024 has a resource fork, all this is preserved.
1025 - When the file is a link the backup will have the name of the link,
1026 not of the real file.
1027
1028 Renaming the file and writing a new one:
1029 + It's fast.
1030 - Sometimes not all attributes of the file can be copied to the new
1031 file.
1032 - When the file is a link the new file will not be a link.
1033
1034 The "auto" value is the middle way: When Vim sees that renaming file
1035 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001036 the file is not a link) that is used. When problems are expected, a
1037 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038
1039 The "breaksymlink" and "breakhardlink" values can be used in
1040 combination with any of "yes", "no" and "auto". When included, they
1041 force Vim to always break either symbolic or hard links by doing
1042 exactly what the "no" option does, renaming the original file to
1043 become the backup and writing a new file in its place. This can be
1044 useful for example in source trees where all the files are symbolic or
1045 hard links and any changes should stay in the local source tree, not
1046 be propagated back to the original source.
1047 *crontab*
1048 One situation where "no" and "auto" will cause problems: A program
1049 that opens a file, invokes Vim to edit that file, and then tests if
1050 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001051 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 example.
1053
1054 When a copy is made, the original file is truncated and then filled
1055 with the new text. This means that protection bits, owner and
1056 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001057 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 group of the backup is set to the group of the original file. If this
1059 fails, the protection bits for the group are made the same as for
1060 others.
1061
1062 When the file is renamed this is the other way around: The backup has
1063 the same attributes of the original file, and the newly written file
1064 is owned by the current user. When the file was a (hard/symbolic)
1065 link, the new file will not! That's why the "auto" value doesn't
1066 rename when the file is a link. The owner and group of the newly
1067 written file will be set to the same ones as the original file, but
1068 the system may refuse to do this. In that case the "auto" value will
1069 again not rename the file.
1070
Bram Moolenaar036986f2017-03-16 17:41:02 +01001071 NOTE: This option is set to the Vi default value when 'compatible' is
1072 set and to the Vim default value when 'compatible' is reset.
1073
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 *'backupdir'* *'bdir'*
1075'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001076 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077 for Unix: ".,~/tmp,~/")
1078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 List of directories for the backup file, separated with commas.
1080 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001081 where this is possible. The directory must exist, Vim will not
1082 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001083 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084 impossible!). Writing may fail because of this.
1085 - A directory "." means to put the backup file in the same directory
1086 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001087 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1088 the backup file relative to where the edited file is. The leading
1089 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 ("." inside a directory name has no special meaning).
1091 - Spaces after the comma are ignored, other spaces are considered part
1092 of the directory name. To have a space at the start of a directory
1093 name, precede it with a backslash.
1094 - To include a comma in a directory name precede it with a backslash.
1095 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001096 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001097 the backup file name will be built from the complete path to the
1098 file with all path separators changed to percent '%' signs. This
1099 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001100 On Win32, it is also possible to end with "\\". However, When a
1101 separating comma is following, you must use "//", since "\\" will
1102 include the comma in the file name. Therefore it is recommended to
1103 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104 - Environment variables are expanded |:set_env|.
1105 - Careful with '\' characters, type one before a space, type two to
1106 get one in the option (see |option-backslash|), for example: >
1107 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1108< - For backwards compatibility with Vim version 3.0 a '>' at the start
1109 of the option is removed.
1110 See also 'backup' and 'writebackup' options.
1111 If you want to hide your backup files on Unix, consider this value: >
1112 :set backupdir=./.backup,~/.backup,.,/tmp
1113< You must create a ".backup" directory in each directory and in your
1114 home directory for this to work properly.
1115 The use of |:set+=| and |:set-=| is preferred when adding or removing
1116 directories from the list. This avoids problems when a future version
1117 uses another default.
1118 This option cannot be set from a |modeline| or in the |sandbox|, for
1119 security reasons.
1120
1121 *'backupext'* *'bex'* *E589*
1122'backupext' 'bex' string (default "~", for VMS: "_")
1123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124 String which is appended to a file name to make the name of the
1125 backup file. The default is quite unusual, because this avoids
1126 accidentally overwriting existing files with a backup file. You might
1127 prefer using ".bak", but make sure that you don't have files with
1128 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001129 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001131 If you like to keep a lot of backups, you could use a BufWritePre
1132 autocommand to change 'backupext' just before writing the file to
1133 include a timestamp. >
1134 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1135< Use 'backupdir' to put the backup in a different directory.
1136
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001138'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1139 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1140 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 {not available when compiled without the |+wildignore|
1143 feature}
1144 A list of file patterns. When one of the patterns matches with the
1145 name of the file which is written, no backup file is created. Both
1146 the specified file name and the full path name of the file are used.
1147 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1148 Watch out for special characters, see |option-backslash|.
1149 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001150 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001151
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001152 WARNING: Not having a backup file means that when Vim fails to write
1153 your buffer correctly and then, for whatever reason, Vim exits, you
1154 lose both the original file and what you were writing. Only disable
1155 backups if you don't care about losing the file.
1156
Bram Moolenaar02467872007-05-06 13:22:01 +00001157 Note that environment variables are not expanded. If you want to use
1158 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001159 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001160
1161< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001162 backup would be made by renaming the original file crontab won't see
1163 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165 *'balloondelay'* *'bdlay'*
1166'balloondelay' 'bdlay' number (default: 600)
1167 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 {only available when compiled with the |+balloon_eval|
1169 feature}
1170 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1171
1172 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1173'ballooneval' 'beval' boolean (default off)
1174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001176 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001177 Switch on the |balloon-eval| functionality for the GUI.
1178
1179 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1180 *'nobevalterm'*
1181'balloonevalterm' 'bevalterm' boolean (default off)
1182 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001183 {only available when compiled with the
1184 |+balloon_eval_term| feature}
1185 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001187 *'balloonexpr'* *'bexpr'*
1188'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001189 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001190 {only available when compiled with the |+balloon_eval|
1191 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001192 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001193 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1194 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001195
1196 v:beval_bufnr number of the buffer in which balloon is going to show
1197 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001198 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001199 v:beval_lnum line number
1200 v:beval_col column number (byte index)
1201 v:beval_text word under or after the mouse pointer
1202
Bram Moolenaar54775062019-07-31 21:07:14 +02001203 Instead of showing a balloon, which is limited to plain text, consider
1204 using a popup window, see |popup_beval_example|. A popup window can
1205 use highlighting and show a border.
1206
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001207 The evaluation of the expression must not have side effects!
1208 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001209 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001210 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001211 \', column ' . v:beval_col .
1212 \ ' of file ' . bufname(v:beval_bufnr) .
1213 \ ' on word "' . v:beval_text . '"'
1214 endfunction
1215 set bexpr=MyBalloonExpr()
1216 set ballooneval
1217<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001218 Also see |balloon_show()|, it can be used if the content of the balloon
1219 is to be fetched asynchronously. In that case evaluating
1220 'balloonexpr' should result in an empty string. If you get a balloon
1221 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001222
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001223 NOTE: The balloon is displayed only if the cursor is on a text
1224 character. If the result of evaluating 'balloonexpr' is not empty,
1225 Vim does not try to send a message to an external debugger (Netbeans
1226 or Sun Workshop).
1227
Bram Moolenaar30b65812012-07-12 22:01:11 +02001228 The expression will be evaluated in the |sandbox| when set from a
1229 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001230 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001231
1232 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001233 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001234
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001235 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001236 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001237< When they are supported "\n" characters will start a new line. If the
1238 expression evaluates to a |List| this is equal to using each List item
1239 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001240 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001241
Bram Moolenaar165bc692015-07-21 17:53:25 +02001242 *'belloff'* *'bo'*
1243'belloff' 'bo' string (default "")
1244 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001245 Specifies for which events the bell will not be rung. It is a comma
1246 separated list of items. For each item that is present, the bell
1247 will be silenced. This is most useful to specify specific events in
1248 insert mode to be silenced.
1249
1250 item meaning when present ~
1251 all All events.
1252 backspace When hitting <BS> or <Del> and deleting results in an
1253 error.
1254 cursor Fail to move around using the cursor keys or
1255 <PageUp>/<PageDown> in |Insert-mode|.
1256 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1257 |i_CTRL-X_CTRL-T|.
1258 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1259 |i_CTRL-E|.
1260 ctrlg Unknown Char after <C-G> in Insert mode.
1261 error Other Error occurred (e.g. try to join last line)
1262 (mostly used in |Normal-mode| or |Cmdline-mode|).
1263 esc hitting <Esc> in |Normal-mode|.
1264 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001265 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001266 insertmode Pressing <Esc> in 'insertmode'.
1267 lang Calling the beep module for Lua/Mzscheme/TCL.
1268 mess No output available for |g<|.
1269 showmatch Error occurred for 'showmatch' function.
1270 operator Empty region error |cpo-E|.
1271 register Unknown register after <C-R> in |Insert-mode|.
1272 shell Bell from shell output |:!|.
1273 spell Error happened on spell suggest.
1274 wildmode More matches in |cmdline-completion| available
1275 (depends on the 'wildmode' setting).
1276
Bram Moolenaar036986f2017-03-16 17:41:02 +01001277 This is most useful to fine tune when in Insert mode the bell should
1278 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001279 indicate that an error occurred. It can be silenced by adding the
1280 "error" keyword.
1281
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1283'binary' 'bin' boolean (default off)
1284 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 This option should be set before editing a binary file. You can also
1286 use the |-b| Vim argument. When this option is switched on a few
1287 options will be changed (also when it already was on):
1288 'textwidth' will be set to 0
1289 'wrapmargin' will be set to 0
1290 'modeline' will be off
1291 'expandtab' will be off
1292 Also, 'fileformat' and 'fileformats' options will not be used, the
1293 file is read and written like 'fileformat' was "unix" (a single <NL>
1294 separates lines).
1295 The 'fileencoding' and 'fileencodings' options will not be used, the
1296 file is read without conversion.
1297 NOTE: When you start editing a(nother) file while the 'bin' option is
1298 on, settings from autocommands may change the settings again (e.g.,
1299 'textwidth'), causing trouble when editing. You might want to set
1300 'bin' again when the file has been loaded.
1301 The previous values of these options are remembered and restored when
1302 'bin' is switched from on to off. Each buffer has its own set of
1303 saved option values.
1304 To edit a file with 'binary' set you can use the |++bin| argument.
1305 This avoids you have to do ":set bin", which would have effect for all
1306 files you edit.
1307 When writing a file the <EOL> for the last line is only written if
1308 there was one in the original file (normally Vim appends an <EOL> to
1309 the last line if there is none; this would make the file longer). See
1310 the 'endofline' option.
1311
1312 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1313'bioskey' 'biosk' boolean (default on)
1314 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001315 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001316 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317
1318 *'bomb'* *'nobomb'*
1319'bomb' boolean (default off)
1320 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 When writing a file and the following conditions are met, a BOM (Byte
1322 Order Mark) is prepended to the file:
1323 - this option is on
1324 - the 'binary' option is off
1325 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1326 endian variants.
1327 Some applications use the BOM to recognize the encoding of the file.
1328 Often used for UCS-2 files on MS-Windows. For other applications it
1329 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001330 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1332 check for the presence of the BOM is done and 'bomb' set accordingly.
1333 Unless 'binary' is set, it is removed from the first line, so that you
1334 don't see it when editing. When you don't change the options, the BOM
1335 will be restored when writing the file.
1336
1337 *'breakat'* *'brk'*
1338'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1339 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001340 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 feature}
1342 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001343 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1344 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001346 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001347'breakindent' 'bri' boolean (default off)
1348 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001349 {not available when compiled without the |+linebreak|
1350 feature}
1351 Every wrapped line will continue visually indented (same amount of
1352 space as the beginning of that line), thus preserving horizontal blocks
1353 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001354 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001355
1356 *'breakindentopt'* *'briopt'*
1357'breakindentopt' 'briopt' string (default empty)
1358 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001359 {not available when compiled without the |+linebreak|
1360 feature}
1361 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001362 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001363 min:{n} Minimum text width that will be kept after
1364 applying 'breakindent', even if the resulting
1365 text should normally be narrower. This prevents
1366 text indented almost to the right window border
1367 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001368 shift:{n} After applying 'breakindent', the wrapped line's
1369 beginning will be shifted by the given number of
1370 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001371 indentation (negative) or emphasizing the line
1372 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001373 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001374 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001375 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001376 numbered or bulleted list (using the
1377 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001378 list:-1 Uses the length of a match with 'formatlistpat'
1379 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001380 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001381
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001383'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001385 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001387 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001388 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 buffer Use the directory of the related buffer.
1390 current Use the current directory.
1391 {path} Use the specified directory
1392
1393 *'bufhidden'* *'bh'*
1394'bufhidden' 'bh' string (default: "")
1395 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 This option specifies what happens when a buffer is no longer
1397 displayed in a window:
1398 <empty> follow the global 'hidden' option
1399 hide hide the buffer (don't unload it), also when 'hidden'
1400 is not set
1401 unload unload the buffer, also when 'hidden' is set or using
1402 |:hide|
1403 delete delete the buffer from the buffer list, also when
1404 'hidden' is set or using |:hide|, like using
1405 |:bdelete|
1406 wipe wipe out the buffer from the buffer list, also when
1407 'hidden' is set or using |:hide|, like using
1408 |:bwipeout|
1409
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001410 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001411 are lost without a warning. Also, these values may break autocommands
1412 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413 This option is used together with 'buftype' and 'swapfile' to specify
1414 special kinds of buffers. See |special-buffers|.
1415
1416 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1417'buflisted' 'bl' boolean (default: on)
1418 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 When this option is set, the buffer shows up in the buffer list. If
1420 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1421 This option is reset by Vim for buffers that are only used to remember
1422 a file name or marks. Vim sets it when starting to edit a buffer.
1423 But not when moving to a buffer with ":buffer".
1424
1425 *'buftype'* *'bt'* *E382*
1426'buftype' 'bt' string (default: "")
1427 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 The value of this option specifies the type of a buffer:
1429 <empty> normal buffer
1430 nofile buffer which is not related to a file and will not be
1431 written
1432 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001433 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001434 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001436 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 help help buffer (you are not supposed to set this
1438 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001439 terminal buffer for a |terminal| (you are not supposed to set
1440 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001441 prompt buffer where only the last line can be edited, meant
1442 to be used by a plugin, see |prompt-buffer|
1443 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001444 popup buffer used in a popup window, see |popup|.
1445 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446
1447 This option is used together with 'bufhidden' and 'swapfile' to
1448 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001449 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450
1451 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001452 One such effect is that Vim will not check the timestamp of the file,
1453 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
Bram Moolenaar280f1262006-01-30 00:14:18 +00001455 A "quickfix" buffer is only used for the error list and the location
1456 list. This value is set by the |:cwindow| and |:lwindow| commands and
1457 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458
1459 "nofile" and "nowrite" buffers are similar:
1460 both: The buffer is not to be written to disk, ":w" doesn't
1461 work (":w filename" does work though).
1462 both: The buffer is never considered to be |'modified'|.
1463 There is no warning when the changes will be lost, for
1464 example when you quit Vim.
1465 both: A swap file is only created when using too much memory
1466 (when 'swapfile' has been reset there is never a swap
1467 file).
1468 nofile only: The buffer name is fixed, it is not handled like a
1469 file name. It is not modified in response to a |:cd|
1470 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001471 both: When using ":e bufname" and already editing "bufname"
1472 the buffer is made empty and autocommands are
1473 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001474 *E676*
1475 "acwrite" implies that the buffer name is not related to a file, like
1476 "nofile", but it will be written. Thus, in contrast to "nofile" and
1477 "nowrite", ":w" does work and a modified buffer can't be abandoned
1478 without saving. For writing there must be matching |BufWriteCmd|,
1479 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480
1481 *'casemap'* *'cmp'*
1482'casemap' 'cmp' string (default: "internal,keepascii")
1483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484 Specifies details about changing the case of letters. It may contain
1485 these words, separated by a comma:
1486 internal Use internal case mapping functions, the current
1487 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001488 matters when 'encoding' is a Unicode encoding,
1489 "latin1" or "iso-8859-15". When "internal" is
1490 omitted, the towupper() and towlower() system library
1491 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1493 case mapping, the current locale is not effective.
1494 This probably only matters for Turkish.
1495
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001496 *'cdhome'* *'cdh'*
1497'cdhome' 'cdh' boolean (default: off)
1498 global
1499 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1500 current working directory to the |$HOME| directory like in Unix.
1501 When off, those commands just print the current directory name.
1502 On Unix this option has no effect.
1503 NOTE: This option is reset when 'compatible' is set.
1504
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 *'cdpath'* *'cd'* *E344* *E346*
1506'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 {not available when compiled without the
1509 |+file_in_path| feature}
1510 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001511 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1512 searched for has a relative path, not an absolute part starting with
1513 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514 The 'cdpath' option's value has the same form and semantics as
1515 |'path'|. Also see |file-searching|.
1516 The default value is taken from $CDPATH, with a "," prepended to look
1517 in the current directory first.
1518 If the default value taken from $CDPATH is not what you want, include
1519 a modified version of the following command in your vimrc file to
1520 override it: >
1521 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1522< This option cannot be set from a |modeline| or in the |sandbox|, for
1523 security reasons.
1524 (parts of 'cdpath' can be passed to the shell to expand file names).
1525
1526 *'cedit'*
1527'cedit' string (Vi default: "", Vim default: CTRL-F)
1528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529 The key used in Command-line Mode to open the command-line window.
1530 The default is CTRL-F when 'compatible' is off.
1531 Only non-printable keys are allowed.
1532 The key can be specified as a single character, but it is difficult to
1533 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001534 :exe "set cedit=\<C-Y>"
1535 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536< |Nvi| also has this option, but it only uses the first character.
1537 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001538 NOTE: This option is set to the Vim default value when 'compatible'
1539 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540
1541 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1542'charconvert' 'ccv' string (default "")
1543 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001544 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 An expression that is used for character encoding conversion. It is
1546 evaluated when a file that is to be read or has been written has a
1547 different encoding from what is desired.
1548 'charconvert' is not used when the internal iconv() function is
1549 supported and is able to do the conversion. Using iconv() is
1550 preferred, because it is much faster.
1551 'charconvert' is not used when reading stdin |--|, because there is no
1552 file to convert from. You will have to save the text in a file first.
1553 The expression must return zero or an empty string for success,
1554 non-zero for failure.
1555 The possible encoding names encountered are in 'encoding'.
1556 Additionally, names given in 'fileencodings' and 'fileencoding' are
1557 used.
1558 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1559 is done internally by Vim, 'charconvert' is not used for this.
1560 'charconvert' is also used to convert the viminfo file, if the 'c'
1561 flag is present in 'viminfo'. Also used for Unicode conversion.
1562 Example: >
1563 set charconvert=CharConvert()
1564 fun CharConvert()
1565 system("recode "
1566 \ . v:charconvert_from . ".." . v:charconvert_to
1567 \ . " <" . v:fname_in . " >" v:fname_out)
1568 return v:shell_error
1569 endfun
1570< The related Vim variables are:
1571 v:charconvert_from name of the current encoding
1572 v:charconvert_to name of the desired encoding
1573 v:fname_in name of the input file
1574 v:fname_out name of the output file
1575 Note that v:fname_in and v:fname_out will never be the same.
1576 Note that v:charconvert_from and v:charconvert_to may be different
1577 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1578 Encryption is not done by Vim when using 'charconvert'. If you want
1579 to encrypt the file after conversion, 'charconvert' should take care
1580 of this.
1581 This option cannot be set from a |modeline| or in the |sandbox|, for
1582 security reasons.
1583
1584 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1585'cindent' 'cin' boolean (default off)
1586 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 {not available when compiled without the |+cindent|
1588 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001589 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 that trigger reindenting in insert mode and 'cinoptions' to set your
1591 preferred indent style.
1592 If 'indentexpr' is not empty, it overrules 'cindent'.
1593 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1594 the "=" operator indents using this algorithm rather than calling an
1595 external program.
1596 See |C-indenting|.
1597 When you don't like the way 'cindent' works, try the 'smartindent'
1598 option or 'indentexpr'.
1599 This option is not used when 'paste' is set.
1600 NOTE: This option is reset when 'compatible' is set.
1601
1602 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001603'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 {not available when compiled without the |+cindent|
1606 feature}
1607 A list of keys that, when typed in Insert mode, cause reindenting of
1608 the current line. Only used if 'cindent' is on and 'indentexpr' is
1609 empty.
1610 For the format of this option see |cinkeys-format|.
1611 See |C-indenting|.
1612
1613 *'cinoptions'* *'cino'*
1614'cinoptions' 'cino' string (default "")
1615 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 {not available when compiled without the |+cindent|
1617 feature}
1618 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1619 program. See |cinoptions-values| for the values of this option, and
1620 |C-indenting| for info on C indenting in general.
1621
1622
1623 *'cinwords'* *'cinw'*
1624'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1625 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 {not available when compiled without both the
1627 |+cindent| and the |+smartindent| features}
1628 These keywords start an extra indent in the next line when
1629 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1630 an appropriate place (inside {}).
1631 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1632 matter, include the keyword both the uppercase and lowercase:
1633 "if,If,IF".
1634
1635 *'clipboard'* *'cb'*
1636'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1637 for X-windows, "" otherwise)
1638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 {only in GUI versions or when the |+xterm_clipboard|
1640 feature is included}
1641 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001642 Note: if one of the items is "exclude:", then you can't add an item
1643 after that. Therefore do append an item with += but use ^= to
1644 prepend, e.g.: >
1645 set clipboard^=unnamed
1646< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001648 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 unnamed When included, Vim will use the clipboard register '*'
1650 for all yank, delete, change and put operations which
1651 would normally go to the unnamed register. When a
1652 register is explicitly specified, it will always be
1653 used regardless of whether "unnamed" is in 'clipboard'
1654 or not. The clipboard register can always be
1655 explicitly accessed using the "* notation. Also see
1656 |gui-clipboard|.
1657
Bram Moolenaar30b65812012-07-12 22:01:11 +02001658 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001659 unnamedplus A variant of the "unnamed" flag which uses the
1660 clipboard register '+' (|quoteplus|) instead of
1661 register '*' for all yank, delete, change and put
1662 operations which would normally go to the unnamed
1663 register. When "unnamed" is also included to the
1664 option, yank operations (but not delete, change or
1665 put) will additionally copy the text into register
1666 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001667 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001668 Availability can be checked with: >
1669 if has('unnamedplus')
1670<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001671 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 autoselect Works like the 'a' flag in 'guioptions': If present,
1673 then whenever Visual mode is started, or the Visual
1674 area extended, Vim tries to become the owner of the
1675 windowing system's global selection or put the
1676 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001677 register "*. See |'go-a'| and |quotestar| for details.
1678 When the GUI is active, the 'a' flag in 'guioptions'
1679 is used, when the GUI is not active, this "autoselect"
1680 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681 Also applies to the modeless selection.
1682
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001683 *clipboard-autoselectplus*
1684 autoselectplus Like "autoselect" but using the + register instead of
1685 the * register. Compare to the 'P' flag in
1686 'guioptions'.
1687
1688 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 autoselectml Like "autoselect", but for the modeless selection
1690 only. Compare to the 'A' flag in 'guioptions'.
1691
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001692 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001693 html When the clipboard contains HTML, use this when
1694 pasting. When putting text on the clipboard, mark it
1695 as HTML. This works to copy rendered HTML from
1696 Firefox, paste it as raw HTML in Vim, select the HTML
1697 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001698 You probably want to add this only temporarily,
1699 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001700 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001701
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001702 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703 exclude:{pattern}
1704 Defines a pattern that is matched against the name of
1705 the terminal 'term'. If there is a match, no
1706 connection will be made to the X server. This is
1707 useful in this situation:
1708 - Running Vim in a console.
1709 - $DISPLAY is set to start applications on another
1710 display.
1711 - You do not want to connect to the X server in the
1712 console, but do want this in a terminal emulator.
1713 To never connect to the X server use: >
1714 exclude:.*
1715< This has the same effect as using the |-X| argument.
1716 Note that when there is no connection to the X server
1717 the window title won't be restored and the clipboard
1718 cannot be accessed.
1719 The value of 'magic' is ignored, {pattern} is
1720 interpreted as if 'magic' was on.
1721 The rest of the option value will be used for
1722 {pattern}, this must be the last entry.
1723
1724 *'cmdheight'* *'ch'*
1725'cmdheight' 'ch' number (default 1)
1726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 Number of screen lines to use for the command-line. Helps avoiding
1728 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001729 The value of this option is stored with the tab page, so that each tab
1730 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731
1732 *'cmdwinheight'* *'cwh'*
1733'cmdwinheight' 'cwh' number (default 7)
1734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 Number of screen lines to use for the command-line window. |cmdwin|
1736
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001737 *'colorcolumn'* *'cc'*
1738'colorcolumn' 'cc' string (default "")
1739 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001740 {not available when compiled without the |+syntax|
1741 feature}
1742 'colorcolumn' is a comma separated list of screen columns that are
1743 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1744 text. Will make screen redrawing slower.
1745 The screen column can be an absolute number, or a number preceded with
1746 '+' or '-', which is added to or subtracted from 'textwidth'. >
1747
1748 :set cc=+1 " highlight column after 'textwidth'
1749 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1750 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1751<
1752 When 'textwidth' is zero then the items with '-' and '+' are not used.
1753 A maximum of 256 columns are highlighted.
1754
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 *'columns'* *'co'* *E594*
1756'columns' 'co' number (default 80 or terminal width)
1757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001759 initialization and does not have to be set by hand. Also see
1760 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 When Vim is running in the GUI or in a resizable window, setting this
1762 option will cause the window size to be changed. When you only want
1763 to use the size for the GUI, put the command in your |gvimrc| file.
1764 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001765 number of columns of the display, the display may be messed up. For
1766 the GUI it is always possible and Vim limits the number of columns to
1767 what fits on the screen. You can use this command to get the widest
1768 window possible: >
1769 :set columns=9999
1770< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771
1772 *'comments'* *'com'* *E524* *E525*
1773'comments' 'com' string (default
1774 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1775 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 A comma separated list of strings that can start a comment line. See
1777 |format-comments|. See |option-backslash| about using backslashes to
1778 insert a space.
1779
1780 *'commentstring'* *'cms'* *E537*
1781'commentstring' 'cms' string (default "/*%s*/")
1782 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 {not available when compiled without the |+folding|
1784 feature}
1785 A template for a comment. The "%s" in the value is replaced with the
1786 comment text. Currently only used to add markers for folding, see
1787 |fold-marker|.
1788
1789 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001790'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001791 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793 This option has the effect of making Vim either more Vi-compatible, or
1794 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001797 other options are also changed as a side effect.
1798 NOTE: Setting or resetting this option can have a lot of unexpected
1799 effects: Mappings are interpreted in another way, undo behaves
1800 differently, etc. If you set this option in your vimrc file, you
1801 should probably put it at the very start.
1802
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 By default this option is on and the Vi defaults are used for the
1804 options. This default was chosen for those people who want to use Vim
1805 just like Vi, and don't even (want to) know about the 'compatible'
1806 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001807 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001808 this option is switched off, and all options that have not been
1809 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001810 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001811 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001812 happen for the system-wide vimrc or gvimrc file, nor for a file given
1813 with the |-u| argument). Also see |compatible-default| and
1814 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 You can also set this option with the "-C" argument, and reset it with
1816 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001817 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818
Bram Moolenaar214641f2017-03-05 17:04:09 +01001819 When this option is set, numerous other options are set to make Vim as
1820 Vi-compatible as possible. When this option is unset, various options
1821 are set to make Vim more useful. The table below lists all the
1822 options affected.
1823 The {?} column indicates when the options are affected:
1824 + Means that the option is set to the value given in {set value} when
1825 'compatible' is set.
1826 & Means that the option is set to the value given in {set value} when
1827 'compatible' is set AND is set to its Vim default value when
1828 'compatible' is unset.
1829 - Means the option is NOT changed when setting 'compatible' but IS
1830 set to its Vim default when 'compatible' is unset.
1831 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832
Bram Moolenaar036986f2017-03-16 17:41:02 +01001833 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001834
1835 'allowrevins' + off no CTRL-_ command
1836 'antialias' + off don't use antialiased fonts
1837 'arabic' + off reset arabic-related options
1838 'arabicshape' + on correct character shapes
1839 'backspace' + "" normal backspace
1840 'backup' + off no backup file
1841 'backupcopy' & Unix: "yes" backup file is a copy
1842 else: "auto" copy or rename backup file
1843 'balloonexpr' + "" text to show in evaluation balloon
1844 'breakindent' + off don't indent when wrapping lines
1845 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001846 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001847 'cindent' + off no C code indentation
1848 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1849 'copyindent' + off don't copy indent structure
1850 'cpoptions' & (all flags) Vi-compatible flags
1851 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001852 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001853 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001854 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001855 'cscopeverbose' + off see |cscopeverbose|
1856 'delcombine' + off unicode: delete whole char combination
1857 'digraph' + off no digraphs
1858 'esckeys' & off no <Esc>-keys in Insert mode
1859 'expandtab' + off tabs not expanded to spaces
1860 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001861 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001862 'formatexpr' + "" use 'formatprg' for auto-formatting
1863 'formatoptions' & "vt" Vi compatible formatting
1864 'gdefault' + off no default 'g' flag for ":s"
1865 'history' & 0 no commandline history
1866 'hkmap' + off no Hebrew keyboard mapping
1867 'hkmapp' + off no phonetic Hebrew keyboard mapping
1868 'hlsearch' + off no highlighting of search matches
1869 'incsearch' + off no incremental searching
1870 'indentexpr' + "" no indenting by expression
1871 'insertmode' + off do not start in Insert mode
1872 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001874 'joinspaces' + on insert 2 spaces after period
1875 'modeline' & off no modelines
1876 'more' & off no pauses in listings
1877 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1878 'numberwidth' & 8 min number of columns for line number
1879 'preserveindent'+ off don't preserve current indent structure
1880 when changing it
1881 'revins' + off no reverse insert
1882 'ruler' + off no ruler
1883 'scrolljump' + 1 no jump scroll
1884 'scrolloff' + 0 no scroll offset
1885 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1886 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001887 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001888 'showcmd' & off command characters not shown
1889 'showmode' & off current mode not shown
1890 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1891 'smartcase' + off no automatic ignore case switch
1892 'smartindent' + off no smart indentation
1893 'smarttab' + off no smart tab size
1894 'softtabstop' + 0 tabs are always 'tabstop' positions
1895 'startofline' + on goto startofline with some commands
1896 'tagcase' & "followic" 'ignorecase' when searching tags file
1897 'tagrelative' & off tag file names are not relative
1898 'termguicolors' + off don't use highlight-(guifg|guibg)
1899 'textauto' & off no automatic textmode detection
1900 'textwidth' + 0 no automatic line wrap
1901 'tildeop' + off tilde is not an operator
1902 'ttimeout' + off no terminal timeout
1903 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001904 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001905 'virtualedit' + "" cursor can only be placed on characters
1906 'whichwrap' & "" left-right movements don't wrap
1907 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001909 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910
1911 *'complete'* *'cpt'* *E535*
1912'complete' 'cpt' string (default: ".,w,b,u,t,i")
1913 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 This option specifies how keyword completion |ins-completion| works
1915 when CTRL-P or CTRL-N are used. It is also used for whole-line
1916 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1917 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001918 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 w scan buffers from other windows
1920 b scan other loaded buffers that are in the buffer list
1921 u scan the unloaded buffers that are in the buffer list
1922 U scan the buffers that are not in the buffer list
1923 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001924 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 k{dict} scan the file {dict}. Several "k" flags can be given,
1926 patterns are valid too. For example: >
1927 :set cpt=k/usr/dict/*,k~/spanish
1928< s scan the files given with the 'thesaurus' option
1929 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1930 are valid too.
1931 i scan current and included files
1932 d scan current and included files for defined name or macro
1933 |i_CTRL-X_CTRL-D|
1934 ] tag completion
1935 t same as "]"
1936
1937 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1938 not executed, this may lead to unexpected completions from some files
1939 (gzipped files for example). Unloaded buffers are not scanned for
1940 whole-line completion.
1941
1942 The default is ".,w,b,u,t,i", which means to scan:
1943 1. the current buffer
1944 2. buffers in other windows
1945 3. other loaded buffers
1946 4. unloaded buffers
1947 5. tags
1948 6. included files
1949
1950 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001951 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1952 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001954 *'completefunc'* *'cfu'*
1955'completefunc' 'cfu' string (default: empty)
1956 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001957 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001958 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001959 This option specifies a function to be used for Insert mode completion
1960 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001961 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001962 invoked and what it should return. The value can be the name of a
1963 function, a |lambda| or a |Funcref|. See |option-value-function| for
1964 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001965 This option cannot be set from a |modeline| or in the |sandbox|, for
1966 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001967
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001968 *'completeslash'* *'csl'*
1969'completeslash' 'csl' string (default: "")
1970 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001971 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001972 When this option is set it overrules 'shellslash' for completion:
1973 - When this option is set to "slash", a forward slash is used for path
1974 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001975 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001976 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001977 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001978 - When this option is empty, same character is used as for
1979 'shellslash'.
1980 For Insert mode completion the buffer-local value is used. For
1981 command line completion the global value is used.
1982
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001983 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001984'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001985 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001986 A comma separated list of options for Insert mode completion
1987 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001988
1989 menu Use a popup menu to show the possible completions. The
1990 menu is only shown when there is more than one match and
1991 sufficient colors are available. |ins-completion-menu|
1992
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001993 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001994 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001995 match, e.g., what file it comes from.
1996
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001997 longest Only insert the longest common text of the matches. If
1998 the menu is displayed you can use CTRL-L to add more
1999 characters. Whether case is ignored depends on the kind
2000 of completion. For buffer text the 'ignorecase' option is
2001 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002002
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002003 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002004 completion in the preview window. Only works in
2005 combination with "menu" or "menuone".
2006
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002007 popup Show extra information about the currently selected
2008 completion in a popup window. Only works in combination
2009 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002010 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002011 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002012
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002013 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002014 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002015 |CompleteChanged| autocommand to fetch the info and call
2016 |popup_show()| once the popup has been filled.
2017 See the example at |complete-popuphidden|.
2018 {only works when compiled with the |+textprop| feature}
2019
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002020 noinsert Do not insert any text for a match until the user selects
2021 a match from the menu. Only works in combination with
2022 "menu" or "menuone". No effect if "longest" is present.
2023
2024 noselect Do not select a match in the menu, force the user to
2025 select one from the menu. Only works in combination with
2026 "menu" or "menuone".
2027
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002028
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002029 *'completepopup'* *'cpp'*
2030'completepopup' 'cpp' string (default empty)
2031 global
2032 {not available when compiled without the |+textprop|
2033 or |+quickfix| feature}
2034 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002035 properties of the info popup when it is created. If an info popup
2036 window already exists it is closed, so that the option value is
2037 applied when it is created again.
2038 You can also use |popup_findinfo()| and then set properties for an
2039 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002040
2041
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002042 *'concealcursor'* *'cocu'*
2043'concealcursor' 'cocu' string (default: "")
2044 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002045 {not available when compiled without the |+conceal|
2046 feature}
2047 Sets the modes in which text in the cursor line can also be concealed.
2048 When the current mode is listed then concealing happens just like in
2049 other lines.
2050 n Normal mode
2051 v Visual mode
2052 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002053 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002054
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002055 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002056 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002057 are moving around text is concealed, but when starting to insert text
2058 or selecting a Visual area the concealed text is displayed, so that
2059 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002060 Keep in mind that the cursor position is not always where it's
2061 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002062
2063
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002064 *'conceallevel'* *'cole'*
2065'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002066 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002067 {not available when compiled without the |+conceal|
2068 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002069 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2070 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002071
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002072 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002073 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002074 1 Each block of concealed text is replaced with one
2075 character. If the syntax item does not have a custom
2076 replacement character defined (see |:syn-cchar|) the
2077 character defined in 'listchars' is used (default is a
2078 space).
2079 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002080 2 Concealed text is completely hidden unless it has a
2081 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002082 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002083 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002084
Bram Moolenaara7781e02010-07-19 20:13:22 +02002085 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002086 edit and copy the text. This can be changed with the 'concealcursor'
2087 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002088
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2090'confirm' 'cf' boolean (default off)
2091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 When 'confirm' is on, certain operations that would normally
2093 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2094 instead raise a |dialog| asking if you wish to save the current
2095 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2096 If 'confirm' is off you can still activate confirmation for one
2097 command only (this is most useful in mappings) with the |:confirm|
2098 command.
2099 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2100
2101 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2102'conskey' 'consk' boolean (default off)
2103 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002104 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105
2106 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2107'copyindent' 'ci' boolean (default off)
2108 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 Copy the structure of the existing lines indent when autoindenting a
2110 new line. Normally the new indent is reconstructed by a series of
2111 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2112 in which case only spaces are used). Enabling this option makes the
2113 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002114 existing line. 'expandtab' has no effect on these characters, a Tab
2115 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002117 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118 Also see 'preserveindent'.
2119
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002120 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121'cpoptions' 'cpo' string (Vim default: "aABceFs",
2122 Vi default: all flags)
2123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002125 this indicates Vi-compatible behavior. This is used for things where
2126 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 'cpoptions' stands for "compatible-options".
2128 Commas can be added for readability.
2129 To avoid problems with flags that are added in the future, use the
2130 "+=" and "-=" feature of ":set" |add-option-flags|.
2131 NOTE: This option is set to the Vi default value when 'compatible' is
2132 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002133 NOTE: This option is set to the POSIX default value at startup when
2134 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002135 variable exists |posix|. This means Vim tries to behave like the
2136 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137
2138 contains behavior ~
2139 *cpo-a*
2140 a When included, a ":read" command with a file name
2141 argument will set the alternate file name for the
2142 current window.
2143 *cpo-A*
2144 A When included, a ":write" command with a file name
2145 argument will set the alternate file name for the
2146 current window.
2147 *cpo-b*
2148 b "\|" in a ":map" command is recognized as the end of
2149 the map command. The '\' is included in the mapping,
2150 the text after the '|' is interpreted as the next
2151 command. Use a CTRL-V instead of a backslash to
2152 include the '|' in the mapping. Applies to all
2153 mapping, abbreviation, menu and autocmd commands.
2154 See also |map_bar|.
2155 *cpo-B*
2156 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002157 abbreviations, user commands and the "to" part of the
2158 menu commands. Remove this flag to be able to use a
2159 backslash like a CTRL-V. For example, the command
2160 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 'B' included: "\^[" (^[ is a real <Esc>)
2162 'B' excluded: "<Esc>" (5 characters)
2163 ('<' excluded in both cases)
2164 *cpo-c*
2165 c Searching continues at the end of any match at the
2166 cursor position, but not further than the start of the
2167 next line. When not present searching continues
2168 one character from the cursor position. With 'c'
2169 "abababababab" only gets three matches when repeating
2170 "/abab", without 'c' there are five matches.
2171 *cpo-C*
2172 C Do not concatenate sourced lines that start with a
2173 backslash. See |line-continuation|.
2174 *cpo-d*
2175 d Using "./" in the 'tags' option doesn't mean to use
2176 the tags file relative to the current file, but the
2177 tags file in the current directory.
2178 *cpo-D*
2179 D Can't use CTRL-K to enter a digraph after Normal mode
2180 commands with a character argument, like |r|, |f| and
2181 |t|.
2182 *cpo-e*
2183 e When executing a register with ":@r", always add a
2184 <CR> to the last line, also when the register is not
2185 linewise. If this flag is not present, the register
2186 is not linewise and the last line does not end in a
2187 <CR>, then the last line is put on the command-line
2188 and can be edited before hitting <CR>.
2189 *cpo-E*
2190 E It is an error when using "y", "d", "c", "g~", "gu" or
2191 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002192 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 This makes "y0" fail in the first column.
2194 *cpo-f*
2195 f When included, a ":read" command with a file name
2196 argument will set the file name for the current buffer,
2197 if the current buffer doesn't have a file name yet.
2198 *cpo-F*
2199 F When included, a ":write" command with a file name
2200 argument will set the file name for the current
2201 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002202 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 *cpo-g*
2204 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002205 *cpo-H*
2206 H When using "I" on a line with only blanks, insert
2207 before the last blank. Without this flag insert after
2208 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 *cpo-i*
2210 i When included, interrupting the reading of a file will
2211 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002212 *cpo-I*
2213 I When moving the cursor up or down just after inserting
2214 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 *cpo-j*
2216 j When joining lines, only add two spaces after a '.',
2217 not after '!' or '?'. Also see 'joinspaces'.
2218 *cpo-J*
2219 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002220 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 white space.
2222 *cpo-k*
2223 k Disable the recognition of raw key codes in
2224 mappings, abbreviations, and the "to" part of menu
2225 commands. For example, if <Key> sends ^[OA (where ^[
2226 is <Esc>), the command ":map X ^[OA" results in X
2227 being mapped to:
2228 'k' included: "^[OA" (3 characters)
2229 'k' excluded: "<Key>" (one key code)
2230 Also see the '<' flag below.
2231 *cpo-K*
2232 K Don't wait for a key code to complete when it is
2233 halfway a mapping. This breaks mapping <F1><F1> when
2234 only part of the second <F1> has been read. It
2235 enables cancelling the mapping by typing <F1><Esc>.
2236 *cpo-l*
2237 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002238 literally, only "\]", "\^", "\-" and "\\" are special.
2239 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2241 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002242 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 *cpo-L*
2244 L When the 'list' option is set, 'wrapmargin',
2245 'textwidth', 'softtabstop' and Virtual Replace mode
2246 (see |gR|) count a <Tab> as two characters, instead of
2247 the normal behavior of a <Tab>.
2248 *cpo-m*
2249 m When included, a showmatch will always wait half a
2250 second. When not included, a showmatch will wait half
2251 a second or until a character is typed. |'showmatch'|
2252 *cpo-M*
2253 M When excluded, "%" matching will take backslashes into
2254 account. Thus in "( \( )" and "\( ( \)" the outer
2255 parenthesis match. When included "%" ignores
2256 backslashes, which is Vi compatible.
2257 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002258 n When included, the column used for 'number' and
2259 'relativenumber' will also be used for text of wrapped
2260 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 *cpo-o*
2262 o Line offset to search command is not remembered for
2263 next search.
2264 *cpo-O*
2265 O Don't complain if a file is being overwritten, even
2266 when it didn't exist when editing it. This is a
2267 protection against a file unexpectedly created by
2268 someone else. Vi didn't complain about this.
2269 *cpo-p*
2270 p Vi compatible Lisp indenting. When not present, a
2271 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002272 *cpo-P*
2273 P When included, a ":write" command that appends to a
2274 file will set the file name for the current buffer, if
2275 the current buffer doesn't have a file name yet and
2276 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002277 *cpo-q*
2278 q When joining multiple lines leave the cursor at the
2279 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 *cpo-r*
2281 r Redo ("." command) uses "/" to repeat a search
2282 command, instead of the actually used search string.
2283 *cpo-R*
2284 R Remove marks from filtered lines. Without this flag
2285 marks are kept like |:keepmarks| was used.
2286 *cpo-s*
2287 s Set buffer options when entering the buffer for the
2288 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002289 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 set when the buffer is created.
2291 *cpo-S*
2292 S Set buffer options always when entering a buffer
2293 (except 'readonly', 'fileformat', 'filetype' and
2294 'syntax'). This is the (most) Vi compatible setting.
2295 The options are set to the values in the current
2296 buffer. When you change an option and go to another
2297 buffer, the value is copied. Effectively makes the
2298 buffer options global to all buffers.
2299
2300 's' 'S' copy buffer options
2301 no no when buffer created
2302 yes no when buffer first entered (default)
2303 X yes each time when buffer entered (vi comp.)
2304 *cpo-t*
2305 t Search pattern for the tag command is remembered for
2306 "n" command. Otherwise Vim only puts the pattern in
2307 the history for search pattern, but doesn't change the
2308 last used search pattern.
2309 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002310 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 *cpo-v*
2312 v Backspaced characters remain visible on the screen in
2313 Insert mode. Without this flag the characters are
2314 erased from the screen right away. With this flag the
2315 screen newly typed text overwrites backspaced
2316 characters.
2317 *cpo-w*
2318 w When using "cw" on a blank character, only change one
2319 character and not all blanks until the start of the
2320 next word.
2321 *cpo-W*
2322 W Don't overwrite a readonly file. When omitted, ":w!"
2323 overwrites a readonly file, if possible.
2324 *cpo-x*
2325 x <Esc> on the command-line executes the command-line.
2326 The default in Vim is to abandon the command-line,
2327 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002328 *cpo-X*
2329 X When using a count with "R" the replaced text is
2330 deleted only once. Also when repeating "R" with "."
2331 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002333 y A yank command can be redone with ".". Think twice if
2334 you really want to use this, it may break some
2335 plugins, since most people expect "." to only repeat a
2336 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002337 *cpo-Z*
2338 Z When using "w!" while the 'readonly' option is set,
2339 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 *cpo-!*
2341 ! When redoing a filter command, use the last used
2342 external command, whatever it was. Otherwise the last
2343 used -filter- command is used.
2344 *cpo-$*
2345 $ When making a change to one line, don't redisplay the
2346 line, but put a '$' at the end of the changed text.
2347 The changed text will be overwritten when you type the
2348 new text. The line is redisplayed if you type any
2349 command that moves the cursor from the insertion
2350 point.
2351 *cpo-%*
2352 % Vi-compatible matching is done for the "%" command.
2353 Does not recognize "#if", "#endif", etc.
2354 Does not recognize "/*" and "*/".
2355 Parens inside single and double quotes are also
2356 counted, causing a string that contains a paren to
2357 disturb the matching. For example, in a line like
2358 "if (strcmp("foo(", s))" the first paren does not
2359 match the last one. When this flag is not included,
2360 parens inside single and double quotes are treated
2361 specially. When matching a paren outside of quotes,
2362 everything inside quotes is ignored. When matching a
2363 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002364 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002365 This flag is also used for other features, such as
2366 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002367 *cpo--*
2368 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002369 it would go above the first line or below the last
2370 line. Without it the cursor moves to the first or
2371 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002372 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002373 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002374 *cpo-+*
2375 + When included, a ":write file" command will reset the
2376 'modified' flag of the buffer, even though the buffer
2377 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002378 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 * Use ":*" in the same way as ":@". When not included,
2380 ":*" is an alias for ":'<,'>", select the Visual area.
2381 *cpo-<*
2382 < Disable the recognition of special key codes in |<>|
2383 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002384 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 ":map X <Tab>" results in X being mapped to:
2386 '<' included: "<Tab>" (5 characters)
2387 '<' excluded: "^I" (^I is a real <Tab>)
2388 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002389 *cpo->*
2390 > When appending to a register, put a line break before
2391 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002392 *cpo-;*
2393 ; When using |,| or |;| to repeat the last |t| search
2394 and the cursor is right in front of the searched
2395 character, the cursor won't move. When not included,
2396 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002397 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002398
2399 POSIX flags. These are not included in the Vi default value, except
2400 when $VIM_POSIX was set on startup. |posix|
2401
2402 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002403 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002404 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002405 *cpo-&*
2406 & When ":preserve" was used keep the swap file when
2407 exiting normally while this buffer is still loaded.
2408 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002409 *cpo-\*
2410 \ Backslash in a [] range in a search pattern is taken
2411 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002412 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2413 '\' excluded: "/[ \-]" finds <Space> and '-'
2414 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002415 *cpo-/*
2416 / When "%" is used as the replacement string in a |:s|
2417 command, use the previous replacement string. |:s%|
2418 *cpo-{*
2419 { The |{| and |}| commands also stop at a "{" character
2420 at the start of a line.
2421 *cpo-.*
2422 . The ":chdir" and ":cd" commands fail if the current
2423 buffer is modified, unless ! is used. Vim doesn't
2424 need this, since it remembers the full path of an
2425 opened file.
2426 *cpo-bar*
2427 | The value of the $LINES and $COLUMNS environment
2428 variables overrule the terminal size values obtained
2429 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002430
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002432 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002433'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002434 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002435 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002436 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002437 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002438 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002439 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002440 blowfish Blowfish method. Medium strong encryption but it has
2441 an implementation flaw. Requires Vim 7.3 or later,
2442 files can NOT be read by Vim 7.2 and older. This adds
2443 a "seed" to the file, every time you write the file
2444 the encrypted bytes will be different.
2445 *blowfish2*
2446 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002447 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002448 and older. This adds a "seed" to the file, every time
2449 you write the file the encrypted bytes will be
2450 different. The whole undo file is encrypted, not just
2451 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002452 *E1193* *E1194* *E1195* *E1196*
2453 *E1197* *E1198* *E1199* *E1200* *E1201*
2454 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2455 Code. Medium strong till strong encryption.
2456 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002457 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002458 It adds a seed and a message authentication code (MAC)
2459 to the file. This needs at least a Vim 8.2.3022 to
2460 read the encrypted file.
2461 Encryption of swap files is not supported, therefore
2462 no swap file will be used when xchacha20 encryption is
2463 enabled.
2464 Encryption of undo files is not yet supported,
2465 therefore no undo file will currently be written.
2466 CURRENTLY EXPERIMENTAL: Files written with this method
2467 might have to be read back with the same version of
2468 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002469
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002470 You should use "blowfish2", also to re-encrypt older files.
2471
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002472 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002473 to the detected method of the file being read. Thus if you write it
2474 without changing 'cryptmethod' the same method will be used.
2475 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002476 explicitly write it, you don't get a warning unless there are other
2477 modifications. Also see |:X|.
2478
2479 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002480 the value "blowfish2". When setting the local value to an empty
2481 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002482
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002483 When a new encryption method is added in a later version of Vim, and
2484 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002485 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002486
2487
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 *'cscopepathcomp'* *'cspc'*
2489'cscopepathcomp' 'cspc' number (default 0)
2490 global
2491 {not available when compiled without the |+cscope|
2492 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 Determines how many components of the path to show in a list of tags.
2494 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002495 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496
2497 *'cscopeprg'* *'csprg'*
2498'cscopeprg' 'csprg' string (default "cscope")
2499 global
2500 {not available when compiled without the |+cscope|
2501 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 Specifies the command to execute cscope. See |cscopeprg|.
2503 This option cannot be set from a |modeline| or in the |sandbox|, for
2504 security reasons.
2505
2506 *'cscopequickfix'* *'csqf'*
2507'cscopequickfix' 'csqf' string (default "")
2508 global
2509 {not available when compiled without the |+cscope|
2510 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 Specifies whether to use quickfix window to show cscope results.
2512 See |cscopequickfix|.
2513
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002514 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002515'cscoperelative' 'csre' boolean (default off)
2516 global
2517 {not available when compiled without the |+cscope|
2518 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002519 In the absence of a prefix (-P) for cscope. setting this option enables
2520 to use the basename of cscope.out path as the prefix.
2521 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002522 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002523
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2525'cscopetag' 'cst' boolean (default off)
2526 global
2527 {not available when compiled without the |+cscope|
2528 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 Use cscope for tag commands. See |cscope-options|.
2530 NOTE: This option is reset when 'compatible' is set.
2531
2532 *'cscopetagorder'* *'csto'*
2533'cscopetagorder' 'csto' number (default 0)
2534 global
2535 {not available when compiled without the |+cscope|
2536 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 Determines the order in which ":cstag" performs a search. See
2538 |cscopetagorder|.
2539 NOTE: This option is set to 0 when 'compatible' is set.
2540
2541 *'cscopeverbose'* *'csverb'*
2542 *'nocscopeverbose'* *'nocsverb'*
2543'cscopeverbose' 'csverb' boolean (default off)
2544 global
2545 {not available when compiled without the |+cscope|
2546 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 Give messages when adding a cscope database. See |cscopeverbose|.
2548 NOTE: This option is reset when 'compatible' is set.
2549
Bram Moolenaar860cae12010-06-05 23:22:07 +02002550 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2551'cursorbind' 'crb' boolean (default off)
2552 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002553 When this option is set, as the cursor in the current
2554 window moves other cursorbound windows (windows that also have
2555 this option set) move their cursors to the corresponding line and
2556 column. This option is useful for viewing the
2557 differences between two versions of a file (see 'diff'); in diff mode,
2558 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002559 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002560
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002561
2562 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2563'cursorcolumn' 'cuc' boolean (default off)
2564 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002565 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002566 feature}
2567 Highlight the screen column of the cursor with CursorColumn
2568 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2569 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002570 If you only want the highlighting in the current window you can use
2571 these autocommands: >
2572 au WinLeave * set nocursorline nocursorcolumn
2573 au WinEnter * set cursorline cursorcolumn
2574<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002575
2576 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2577'cursorline' 'cul' boolean (default off)
2578 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002579 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002580 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002581 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2582 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002583 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002584 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002585
2586
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002587 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002588'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002589 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002590 {not available when compiled without the |+syntax|
2591 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002592 Comma separated list of settings for how 'cursorline' is displayed.
2593 Valid values:
2594 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002595 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002596 "screenline" Highlight only the screen line of the cursor with
2597 CursorLine |hl-CursorLine|.
2598 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002599 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002600
2601 Special value:
2602 "both" Alias for the values "line,number".
2603
2604 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002605
2606
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 *'debug'*
2608'debug' string (default "")
2609 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002610 These values can be used:
2611 msg Error messages that would otherwise be omitted will be given
2612 anyway.
2613 throw Error messages that would otherwise be omitted will be given
2614 anyway and also throw an exception and set |v:errmsg|.
2615 beep A message will be given when otherwise only a beep would be
2616 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002617 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002618 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2619 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620
2621 *'define'* *'def'*
2622'define' 'def' string (default "^\s*#\s*define")
2623 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002624 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 pattern, just like for the "/" command. This option is used for the
2626 commands like "[i" and "[d" |include-search|. The 'isident' option is
2627 used to recognize the defined name after the match:
2628 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2629 See |option-backslash| about inserting backslashes to include a space
2630 or backslash.
2631 The default value is for C programs. For C++ this value would be
2632 useful, to include const type declarations: >
2633 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002634< You can also use "\ze" just before the name and continue the pattern
2635 to check what is following. E.g. for Javascript, if a function is
2636 defined with "func_name = function(args)": >
2637 ^\s*\ze\i\+\s*=\s*function(
2638< If the function is defined with "func_name : function() {...": >
2639 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002641 To avoid that use `:let` with a single quote string: >
2642 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002643<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644
2645 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2646'delcombine' 'deco' boolean (default off)
2647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 If editing Unicode and this option is set, backspace and Normal mode
2649 "x" delete each combining character on its own. When it is off (the
2650 default) the character along with its combining characters are
2651 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002652 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653
2654 This is useful for Arabic, Hebrew and many other languages where one
2655 may have combining characters overtop of base characters, and want
2656 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002657 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658
2659 *'dictionary'* *'dict'*
2660'dictionary' 'dict' string (default "")
2661 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 List of file names, separated by commas, that are used to lookup words
2663 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2664 contain a list of words. This can be one word per line, or several
2665 words per line, separated by non-keyword characters (white space is
2666 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002667
2668 When this option is empty or an entry "spell" is present, and spell
2669 checking is enabled, words in the word lists for the currently active
2670 'spelllang' are used. See |spell|.
2671
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002672 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 after a comma are ignored, otherwise spaces are included in the file
2674 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002675 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 Where to find a list of words?
2677 - On FreeBSD, there is the file "/usr/share/dict/words".
2678 - In the Simtel archive, look in the "msdos/linguist" directory.
2679 - In "miscfiles" of the GNU collection.
2680 The use of |:set+=| and |:set-=| is preferred when adding or removing
2681 directories from the list. This avoids problems when a future version
2682 uses another default.
2683 Backticks cannot be used in this option for security reasons.
2684
2685 *'diff'* *'nodiff'*
2686'diff' boolean (default off)
2687 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 {not available when compiled without the |+diff|
2689 feature}
2690 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002691 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692
2693 *'dex'* *'diffexpr'*
2694'diffexpr' 'dex' string (default "")
2695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 {not available when compiled without the |+diff|
2697 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002698 Expression which is evaluated to obtain a diff file (either ed-style
2699 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 This option cannot be set from a |modeline| or in the |sandbox|, for
2701 security reasons.
2702
2703 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002704'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 {not available when compiled without the |+diff|
2707 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002708 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 All are optional. Items must be separated by a comma.
2710
2711 filler Show filler lines, to keep the text
2712 synchronized with a window that has inserted
2713 lines at the same position. Mostly useful
2714 when windows are side-by-side and 'scrollbind'
2715 is set.
2716
2717 context:{n} Use a context of {n} lines between a change
2718 and a fold that contains unchanged lines.
2719 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002720 When using zero the context is actually one,
2721 since folds require a line in between, also
2722 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 See |fold-diff|.
2724
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002725 iblank Ignore changes where lines are all blank. Adds
2726 the "-B" flag to the "diff" command if
2727 'diffexpr' is empty. Check the documentation
2728 of the "diff" command for what this does
2729 exactly.
2730 NOTE: the diff windows will get out of sync,
2731 because no differences between blank lines are
2732 taken into account.
2733
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 icase Ignore changes in case of text. "a" and "A"
2735 are considered the same. Adds the "-i" flag
2736 to the "diff" command if 'diffexpr' is empty.
2737
2738 iwhite Ignore changes in amount of white space. Adds
2739 the "-b" flag to the "diff" command if
2740 'diffexpr' is empty. Check the documentation
2741 of the "diff" command for what this does
2742 exactly. It should ignore adding trailing
2743 white space, but not leading white space.
2744
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002745 iwhiteall Ignore all white space changes. Adds
2746 the "-w" flag to the "diff" command if
2747 'diffexpr' is empty. Check the documentation
2748 of the "diff" command for what this does
2749 exactly.
2750
2751 iwhiteeol Ignore white space changes at end of line.
2752 Adds the "-Z" flag to the "diff" command if
2753 'diffexpr' is empty. Check the documentation
2754 of the "diff" command for what this does
2755 exactly.
2756
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002757 horizontal Start diff mode with horizontal splits (unless
2758 explicitly specified otherwise).
2759
2760 vertical Start diff mode with vertical splits (unless
2761 explicitly specified otherwise).
2762
Bram Moolenaarc8234772019-11-10 21:00:27 +01002763 closeoff When a window is closed where 'diff' is set
2764 and there is only one window remaining in the
2765 same tab page with 'diff' set, execute
2766 `:diffoff` in that window. This undoes a
2767 `:diffsplit` command.
2768
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002769 hiddenoff Do not use diff mode for a buffer when it
2770 becomes hidden.
2771
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002772 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2773 starting diff mode. Without this 2 is used.
2774
Bram Moolenaar4223d432021-02-10 13:18:17 +01002775 followwrap Follow the 'wrap' option and leave as it is.
2776
Bram Moolenaare828b762018-09-10 17:51:58 +02002777 internal Use the internal diff library. This is
2778 ignored when 'diffexpr' is set. *E960*
2779 When running out of memory when writing a
2780 buffer this item will be ignored for diffs
2781 involving that buffer. Set the 'verbose'
2782 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783
Bram Moolenaare828b762018-09-10 17:51:58 +02002784 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002785 Use the indent heuristic for the internal
2786 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002787
2788 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002789 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002790 algorithms are:
2791 myers the default algorithm
2792 minimal spend extra time to generate the
2793 smallest possible diff
2794 patience patience diff algorithm
2795 histogram histogram diff algorithm
2796
2797 Examples: >
2798 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002800 :set diffopt=internal,filler,foldcolumn:3
2801 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802<
2803 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2804'digraph' 'dg' boolean (default off)
2805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 {not available when compiled without the |+digraphs|
2807 feature}
2808 Enable the entering of digraphs in Insert mode with {char1} <BS>
2809 {char2}. See |digraphs|.
2810 NOTE: This option is reset when 'compatible' is set.
2811
2812 *'directory'* *'dir'*
2813'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002814 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 for Unix: ".,~/tmp,/var/tmp,/tmp")
2816 global
2817 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002818 Recommended value: ".,~/vimswap//" - this will put the swap file next
2819 to the edited file if possible, and in your personal swap directory
2820 otherwise. Make sure "~/vimswap//" is only readable for you.
2821
2822 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 - The swap file will be created in the first directory where this is
2824 possible.
2825 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002826 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 - A directory "." means to put the swap file in the same directory as
2828 the edited file. On Unix, a dot is prepended to the file name, so
2829 it doesn't show in a directory listing. On MS-Windows the "hidden"
2830 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002831 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2832 the swap file relative to where the edited file is. The leading "."
2833 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002834 - For Unix and Win32, if a directory ends in two path separators "//",
2835 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002836 with all path separators replaced by percent '%' signs (including
2837 the colon following the drive letter on Win32). This will ensure
2838 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002839 On Win32, it is also possible to end with "\\". However, When a
2840 separating comma is following, you must use "//", since "\\" will
2841 include the comma in the file name. Therefore it is recommended to
2842 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 - Spaces after the comma are ignored, other spaces are considered part
2844 of the directory name. To have a space at the start of a directory
2845 name, precede it with a backslash.
2846 - To include a comma in a directory name precede it with a backslash.
2847 - A directory name may end in an ':' or '/'.
2848 - Environment variables are expanded |:set_env|.
2849 - Careful with '\' characters, type one before a space, type two to
2850 get one in the option (see |option-backslash|), for example: >
2851 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2852< - For backwards compatibility with Vim version 3.0 a '>' at the start
2853 of the option is removed.
2854 Using "." first in the list is recommended. This means that editing
2855 the same file twice will result in a warning. Using "/tmp" on Unix is
2856 discouraged: When the system crashes you lose the swap file.
2857 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002858 choice than "/tmp". But others on the computer may be able to see the
2859 files, and it can contain a lot of files, your swap files get lost in
2860 the crowd. That is why a "tmp" directory in your home directory is
2861 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 The use of |:set+=| and |:set-=| is preferred when adding or removing
2863 directories from the list. This avoids problems when a future version
2864 uses another default.
2865 This option cannot be set from a |modeline| or in the |sandbox|, for
2866 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867
2868 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002869'display' 'dy' string (default "", set to "truncate" in
2870 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 Change the way text is displayed. This is comma separated list of
2873 flags:
2874 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002875 in a window will be displayed. "@@@" is put in the
2876 last columns of the last screen line to indicate the
2877 rest of the line is not displayed.
2878 truncate Like "lastline", but "@@@" is displayed in the first
2879 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 uhex Show unprintable characters hexadecimal as <xx>
2881 instead of using ^C and ~C.
2882
Bram Moolenaard0796902016-09-16 20:02:31 +02002883 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002884 doesn't fit is replaced with "@" lines.
2885
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 *'eadirection'* *'ead'*
2887'eadirection' 'ead' string (default "both")
2888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 Tells when the 'equalalways' option applies:
2890 ver vertically, width of windows is not affected
2891 hor horizontally, height of windows is not affected
2892 both width and height of windows is affected
2893
2894 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2895'edcompatible' 'ed' boolean (default off)
2896 global
2897 Makes the 'g' and 'c' flags of the ":substitute" command to be
2898 toggled each time the flag is given. See |complex-change|. See
2899 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002900 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002901 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902
Bram Moolenaar03413f42016-04-12 21:07:15 +02002903 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002904'emoji' 'emo' boolean (default: on)
2905 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002906 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002907 This excludes "text emoji" characters, which are normally displayed as
2908 single width. Unfortunately there is no good specification for this
2909 and it has been determined on trial-and-error basis. Use the
2910 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002911
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002913'encoding' 'enc' string (default for MS-Windows: "utf-8",
2914 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 Sets the character encoding used inside Vim. It applies to text in
2917 the buffers, registers, Strings in expressions, text stored in the
2918 viminfo file, etc. It sets the kind of characters which Vim can work
2919 with. See |encoding-names| for the possible values.
2920
2921 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002922 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002924 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925
Bram Moolenaar865242e2010-07-14 21:12:05 +02002926 This option cannot be set from a |modeline|. It would most likely
2927 corrupt the text.
2928
Bram Moolenaar3df01732017-02-17 22:47:16 +01002929 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2930 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 'encoding', "utf-8" is the natural choice for the environment and
2932 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002933 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 versions, and to avoid changing the encoding of newly created files
2935 without your knowledge (in case 'fileencodings' is empty).
2936
2937 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002938 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 iconv() or as specified with 'charconvert'.
2940
Bram Moolenaar207f0092020-08-30 17:20:20 +02002941 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002942 can use: >
2943 if has("multi_byte_encoding")
2944<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 Normally 'encoding' will be equal to your current locale. This will
2946 be the default if Vim recognizes your environment settings. If
2947 'encoding' is not set to the current locale, 'termencoding' must be
2948 set to convert typed and displayed text. See |encoding-table|.
2949
2950 When you set this option, it fires the |EncodingChanged| autocommand
2951 event so that you can set up fonts if necessary.
2952
2953 When the option is set, the value is converted to lowercase. Thus
2954 you can set it with uppercase values too. Underscores are translated
2955 to '-' signs.
2956 When the encoding is recognized, it is changed to the standard name.
2957 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2958 "iso-8859-2" and "utf8" becomes "utf-8".
2959
2960 Note: "latin1" is also used when the encoding could not be detected.
2961 This only works when editing files in the same encoding! When the
2962 actual character set is not latin1, make sure 'fileencoding' and
2963 'fileencodings' are empty. When conversion is needed, switch to using
2964 utf-8.
2965
2966 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2967 You don't notice this while editing, but it does matter for the
2968 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2969 setting 'encoding' to one of these values instead of utf-8 only has
2970 effect for encoding used for files when 'fileencoding' is empty.
2971
Bram Moolenaar661b1822005-07-28 22:36:45 +00002972 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2973 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974
2975 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2976'endofline' 'eol' boolean (default on)
2977 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002979 is on, or 'fixeol' option is off, no <EOL> will be written for the
2980 last line in the file. This option is automatically set or reset when
2981 starting to edit a new file, depending on whether file has an <EOL>
2982 for the last line in the file. Normally you don't have to set or
2983 reset this option.
2984 When 'binary' is off and 'fixeol' is on the value is not used when
2985 writing the file. When 'binary' is on or 'fixeol' is off it is used
2986 to remember the presence of a <EOL> for the last line in the file, so
2987 that when you write the file the situation from the original file can
2988 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989
2990 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2991'equalalways' 'ea' boolean (default on)
2992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002994 splitting or closing a window. This also happens the moment the
2995 option is switched on. When off, splitting a window will reduce the
2996 size of the current window and leave the other windows the same. When
2997 closing a window the extra lines are given to the window next to it
2998 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 When mixing vertically and horizontally split windows, a minimal size
3000 is computed and some windows may be larger if there is room. The
3001 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003002 Changing the height and width of a window can be avoided by setting
3003 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003004 If a window size is specified when creating a new window sizes are
3005 currently not equalized (it's complicated, but may be implemented in
3006 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007
3008 *'equalprg'* *'ep'*
3009'equalprg' 'ep' string (default "")
3010 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003012 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003013 or 'indentexpr'. When Vim was compiled without internal formatting,
3014 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003015 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 about including spaces and backslashes.
3017 This option cannot be set from a |modeline| or in the |sandbox|, for
3018 security reasons.
3019
3020 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3021'errorbells' 'eb' boolean (default off)
3022 global
3023 Ring the bell (beep or screen flash) for error messages. This only
3024 makes a difference for error messages, the bell will be used always
3025 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003026 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003027 screen flash or do nothing. See 'belloff' to finetune when to ring the
3028 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029
3030 *'errorfile'* *'ef'*
3031'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3032 others: "errors.err")
3033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 {not available when compiled without the |+quickfix|
3035 feature}
3036 Name of the errorfile for the QuickFix mode (see |:cf|).
3037 When the "-q" command-line argument is used, 'errorfile' is set to the
3038 following argument. See |-q|.
3039 NOT used for the ":make" command. See 'makeef' for that.
3040 Environment variables are expanded |:set_env|.
3041 See |option-backslash| about including spaces and backslashes.
3042 This option cannot be set from a |modeline| or in the |sandbox|, for
3043 security reasons.
3044
3045 *'errorformat'* *'efm'*
3046'errorformat' 'efm' string (default is very long)
3047 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 {not available when compiled without the |+quickfix|
3049 feature}
3050 Scanf-like description of the format for the lines in the error file
3051 (see |errorformat|).
3052
3053 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3054'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 Function keys that start with an <Esc> are recognized in Insert
3057 mode. When this option is off, the cursor and function keys cannot be
3058 used in Insert mode if they start with an <Esc>. The advantage of
3059 this is that the single <Esc> is recognized immediately, instead of
3060 after one second. Instead of resetting this option, you might want to
3061 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3062 when 'esckeys' is off, you can still map anything, but the cursor keys
3063 won't work by default.
3064 NOTE: This option is set to the Vi default value when 'compatible' is
3065 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003066 NOTE: when this option is off then the |modifyOtherKeys| functionality
3067 is disabled while in Insert mode to avoid ending Insert mode with any
3068 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069
3070 *'eventignore'* *'ei'*
3071'eventignore' 'ei' string (default "")
3072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003074 When set to "all" or when "all" is one of the items, all autocommand
3075 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 Otherwise this is a comma separated list of event names. Example: >
3077 :set ei=WinEnter,WinLeave
3078<
3079 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3080'expandtab' 'et' boolean (default off)
3081 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003083 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3085 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003086 This option is reset when the 'paste' option is set and restored when
3087 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 NOTE: This option is reset when 'compatible' is set.
3089
3090 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3091'exrc' 'ex' boolean (default off)
3092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003094 directory.
3095
3096 Setting this option is a potential security leak. E.g., consider
3097 unpacking a package or fetching files from github, a .vimrc in there
3098 might be a trojan horse. BETTER NOT SET THIS OPTION!
3099 Instead, define an autocommand in your .vimrc to set options for a
3100 matching directory.
3101
3102 If you do switch this option on you should also consider setting the
3103 'secure' option (see |initialization|).
3104 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 This option cannot be set from a |modeline| or in the |sandbox|, for
3106 security reasons.
3107
3108 *'fileencoding'* *'fenc'* *E213*
3109'fileencoding' 'fenc' string (default: "")
3110 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003112
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003114 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 When 'fileencoding' is empty, the same value as 'encoding' will be
3116 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003117 No error will be given when the value is set, only when it is used,
3118 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003119 Conversion will also be done when 'encoding' and 'fileencoding' are
3120 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3121 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003123 'encoding' is "utf-8" or another Unicode encoding, conversion
3124 is most likely done in a way that the reverse conversion
3125 results in the same text. When 'encoding' is not "utf-8" some
3126 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003127
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 See 'encoding' for the possible values. Additionally, values may be
3129 specified that can be handled by the converter, see
3130 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003131
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 When reading a file 'fileencoding' will be set from 'fileencodings'.
3133 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003134 'fileencoding', use the |++enc| argument. One exception: when
3135 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003136 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003137
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3139 When the option is set, the value is converted to lowercase. Thus
3140 you can set it with uppercase values too. '_' characters are
3141 replaced with '-'. If a name is recognized from the list for
3142 'encoding', it is replaced by the standard name. For example
3143 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003144
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 When this option is set, after starting to edit a file, the 'modified'
3146 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003147
3148 Keep in mind that changing 'fenc' from a modeline happens
3149 AFTER the text has been read, thus it applies to when the file will be
3150 written. If you do set 'fenc' in a modeline, you might want to set
3151 'nomodified' to avoid not being able to ":q".
3152
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 This option can not be changed when 'modifiable' is off.
3154
3155 *'fe'*
3156 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003157 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 old short name was 'fe', which is no longer used.
3159
3160 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003161'fileencodings' 'fencs' string (default: "ucs-bom",
3162 "ucs-bom,utf-8,default,latin1" when
3163 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 This is a list of character encodings considered when starting to edit
3166 an existing file. When a file is read, Vim tries to use the first
3167 mentioned character encoding. If an error is detected, the next one
3168 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003169 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 an empty string, which means the value of 'encoding' is used.
3171 WARNING: Conversion can cause loss of information! When
3172 'encoding' is "utf-8" (or one of the other Unicode variants)
3173 conversion is most likely done in a way that the reverse
3174 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003175 "utf-8" some non-ASCII characters may be lost! You can use
3176 the |++bad| argument to specify what is done with characters
3177 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 For an empty file or a file with only ASCII characters most encodings
3179 will work and the first entry of 'fileencodings' will be used (except
3180 "ucs-bom", which requires the BOM to be present). If you prefer
3181 another encoding use an BufReadPost autocommand event to test if your
3182 preferred encoding is to be used. Example: >
3183 au BufReadPost * if search('\S', 'w') == 0 |
3184 \ set fenc=iso-2022-jp | endif
3185< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3186 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003187 When the |++enc| argument is used then the value of 'fileencodings' is
3188 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003189 Note that 'fileencodings' is not used for a new file, the global value
3190 of 'fileencoding' is used instead. You can set it with: >
3191 :setglobal fenc=iso-8859-2
3192< This means that a non-existing file may get a different encoding than
3193 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 The special value "ucs-bom" can be used to check for a Unicode BOM
3195 (Byte Order Mark) at the start of the file. It must not be preceded
3196 by "utf-8" or another Unicode encoding for this to work properly.
3197 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3198 because Vim cannot detect an error, thus the encoding is always
3199 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003200 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003201 environment. On MS-Windows this is the system encoding. Otherwise
3202 this is the default value for 'encoding'. It is useful when
3203 'encoding' is set to "utf-8" and your environment uses a non-latin1
3204 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003205 When 'encoding' is "utf-8" and a file contains an illegal byte
3206 sequence it won't be recognized as UTF-8. You can use the |8g8|
3207 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 WRONG VALUES: WHAT'S WRONG:
3209 latin1,utf-8 "latin1" will always be used
3210 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3211 file
3212 cp1250,latin1 "cp1250" will always be used
3213 If 'fileencodings' is empty, 'fileencoding' is not modified.
3214 See 'fileencoding' for the possible values.
3215 Setting this option does not have an effect until the next time a file
3216 is read.
3217
3218 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003219'fileformat' 'ff' string (MS-Windows default: "dos",
3220 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 This gives the <EOL> of the current buffer, which is used for
3223 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003224 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 unix <NL>
3226 mac <CR>
3227 When "dos" is used, CTRL-Z at the end of a file is ignored.
3228 See |file-formats| and |file-read|.
3229 For the character encoding of the file see 'fileencoding'.
3230 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003231 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 This option is set automatically when starting to edit a file and
3233 'fileformats' is not empty and 'binary' is off.
3234 When this option is set, after starting to edit a file, the 'modified'
3235 option is set, because the file would be different when written.
3236 This option can not be changed when 'modifiable' is off.
3237 For backwards compatibility: When this option is set to "dos",
3238 'textmode' is set, otherwise 'textmode' is reset.
3239
3240 *'fileformats'* *'ffs'*
3241'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003242 Vim+Vi MS-Windows: "dos,unix",
3243 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 Vi Cygwin: "unix,dos",
3245 Vi others: "")
3246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 This gives the end-of-line (<EOL>) formats that will be tried when
3248 starting to edit a new buffer and when reading a file into an existing
3249 buffer:
3250 - When empty, the format defined with 'fileformat' will be used
3251 always. It is not set automatically.
3252 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003253 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 'fileformats' name will be used when a file is read into an existing
3255 buffer, no matter what 'fileformat' for that buffer is set to.
3256 - When more than one name is present, separated by commas, automatic
3257 <EOL> detection will be done when reading a file. When starting to
3258 edit a file, a check is done for the <EOL>:
3259 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3260 'fileformat' is set to "dos".
3261 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003262 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003264 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3265 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003266 This means that "mac" is only chosen when:
3267 "unix" is not present or no <NL> is found in the file, and
3268 "dos" is not present or no <CR><NL> is found in the file.
3269 Except: if "unix" was chosen, but there is a <CR> before
3270 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003271 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 4. If 'fileformat' is still not set, the first name from
3273 'fileformats' is used.
3274 When reading a file into an existing buffer, the same is done, but
3275 this happens like 'fileformat' has been set appropriately for that
3276 file only, the option is not changed.
3277 When 'binary' is set, the value of 'fileformats' is not used.
3278
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003279 When Vim starts up with an empty buffer the first item is used. You
3280 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003281
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3283 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3284 done:
3285 - When 'fileformats' is empty, there is no automatic detection. Dos
3286 format will be used.
3287 - When 'fileformats' is set to one or more names, automatic detection
3288 is done. This is based on the first <NL> in the file: If there is a
3289 <CR> in front of it, Dos format is used, otherwise Unix format is
3290 used.
3291 Also see |file-formats|.
3292 For backwards compatibility: When this option is set to an empty
3293 string or one format (no comma is included), 'textauto' is reset,
3294 otherwise 'textauto' is set.
3295 NOTE: This option is set to the Vi default value when 'compatible' is
3296 set and to the Vim default value when 'compatible' is reset.
3297
Bram Moolenaarbf884932013-04-05 22:26:15 +02003298 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3299'fileignorecase' 'fic' boolean (default on for systems where case in file
3300 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003301 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003302 When set case is ignored when using file names and directories.
3303 See 'wildignorecase' for only ignoring case when doing completion.
3304
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 *'filetype'* *'ft'*
3306'filetype' 'ft' string (default: "")
3307 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 When this option is set, the FileType autocommand event is triggered.
3309 All autocommands that match with the value of this option will be
3310 executed. Thus the value of 'filetype' is used in place of the file
3311 name.
3312 Otherwise this option does not always reflect the current file type.
3313 This option is normally set when the file type is detected. To enable
3314 this use the ":filetype on" command. |:filetype|
3315 Setting this option to a different value is most useful in a modeline,
3316 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003317 Example, for in an IDL file:
3318 /* vim: set filetype=idl : */ ~
3319 |FileType| |filetypes|
3320 When a dot appears in the value then this separates two filetype
3321 names. Example:
3322 /* vim: set filetype=c.doxygen : */ ~
3323 This will use the "c" filetype first, then the "doxygen" filetype.
3324 This works both for filetype plugins and for syntax files. More than
3325 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 This option is not copied to another buffer, independent of the 's' or
3327 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003328 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329
3330 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003331'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003333 {not available when compiled without the |+folding|
3334 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 Characters to fill the statuslines and vertical separators.
3336 It is a comma separated list of items:
3337
3338 item default Used for ~
3339 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003340 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 vert:c '|' vertical separators |:vsplit|
3342 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003343 foldopen:c '-' mark the beginning of a fold
3344 foldclose:c '+' show a closed fold
3345 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003347 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003349 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003350 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 otherwise.
3352
3353 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003354 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355< This is similar to the default, except that these characters will also
3356 be used when there is highlighting.
3357
Bram Moolenaar008bff92021-03-04 21:55:58 +01003358 For "stl" and "stlnc" single-byte and multibyte characters are
3359 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003360
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 The highlighting used for these items:
3362 item highlight group ~
3363 stl:c StatusLine |hl-StatusLine|
3364 stlnc:c StatusLineNC |hl-StatusLineNC|
3365 vert:c VertSplit |hl-VertSplit|
3366 fold:c Folded |hl-Folded|
3367 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003368 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003370 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3371'fixendofline' 'fixeol' boolean (default on)
3372 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003373 When writing a file and this option is on, <EOL> at the end of file
3374 will be restored if missing. Turn this option off if you want to
3375 preserve the situation from the original file.
3376 When the 'binary' option is set the value of this option doesn't
3377 matter.
3378 See the 'endofline' option.
3379
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003381'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 {only available when compiled with the |+rightleft|
3384 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003385 This option was for using Farsi, which has been removed. See
3386 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387
3388 *'foldclose'* *'fcl'*
3389'foldclose' 'fcl' string (default "")
3390 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 {not available when compiled without the |+folding|
3392 feature}
3393 When set to "all", a fold is closed when the cursor isn't in it and
3394 its level is higher than 'foldlevel'. Useful if you want folds to
3395 automatically close when moving out of them.
3396
3397 *'foldcolumn'* *'fdc'*
3398'foldcolumn' 'fdc' number (default 0)
3399 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 {not available when compiled without the |+folding|
3401 feature}
3402 When non-zero, a column with the specified width is shown at the side
3403 of the window which indicates open and closed folds. The maximum
3404 value is 12.
3405 See |folding|.
3406
3407 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3408'foldenable' 'fen' boolean (default on)
3409 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 {not available when compiled without the |+folding|
3411 feature}
3412 When off, all folds are open. This option can be used to quickly
3413 switch between showing all text unfolded and viewing the text with
3414 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003415 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 'foldenable' is off.
3417 This option is set by commands that create a new fold or close a fold.
3418 See |folding|.
3419
3420 *'foldexpr'* *'fde'*
3421'foldexpr' 'fde' string (default: "0")
3422 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003424 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003426 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003427
Bram Moolenaar30b65812012-07-12 22:01:11 +02003428 The expression will be evaluated in the |sandbox| if set from a
3429 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003430 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003431 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003432
3433 It is not allowed to change text or jump to another window while
3434 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435
3436 *'foldignore'* *'fdi'*
3437'foldignore' 'fdi' string (default: "#")
3438 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 {not available when compiled without the |+folding|
3440 feature}
3441 Used only when 'foldmethod' is "indent". Lines starting with
3442 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003443 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 The default "#" works well for C programs. See |fold-indent|.
3445
3446 *'foldlevel'* *'fdl'*
3447'foldlevel' 'fdl' number (default: 0)
3448 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 {not available when compiled without the |+folding|
3450 feature}
3451 Sets the fold level: Folds with a higher level will be closed.
3452 Setting this option to zero will close all folds. Higher numbers will
3453 close fewer folds.
3454 This option is set by commands like |zm|, |zM| and |zR|.
3455 See |fold-foldlevel|.
3456
3457 *'foldlevelstart'* *'fdls'*
3458'foldlevelstart' 'fdls' number (default: -1)
3459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 {not available when compiled without the |+folding|
3461 feature}
3462 Sets 'foldlevel' when starting to edit another buffer in a window.
3463 Useful to always start editing with all folds closed (value zero),
3464 some folds closed (one) or no folds closed (99).
3465 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003466 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 ignores this option and closes all folds.
3468 It is also done before BufReadPre autocommands, to allow an autocmd to
3469 overrule the 'foldlevel' value for specific files.
3470 When the value is negative, it is not used.
3471
3472 *'foldmarker'* *'fmr'* *E536*
3473'foldmarker' 'fmr' string (default: "{{{,}}}")
3474 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 {not available when compiled without the |+folding|
3476 feature}
3477 The start and end marker used when 'foldmethod' is "marker". There
3478 must be one comma, which separates the start and end marker. The
3479 marker is a literal string (a regular expression would be too slow).
3480 See |fold-marker|.
3481
3482 *'foldmethod'* *'fdm'*
3483'foldmethod' 'fdm' string (default: "manual")
3484 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 {not available when compiled without the |+folding|
3486 feature}
3487 The kind of folding used for the current window. Possible values:
3488 |fold-manual| manual Folds are created manually.
3489 |fold-indent| indent Lines with equal indent form a fold.
3490 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3491 |fold-marker| marker Markers are used to specify folds.
3492 |fold-syntax| syntax Syntax highlighting items specify folds.
3493 |fold-diff| diff Fold text that is not changed.
3494
3495 *'foldminlines'* *'fml'*
3496'foldminlines' 'fml' number (default: 1)
3497 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 {not available when compiled without the |+folding|
3499 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003500 Sets the number of screen lines above which a fold can be displayed
3501 closed. Also for manually closed folds. With the default value of
3502 one a fold can only be closed if it takes up two or more screen lines.
3503 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003504 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 "zc" to close a fold, which is displayed open because it's smaller
3506 than 'foldminlines', a following "zc" may close a containing fold.
3507
3508 *'foldnestmax'* *'fdn'*
3509'foldnestmax' 'fdn' number (default: 20)
3510 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 {not available when compiled without the |+folding|
3512 feature}
3513 Sets the maximum nesting of folds for the "indent" and "syntax"
3514 methods. This avoids that too many folds will be created. Using more
3515 than 20 doesn't work, because the internal limit is 20.
3516
3517 *'foldopen'* *'fdo'*
3518'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3519 search,tag,undo")
3520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 {not available when compiled without the |+folding|
3522 feature}
3523 Specifies for which type of commands folds will be opened, if the
3524 command moves the cursor into a closed fold. It is a comma separated
3525 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003526 NOTE: When the command is part of a mapping this option is not used.
3527 Add the |zv| command to the mapping to get the same effect.
3528 (rationale: the mapping may want to control opening folds itself)
3529
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 item commands ~
3531 all any
3532 block "(", "{", "[[", "[{", etc.
3533 hor horizontal movements: "l", "w", "fx", etc.
3534 insert any command in Insert mode
3535 jump far jumps: "G", "gg", etc.
3536 mark jumping to a mark: "'m", CTRL-O, etc.
3537 percent "%"
3538 quickfix ":cn", ":crew", ":make", etc.
3539 search search for a pattern: "/", "n", "*", "gd", etc.
3540 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003541 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 tag jumping to a tag: ":ta", CTRL-T, etc.
3543 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 When a movement command is used for an operator (e.g., "dl" or "y%")
3545 this option is not used. This means the operator will include the
3546 whole closed fold.
3547 Note that vertical movements are not here, because it would make it
3548 very difficult to move onto a closed fold.
3549 In insert mode the folds containing the cursor will always be open
3550 when text is inserted.
3551 To close folds you can re-apply 'foldlevel' with the |zx| command or
3552 set the 'foldclose' option to "all".
3553
3554 *'foldtext'* *'fdt'*
3555'foldtext' 'fdt' string (default: "foldtext()")
3556 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 {not available when compiled without the |+folding|
3558 feature}
3559 An expression which is used to specify the text displayed for a closed
3560 fold. See |fold-foldtext|.
3561
Bram Moolenaar30b65812012-07-12 22:01:11 +02003562 The expression will be evaluated in the |sandbox| if set from a
3563 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003564 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003565
3566 It is not allowed to change text or jump to another window while
3567 evaluating 'foldtext' |textlock|.
3568
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003569 *'formatexpr'* *'fex'*
3570'formatexpr' 'fex' string (default "")
3571 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003572 {not available when compiled without the |+eval|
3573 feature}
3574 Expression which is evaluated to format a range of lines for the |gq|
3575 operator or automatic formatting (see 'formatoptions'). When this
3576 option is empty 'formatprg' is used.
3577
3578 The |v:lnum| variable holds the first line to be formatted.
3579 The |v:count| variable holds the number of lines to be formatted.
3580 The |v:char| variable holds the character that is going to be
3581 inserted if the expression is being evaluated due to
3582 automatic formatting. This can be empty. Don't insert
3583 it yet!
3584
3585 Example: >
3586 :set formatexpr=mylang#Format()
3587< This will invoke the mylang#Format() function in the
3588 autoload/mylang.vim file in 'runtimepath'. |autoload|
3589
3590 The expression is also evaluated when 'textwidth' is set and adding
3591 text beyond that limit. This happens under the same conditions as
3592 when internal formatting is used. Make sure the cursor is kept in the
3593 same spot relative to the text then! The |mode()| function will
3594 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003595
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003596 When the expression evaluates to non-zero Vim will fall back to using
3597 the internal format mechanism.
3598
3599 The expression will be evaluated in the |sandbox| when set from a
3600 modeline, see |sandbox-option|. That stops the option from working,
3601 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003602 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003603 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003604
Bram Moolenaar86b68352004-12-27 21:59:20 +00003605 *'formatlistpat'* *'flp'*
3606'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3607 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003608 A pattern that is used to recognize a list header. This is used for
3609 the "n" flag in 'formatoptions'.
3610 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003611 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003612 while still checking more characters. There must be a character
3613 following the pattern, when it matches the whole line it is handled
3614 like there is no match.
3615 The default recognizes a number, followed by an optional punctuation
3616 character and white space.
3617
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003618 *'formatoptions'* *'fo'*
3619'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3620 local to buffer
3621 This is a sequence of letters which describes how automatic
3622 formatting is to be done. See |fo-table|. When the 'paste' option is
3623 on, no formatting is done (like 'formatoptions' is empty). Commas can
3624 be inserted for readability.
3625 To avoid problems with flags that are added in the future, use the
3626 "+=" and "-=" feature of ":set" |add-option-flags|.
3627 NOTE: This option is set to the Vi default value when 'compatible' is
3628 set and to the Vim default value when 'compatible' is reset.
3629
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 *'formatprg'* *'fp'*
3631'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003632 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003634 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003636 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003637 If the 'formatexpr' option is not empty it will be used instead.
3638 Otherwise, if 'formatprg' option is an empty string, the internal
3639 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003640 Environment variables are expanded |:set_env|. See |option-backslash|
3641 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003642 This option cannot be set from a |modeline| or in the |sandbox|, for
3643 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644
Bram Moolenaard94464e2015-11-02 15:28:18 +01003645 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003646'fsync' 'fs' boolean (default on)
3647 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003648 When on, the library function fsync() will be called after writing a
3649 file. This will flush a file to disk, ensuring that it is safely
3650 written even on filesystems which do metadata-only journaling. This
3651 will force the harddrive to spin up on Linux systems running in laptop
3652 mode, so it may be undesirable in some situations. Be warned that
3653 turning this off increases the chances of data loss after a crash. On
3654 systems without an fsync() implementation, this variable is always
3655 off.
3656 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003657 'fsync' also applies to |writefile()| (unless a flag is used to
3658 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003659 This option cannot be set from a |modeline| or in the |sandbox|, for
3660 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003661
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3663'gdefault' 'gd' boolean (default off)
3664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 When on, the ":substitute" flag 'g' is default on. This means that
3666 all matches in a line are substituted instead of one. When a 'g' flag
3667 is given to a ":substitute" command, this will toggle the substitution
3668 of all or one match. See |complex-change|.
3669
3670 command 'gdefault' on 'gdefault' off ~
3671 :s/// subst. all subst. one
3672 :s///g subst. one subst. all
3673 :s///gg subst. all subst. one
3674
3675 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003676 DEPRECATED: Setting this option may break plugins that are not aware
3677 of this option. Also, many users get confused that adding the /g flag
3678 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003679 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680
3681 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003682'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 Format to recognize for the ":grep" command output.
3685 This is a scanf-like string that uses the same format as the
3686 'errorformat' option: see |errorformat|.
3687
3688 *'grepprg'* *'gp'*
3689'grepprg' 'gp' string (default "grep -n ",
3690 Unix: "grep -n $* /dev/null",
3691 Win32: "findstr /n" or "grep -n",
3692 VMS: "SEARCH/NUMBERS ")
3693 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003694 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 and '#' characters, which are expanded like when used in a command-
3696 line. The placeholder "$*" is allowed to specify where the arguments
3697 will be included. Environment variables are expanded |:set_env|. See
3698 |option-backslash| about including spaces and backslashes.
3699 When your "grep" accepts the "-H" argument, use this to make ":grep"
3700 also work well with a single file: >
3701 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003702< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003703 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3704 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003705 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 apply equally to 'grepprg'.
3707 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3708 otherwise it's "grep -n".
3709 This option cannot be set from a |modeline| or in the |sandbox|, for
3710 security reasons.
3711
3712 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3713'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3714 ve:ver35-Cursor,
3715 o:hor50-Cursor,
3716 i-ci:ver25-Cursor/lCursor,
3717 r-cr:hor20-Cursor/lCursor,
3718 sm:block-Cursor
3719 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003720 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 "n-v-c:block,o:hor50,i-ci:hor15,
3722 r-cr:hor30,sm:block")
3723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003725 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003727 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003728 height of the cursor can be changed. This can be done by specifying a
3729 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003730 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3731 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003733 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 mode-list and an argument-list:
3735 mode-list:argument-list,mode-list:argument-list,..
3736 The mode-list is a dash separated list of these modes:
3737 n Normal mode
3738 v Visual mode
3739 ve Visual mode with 'selection' "exclusive" (same as 'v',
3740 if not specified)
3741 o Operator-pending mode
3742 i Insert mode
3743 r Replace mode
3744 c Command-line Normal (append) mode
3745 ci Command-line Insert mode
3746 cr Command-line Replace mode
3747 sm showmatch in Insert mode
3748 a all modes
3749 The argument-list is a dash separated list of these arguments:
3750 hor{N} horizontal bar, {N} percent of the character height
3751 ver{N} vertical bar, {N} percent of the character width
3752 block block cursor, fills the whole character
3753 [only one of the above three should be present]
3754 blinkwait{N} *cursor-blinking*
3755 blinkon{N}
3756 blinkoff{N}
3757 blink times for cursor: blinkwait is the delay before
3758 the cursor starts blinking, blinkon is the time that
3759 the cursor is shown and blinkoff is the time that the
3760 cursor is not shown. The times are in msec. When one
3761 of the numbers is zero, there is no blinking. The
3762 default is: "blinkwait700-blinkon400-blinkoff250".
3763 These numbers are used for a missing entry. This
3764 means that blinking is enabled by default. To switch
3765 blinking off you can use "blinkon0". The cursor only
3766 blinks when Vim is waiting for input, not while
3767 executing a command.
3768 To make the cursor blink in an xterm, see
3769 |xterm-blink|.
3770 {group-name}
3771 a highlight group name, that sets the color and font
3772 for the cursor
3773 {group-name}/{group-name}
3774 Two highlight group names, the first is used when
3775 no language mappings are used, the other when they
3776 are. |language-mapping|
3777
3778 Examples of parts:
3779 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3780 block cursor with colors from the "nCursor"
3781 highlight group
3782 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3783 In Insert and Command-line Insert mode, use a
3784 30% vertical bar cursor with colors from the
3785 "iCursor" highlight group. Blink a bit
3786 faster.
3787
3788 The 'a' mode is different. It will set the given argument-list for
3789 all modes. It does not reset anything to defaults. This can be used
3790 to do a common setting for all modes. For example, to switch off
3791 blinking: "a:blinkon0"
3792
3793 Examples of cursor highlighting: >
3794 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3795 :highlight Cursor gui=NONE guifg=bg guibg=fg
3796<
3797 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003798 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799'guifont' 'gfn' string (default "")
3800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 {only available when compiled with GUI enabled}
3802 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003803 In its simplest form the value is just one font name.
3804 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805
3806 *'guifontset'* *'gfs'*
3807 *E250* *E252* *E234* *E597* *E598*
3808'guifontset' 'gfs' string (default "")
3809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 {only available when compiled with GUI enabled and
3811 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003812 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 When not empty, specifies two (or more) fonts to be used. The first
3814 one for normal English, the second one for your special language. See
3815 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003816
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3818'guifontwide' 'gfw' string (default "")
3819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 {only available when compiled with GUI enabled}
3821 When not empty, specifies a comma-separated list of fonts to be used
3822 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003823 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003824
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 *'guiheadroom'* *'ghr'*
3826'guiheadroom' 'ghr' number (default 50)
3827 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003828 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 The number of pixels subtracted from the screen height when fitting
3830 the GUI window on the screen. Set this before the GUI is started,
3831 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003832 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 lines will be left for window decorations and other items on the
3834 screen. Set it to a negative value to allow windows taller than the
3835 screen.
3836
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003837 *'guiligatures'* *'gli'* *E1243*
3838'guiligatures' 'gli' string (default "")
3839 global
3840 {only for GTK GUI}
3841 List of ASCII characters that, when combined together, can create more
3842 complex shapes. Each character must be a printable ASCII character
3843 with a value in the 32-127 range.
3844 Example: >
3845 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3846< Changing this option updates screen output immediately. Set it to an
3847 empty string to disable ligatures.
3848
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003850'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3851 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003852 "aegimrLtT" (GTK, Motif and Athena),
3853 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003856 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 sequence of letters which describes what components and options of the
3858 GUI should be used.
3859 To avoid problems with flags that are added in the future, use the
3860 "+=" and "-=" feature of ":set" |add-option-flags|.
3861
Bram Moolenaar13568252018-03-16 20:46:58 +01003862 Valid characters are as follows:
3863 *'go-!'*
3864 '!' External commands are executed in a terminal window. Without
3865 this flag the MS-Windows GUI will open a console window to
3866 execute the command. The Unix GUI will simulate a dumb
3867 terminal to list the command output.
3868 The terminal window will be positioned at the bottom, and grow
3869 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003870 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 'a' Autoselect: If present, then whenever VISUAL mode is started,
3872 or the Visual area extended, Vim tries to become the owner of
3873 the windowing system's global selection. This means that the
3874 Visually highlighted text is available for pasting into other
3875 applications as well as into Vim itself. When the Visual mode
3876 ends, possibly due to an operation on the text, or when an
3877 application wants to paste the selection, the highlighted text
3878 is automatically yanked into the "* selection register.
3879 Thus the selection is still available for pasting into other
3880 applications after the VISUAL mode has ended.
3881 If not present, then Vim won't become the owner of the
3882 windowing system's global selection unless explicitly told to
3883 by a yank or delete operation for the "* register.
3884 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003885 *'go-P'*
3886 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003887 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003888 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003889 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 applies to the modeless selection.
3891
3892 'guioptions' autoselect Visual autoselect modeless ~
3893 "" - -
3894 "a" yes yes
3895 "A" - yes
3896 "aA" yes yes
3897
Bram Moolenaar02467872007-05-06 13:22:01 +00003898 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 'c' Use console dialogs instead of popup dialogs for simple
3900 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003901 *'go-d'*
3902 'd' Use dark theme variant if available. Currently only works for
3903 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003904 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003905 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003906 'guitablabel' can be used to change the text in the labels.
3907 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003908 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003909 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003910 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 'f' Foreground: Don't use fork() to detach the GUI from the shell
3912 where it was started. Use this for programs that wait for the
3913 editor to finish (e.g., an e-mail program). Alternatively you
3914 can use "gvim -f" or ":gui -f" to start the GUI in the
3915 foreground. |gui-fork|
3916 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003917 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003918 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3920 corner of the window. It's black&white on non-GTK, because of
3921 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003922 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003924 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003925 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003927 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003929 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003930 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 'g' Grey menu items: Make menu items that are not active grey. If
3932 'g' is not included inactive menu items are not shown at all.
3933 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003934 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 't' Include tearoff menu items. Currently only works for Win32,
3936 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003937 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003938 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003939 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003940 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003942 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 'R' Right-hand scrollbar is present when there is a vertically
3944 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003945 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003947 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 'L' Left-hand scrollbar is present when there is a vertically
3949 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003950 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3952 the longest visible line, or on the cursor line if the 'h'
3953 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003954 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 'h' Limit horizontal scrollbar size to the length of the cursor
3956 line. Reduces computations. |gui-horiz-scroll|
3957
3958 And yes, you may even have scrollbars on the left AND the right if
3959 you really want to :-). See |gui-scrollbars| for more information.
3960
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003961 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 'v' Use a vertical button layout for dialogs. When not included,
3963 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003964 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003965 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 'p' Use Pointer callbacks for X11 GUI. This is required for some
3967 window managers. If the cursor is not blinking or hollow at
3968 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003969 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003971 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003972 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003973 *'go-k'*
3974 'k' Keep the GUI window size when adding/removing a scrollbar, or
3975 toolbar, tabline, etc. Instead, the behavior is similar to
3976 when the window is maximized and will adjust 'lines' and
3977 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003978 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003979 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003980
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 *'guipty'* *'noguipty'*
3982'guipty' boolean (default on)
3983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 {only available when compiled with GUI enabled}
3985 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3986 I/O to/from shell commands. See |gui-pty|.
3987
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003988 *'guitablabel'* *'gtl'*
3989'guitablabel' 'gtl' string (default empty)
3990 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003991 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003992 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003993 pages line. When empty and when the result is empty Vim will use a
3994 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003995
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003996 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003997 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003998 The expression will be evaluated in the |sandbox| when set from a
3999 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004000 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004001
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004002 Only used when the GUI tab pages line is displayed. 'e' must be
4003 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4004 used.
4005
Bram Moolenaar57657d82006-04-21 22:12:41 +00004006 *'guitabtooltip'* *'gtt'*
4007'guitabtooltip' 'gtt' string (default empty)
4008 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004009 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004010 When nonempty describes the text to use in a tooltip for the GUI tab
4011 pages line. When empty Vim will use a default tooltip.
4012 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004013 You can include a line break. Simplest method is to use |:let|: >
4014 :let &guitabtooltip = "line one\nline two"
4015<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004016
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004018'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 (others) "$VIMRUNTIME/doc/help.txt")
4020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 Name of the main help file. All distributed help files should be
4022 placed together in one directory. Additionally, all "doc" directories
4023 in 'runtimepath' will be used.
4024 Environment variables are expanded |:set_env|. For example:
4025 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004026 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 spaces and backslashes.
4028 This option cannot be set from a |modeline| or in the |sandbox|, for
4029 security reasons.
4030
4031 *'helpheight'* *'hh'*
4032'helpheight' 'hh' number (default 20)
4033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 Minimal initial height of the help window when it is opened with the
4035 ":help" command. The initial height of the help window is half of the
4036 current window, or (when the 'ea' option is on) the same as other
4037 windows. When the height is less than 'helpheight', the height is
4038 set to 'helpheight'. Set to zero to disable.
4039
4040 *'helplang'* *'hlg'*
4041'helplang' 'hlg' string (default: messages language or empty)
4042 global
4043 {only available when compiled with the |+multi_lang|
4044 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 Comma separated list of languages. Vim will use the first language
4046 for which the desired help can be found. The English help will always
4047 be used as a last resort. You can add "en" to prefer English over
4048 another language, but that will only find tags that exist in that
4049 language and not in the English help.
4050 Example: >
4051 :set helplang=de,it
4052< This will first search German, then Italian and finally English help
4053 files.
4054 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4055 try to find the tag in the current language before using this option.
4056 See |help-translated|.
4057
4058 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4059'hidden' 'hid' boolean (default off)
4060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 When off a buffer is unloaded when it is |abandon|ed. When on a
4062 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4063 displayed in another window, it does not become hidden, of course.
4064 The commands that move through the buffer list sometimes make a buffer
4065 hidden although the 'hidden' option is off: When the buffer is
4066 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004067 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004068 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 This option is set for one command with ":hide {command}" |:hide|.
4070 WARNING: It's easy to forget that you have changes in hidden buffers.
4071 Think twice when using ":q!" or ":qa!".
4072
4073 *'highlight'* *'hl'*
4074'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004075 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4076 d:Directory,e:ErrorMsg,i:IncSearch,
4077 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004078 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004079 N:CursorLineNr,r:Question,s:StatusLine,
4080 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004081 v:Visual,V:VisualNOS,w:WarningMsg,
4082 W:WildMenu,f:Folded,F:FoldColumn,
4083 A:DiffAdd,C:DiffChange,D:DiffDelete,
4084 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004085 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004086 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004087 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4088 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004089 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004090 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 This option can be used to set highlighting mode for various
4093 occasions. It is a comma separated list of character pairs. The
4094 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004095 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004097 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4098 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 characters from 'showbreak'
4100 |hl-Directory| d directories in CTRL-D listing and other special
4101 things in listings
4102 |hl-ErrorMsg| e error messages
4103 h (obsolete, ignored)
4104 |hl-IncSearch| i 'incsearch' highlighting
4105 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4106 |hl-MoreMsg| m |more-prompt|
4107 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004108 |hl-LineNr| n line number for ":number" and ":#" commands, and
4109 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004110 |hl-LineNrAbove| a line number above the cursor for when the
4111 'relativenumber' option is set.
4112 |hl-LineNrBelow| b line number below the cursor for when the
4113 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004114 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4115 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 |hl-Question| r |hit-enter| prompt and yes/no questions
4117 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004118 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4120 |hl-VertSplit| c column used to separate vertically split windows
4121 |hl-Visual| v Visual mode
4122 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4123 Selection" Only X11 Gui's |gui-x11| and
4124 |xterm-clipboard|.
4125 |hl-WarningMsg| w warning messages
4126 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4127 |hl-Folded| f line used for closed folds
4128 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004129 |hl-DiffAdd| A added line in diff mode
4130 |hl-DiffChange| C changed line in diff mode
4131 |hl-DiffDelete| D deleted line in diff mode
4132 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004134 |hl-Conceal| - the placeholders used for concealed characters
4135 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004136 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004137 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004138 |hl-SpellRare| R rare word |spell|
4139 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004140 |hl-Pmenu| + popup menu normal line
4141 |hl-PmenuSel| = popup menu selected line
4142 |hl-PmenuSbar| x popup menu scrollbar
4143 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144
4145 The display modes are:
4146 r reverse (termcap entry "mr" and "me")
4147 i italic (termcap entry "ZH" and "ZR")
4148 b bold (termcap entry "md" and "me")
4149 s standout (termcap entry "so" and "se")
4150 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004151 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004152 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 n no highlighting
4154 - no highlighting
4155 : use a highlight group
4156 The default is used for occasions that are not included.
4157 If you want to change what the display modes do, see |dos-colors|
4158 for an example.
4159 When using the ':' display mode, this must be followed by the name of
4160 a highlight group. A highlight group can be used to define any type
4161 of highlighting, including using color. See |:highlight| on how to
4162 define one. The default uses a different group for each occasion.
4163 See |highlight-default| for the default highlight groups.
4164
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004166'history' 'hi' number (Vim default: 50, Vi default: 0,
4167 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004170 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004172 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 NOTE: This option is set to the Vi default value when 'compatible' is
4174 set and to the Vim default value when 'compatible' is reset.
4175
4176 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4177'hkmap' 'hk' boolean (default off)
4178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 {only available when compiled with the |+rightleft|
4180 feature}
4181 When on, the keyboard is mapped for the Hebrew character set.
4182 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4183 toggle this option. See |rileft.txt|.
4184 NOTE: This option is reset when 'compatible' is set.
4185
4186 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4187'hkmapp' 'hkp' boolean (default off)
4188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 {only available when compiled with the |+rightleft|
4190 feature}
4191 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4192 This is useful if you have a non-Hebrew keyboard.
4193 See |rileft.txt|.
4194 NOTE: This option is reset when 'compatible' is set.
4195
Bram Moolenaar036986f2017-03-16 17:41:02 +01004196 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4197'hlsearch' 'hls' boolean (default off)
4198 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004199 {not available when compiled without the
4200 |+extra_search| feature}
4201 When there is a previous search pattern, highlight all its matches.
4202 The type of highlighting used can be set with the 'l' occasion in the
4203 'highlight' option. This uses the "Search" highlight group by
4204 default. Note that only the matching text is highlighted, any offsets
4205 are not applied.
4206 See also: 'incsearch' and |:match|.
4207 When you get bored looking at the highlighted matches, you can turn it
4208 off with |:nohlsearch|. This does not change the option value, as
4209 soon as you use a search command, the highlighting comes back.
4210 'redrawtime' specifies the maximum time spent on finding matches.
4211 When the search pattern can match an end-of-line, Vim will try to
4212 highlight all of the matched text. However, this depends on where the
4213 search starts. This will be the first line in the window or the first
4214 line below a closed fold. A match in a previous line which is not
4215 drawn may not continue in a newly drawn line.
4216 You can specify whether the highlight status is restored on startup
4217 with the 'h' flag in 'viminfo' |viminfo-h|.
4218 NOTE: This option is reset when 'compatible' is set.
4219
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 *'icon'* *'noicon'*
4221'icon' boolean (default off, on when title can be restored)
4222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 When on, the icon text of the window will be set to the value of
4224 'iconstring' (if it is not empty), or to the name of the file
4225 currently being edited. Only the last part of the name is used.
4226 Overridden by the 'iconstring' option.
4227 Only works if the terminal supports setting window icons (currently
4228 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4229 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4230 builtin termcap).
4231 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004232 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004234 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235
4236 *'iconstring'*
4237'iconstring' string (default "")
4238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 When this option is not empty, it will be used for the icon text of
4240 the window. This happens only when the 'icon' option is on.
4241 Only works if the terminal supports setting window icon text
4242 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004243 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 When Vim was compiled with HAVE_X11 defined, the original icon will be
4245 restored if possible |X11|.
4246 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004247 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004249 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 {not available when compiled without the |+statusline| feature}
4251
4252 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4253'ignorecase' 'ic' boolean (default off)
4254 global
4255 Ignore case in search patterns. Also used when searching in the tags
4256 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004257 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 Can be overruled by using "\c" or "\C" in the pattern, see
4259 |/ignorecase|.
4260
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004261 *'imactivatefunc'* *'imaf'*
4262'imactivatefunc' 'imaf' string (default "")
4263 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004264 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004265 activate or deactivate the Input Method. The value can be the name of
4266 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4267 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004268 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004269 The expression will be evaluated in the |sandbox| when set from a
4270 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004271
4272 Example: >
4273 function ImActivateFunc(active)
4274 if a:active
4275 ... do something
4276 else
4277 ... do something
4278 endif
4279 " return value is not used
4280 endfunction
4281 set imactivatefunc=ImActivateFunc
4282<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 *'imactivatekey'* *'imak'*
4284'imactivatekey' 'imak' string (default "")
4285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004287 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 Specifies the key that your Input Method in X-Windows uses for
4289 activation. When this is specified correctly, vim can fully control
4290 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4291 You can't use this option to change the activation key, the option
4292 tells Vim what the key is.
4293 Format:
4294 [MODIFIER_FLAG-]KEY_STRING
4295
4296 These characters can be used for MODIFIER_FLAG (case is ignored):
4297 S Shift key
4298 L Lock key
4299 C Control key
4300 1 Mod1 key
4301 2 Mod2 key
4302 3 Mod3 key
4303 4 Mod4 key
4304 5 Mod5 key
4305 Combinations are allowed, for example "S-C-space" or "SC-space" are
4306 both shift+ctrl+space.
4307 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4308
4309 Example: >
4310 :set imactivatekey=S-space
4311< "S-space" means shift+space. This is the activation key for kinput2 +
4312 canna (Japanese), and ami (Korean).
4313
4314 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4315'imcmdline' 'imc' boolean (default off)
4316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 When set the Input Method is always on when starting to edit a command
4318 line, unless entering a search pattern (see 'imsearch' for that).
4319 Setting this option is useful when your input method allows entering
4320 English characters directly, e.g., when it's used to type accented
4321 characters with dead keys.
4322
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004323 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 When set the Input Method is never used. This is useful to disable
4327 the IM when it doesn't work properly.
4328 Currently this option is on by default for SGI/IRIX machines. This
4329 may change in later releases.
4330
4331 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004332'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 Specifies whether :lmap or an Input Method (IM) is to be used in
4335 Insert mode. Valid values:
4336 0 :lmap is off and IM is off
4337 1 :lmap is ON and IM is off
4338 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 To always reset the option to zero when leaving Insert mode with <Esc>
4340 this can be used: >
4341 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4342< This makes :lmap and IM turn off automatically when leaving Insert
4343 mode.
4344 Note that this option changes when using CTRL-^ in Insert mode
4345 |i_CTRL-^|.
4346 The value is set to 1 when setting 'keymap' to a valid keymap name.
4347 It is also used for the argument of commands like "r" and "f".
4348 The value 0 may not work correctly with Athena and Motif with some XIM
4349 methods. Use 'imdisable' to disable XIM then.
4350
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004351 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004352 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004353 |+multi_byte_ime| or |global-ime|.
4354
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004356'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 Specifies whether :lmap or an Input Method (IM) is to be used when
4359 entering a search pattern. Valid values:
4360 -1 the value of 'iminsert' is used, makes it look like
4361 'iminsert' is also used when typing a search pattern
4362 0 :lmap is off and IM is off
4363 1 :lmap is ON and IM is off
4364 2 :lmap is off and IM is ON
4365 Note that this option changes when using CTRL-^ in Command-line mode
4366 |c_CTRL-^|.
4367 The value is set to 1 when it is not -1 and setting the 'keymap'
4368 option to a valid keymap name.
4369 The value 0 may not work correctly with Athena and Motif with some XIM
4370 methods. Use 'imdisable' to disable XIM then.
4371
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004372 *'imstatusfunc'* *'imsf'*
4373'imstatusfunc' 'imsf' string (default "")
4374 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004375 This option specifies a function that is called to obtain the status
4376 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004377 The value can be the name of a function, a |lambda| or a |Funcref|.
4378 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004379 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004380
4381 Example: >
4382 function ImStatusFunc()
4383 let is_active = ...do something
4384 return is_active ? 1 : 0
4385 endfunction
4386 set imstatusfunc=ImStatusFunc
4387<
4388 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004389 The expression will be evaluated in the |sandbox| when set from a
4390 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004391
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004392 *'imstyle'* *'imst'*
4393'imstyle' 'imst' number (default 1)
4394 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004395 {only available when compiled with |+xim| and
4396 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004397 This option specifies the input style of Input Method:
4398 0 use on-the-spot style
4399 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004400 See: |xim-input-style|
4401
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004402 For a long time on-the-spot style had been used in the GTK version of
4403 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004404 |single-repeat|, etc. Therefore over-the-spot style becomes the
4405 default now. This should work fine for most people, however if you
4406 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004407 The expression will be evaluated in the |sandbox| when set from a
4408 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004409
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 *'include'* *'inc'*
4411'include' 'inc' string (default "^\s*#\s*include")
4412 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 {not available when compiled without the
4414 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004415 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 pattern, just like for the "/" command (See |pattern|). The default
4417 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004418 "]I", "[d", etc.
4419 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004420 comes after the matched pattern. But if "\zs" appears in the pattern
4421 then the text matched from "\zs" to the end, or until "\ze" if it
4422 appears, is used as the file name. Use this to include characters
4423 that are not in 'isfname', such as a space. You can then use
4424 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004425 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426
4427 *'includeexpr'* *'inex'*
4428'includeexpr' 'inex' string (default "")
4429 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004431 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004433 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 :set includeexpr=substitute(v:fname,'\\.','/','g')
4435< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004436
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004438 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 Also used for |<cfile>|.
4440
Bram Moolenaar30b65812012-07-12 22:01:11 +02004441 The expression will be evaluated in the |sandbox| when set from a
4442 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004443 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004444
4445 It is not allowed to change text or jump to another window while
4446 evaluating 'includeexpr' |textlock|.
4447
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004449'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4450 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004453 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004454 While typing a search command, show where the pattern, as it was typed
4455 so far, matches. The matched string is highlighted. If the pattern
4456 is invalid or not found, nothing is shown. The screen will be updated
4457 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004458 Also applies to the pattern in commands: >
4459 :global
4460 :lvimgrep
4461 :lvimgrepadd
4462 :smagic
4463 :snomagic
4464 :sort
4465 :substitute
4466 :vglobal
4467 :vimgrep
4468 :vimgrepadd
4469< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004470 original position when no match is found and when pressing <Esc>. You
4471 still need to finish the search command with <Enter> to move the
4472 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004473 You can use the CTRL-G and CTRL-T keys to move to the next and
4474 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004475 When compiled with the |+reltime| feature Vim only searches for about
4476 half a second. With a complicated pattern and/or a lot of text the
4477 match may not be found. This is to avoid that Vim hangs while you
4478 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004479 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004480 When 'hlsearch' is on, all matched strings are highlighted too while
4481 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004482 If you don't want to turn 'hlsearch' on, but want to highlight all
4483 matches while searching, you can turn on and off 'hlsearch' with
4484 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004485 augroup vimrc-incsearch-highlight
4486 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004487 autocmd CmdlineEnter /,\? :set hlsearch
4488 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004489 augroup END
4490<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004491 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004492 to the command line. If 'ignorecase' and 'smartcase' are set and the
4493 command line has no uppercase characters, the added character is
4494 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004495 CTRL-R CTRL-W can be used to add the word at the end of the current
4496 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 NOTE: This option is reset when 'compatible' is set.
4498
4499 *'indentexpr'* *'inde'*
4500'indentexpr' 'inde' string (default "")
4501 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 {not available when compiled without the |+cindent|
4503 or |+eval| features}
4504 Expression which is evaluated to obtain the proper indent for a line.
4505 It is used when a new line is created, for the |=| operator and
4506 in Insert mode as specified with the 'indentkeys' option.
4507 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004508 'smartindent' indenting. When 'lisp' is set, this option is
4509 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 When 'paste' is set this option is not used for indenting.
4511 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004512 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 when the expression is evaluated (but it may be moved around).
4514 The expression must return the number of spaces worth of indent. It
4515 can return "-1" to keep the current indent (this means 'autoindent' is
4516 used for the indent).
4517 Functions useful for computing the indent are |indent()|, |cindent()|
4518 and |lispindent()|.
4519 The evaluation of the expression must not have side effects! It must
4520 not change the text, jump to another window, etc. Afterwards the
4521 cursor position is always restored, thus the cursor may be moved.
4522 Normally this option would be set to call a function: >
4523 :set indentexpr=GetMyIndent()
4524< Error messages will be suppressed, unless the 'debug' option contains
4525 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004526 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004527 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528
Bram Moolenaar30b65812012-07-12 22:01:11 +02004529 The expression will be evaluated in the |sandbox| when set from a
4530 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004531 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004532
4533 It is not allowed to change text or jump to another window while
4534 evaluating 'indentexpr' |textlock|.
4535
4536
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004538'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540 {not available when compiled without the |+cindent|
4541 feature}
4542 A list of keys that, when typed in Insert mode, cause reindenting of
4543 the current line. Only happens if 'indentexpr' isn't empty.
4544 The format is identical to 'cinkeys', see |indentkeys-format|.
4545 See |C-indenting| and |indent-expression|.
4546
4547 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4548'infercase' 'inf' boolean (default off)
4549 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004551 'ignorecase' is also on, the case of the match is adjusted depending
4552 on the typed text. If the typed text contains a lowercase letter
4553 where the match has an upper case letter, the completed part is made
4554 lowercase. If the typed text has no lowercase letters and the match
4555 has a lowercase letter where the typed text has an uppercase letter,
4556 and there is a letter before it, the completed part is made uppercase.
4557 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558
4559 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4560'insertmode' 'im' boolean (default off)
4561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 Makes Vim work in a way that Insert mode is the default mode. Useful
4563 if you want to use Vim as a modeless editor. Used for |evim|.
4564 These Insert mode commands will be useful:
4565 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004566 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 this is a mapping, it is executed as if 'insertmode' was off.
4568 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004570 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4571 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572
4573 These items change when 'insertmode' is set:
4574 - when starting to edit of a file, Vim goes to Insert mode.
4575 - <Esc> in Insert mode is a no-op and beeps.
4576 - <Esc> in Normal mode makes Vim go to Insert mode.
4577 - CTRL-L in Insert mode is a command, it is not inserted.
4578 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4579 However, when <Esc> is used inside a mapping, it behaves like
4580 'insertmode' was not set. This was done to be able to use the same
4581 mappings with 'insertmode' set or not set.
4582 When executing commands with |:normal| 'insertmode' is not used.
4583
4584 NOTE: This option is reset when 'compatible' is set.
4585
4586 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004587'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4589 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4590 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4591 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4592 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4593 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 The characters specified by this option are included in file names and
4595 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004596 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 Multi-byte characters 256 and above are always included, only the
4598 characters up to 255 are specified with this option.
4599 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004600 Think twice before adding white space to this option. Although a
4601 space may appear inside a file name, the effect will be that Vim
4602 doesn't know where a file name starts or ends when doing completion.
4603 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604
4605 Note that on systems using a backslash as path separator, Vim tries to
4606 do its best to make it work as you would expect. That is a bit
4607 tricky, since Vi originally used the backslash to escape special
4608 characters. Vim will not remove a backslash in front of a normal file
4609 name character on these systems, but it will on Unix and alikes. The
4610 '&' and '^' are not included by default, because these are special for
4611 cmd.exe.
4612
4613 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004614 Each part can be a single character number or a range. A range is two
4615 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 decimal number between 0 and 255 or the ASCII character itself (does
4617 not work for digits). Example:
4618 "_,-,128-140,#-43" (include '_' and '-' and the range
4619 128 to 140 and '#' to 43)
4620 If a part starts with '^', the following character number or range
4621 will be excluded from the option. The option is interpreted from left
4622 to right. Put the excluded character after the range where it is
4623 included. To include '^' itself use it as the last character of the
4624 option or the end of a range. Example:
4625 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4626 If the character is '@', all characters where isalpha() returns TRUE
4627 are included. Normally these are the characters a to z and A to Z,
4628 plus accented characters. To include '@' itself use "@-@". Examples:
4629 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004630 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 "a-z,A-Z,@-@" All letters plus the '@' character.
4632 A comma can be included by using it where a character number is
4633 expected. Example:
4634 "48-57,,,_" Digits, comma and underscore.
4635 A comma can be excluded by prepending a '^'. Example:
4636 " -~,^,,9" All characters from space to '~', excluding
4637 comma, plus <Tab>.
4638 See |option-backslash| about including spaces and backslashes.
4639
4640 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004641'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 "@,48-57,_,128-167,224-235"
4643 otherwise: "@,48-57,_,192-255")
4644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 The characters given by this option are included in identifiers.
4646 Identifiers are used in recognizing environment variables and after a
4647 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004648 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004649 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004651 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4653
4654 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004655'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 "@,48-57,_,128-167,224-235"
4657 otherwise: "@,48-57,_,192-255"
4658 Vi default: "@,48-57,_")
4659 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004661 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004662 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004663 characters above 255 check the "word" character class (any character
4664 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004665 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 For a help file it is set to all non-blank printable characters except
4667 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4668 command).
4669 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004670 This option also influences syntax highlighting, unless the syntax
4671 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 NOTE: This option is set to the Vi default value when 'compatible' is
4673 set and to the Vim default value when 'compatible' is reset.
4674
4675 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004676'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 "@,~-255"; otherwise: "@,161-255")
4678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 The characters given by this option are displayed directly on the
4680 screen. It is also used for "\p" in a |pattern|. The characters from
4681 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4682 even when they are not included in 'isprint' or excluded. See
4683 'isfname' for a description of the format of this option.
4684
4685 Non-printable characters are displayed with two characters:
4686 0 - 31 "^@" - "^_"
4687 32 - 126 always single characters
4688 127 "^?"
4689 128 - 159 "~@" - "~_"
4690 160 - 254 "| " - "|~"
4691 255 "~?"
4692 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4693 displayed as <xx>, with the hexadecimal value of the byte.
4694 When 'display' contains "uhex" all unprintable characters are
4695 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004696 The SpecialKey highlighting will be used for unprintable characters.
4697 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698
4699 Multi-byte characters 256 and above are always included, only the
4700 characters up to 255 are specified with this option. When a character
4701 is printable but it is not available in the current font, a
4702 replacement character will be shown.
4703 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4704 There is no option to specify these characters.
4705
4706 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4707'joinspaces' 'js' boolean (default on)
4708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 Insert two spaces after a '.', '?' and '!' with a join command.
4710 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4711 Otherwise only one space is inserted.
4712 NOTE: This option is set when 'compatible' is set.
4713
4714 *'key'*
4715'key' string (default "")
4716 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004717 {only available when compiled with the |+cryptv|
4718 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004720 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 Careful: Do not set the key value by hand, someone might see the typed
4722 key. Use the |:X| command. But you can make 'key' empty: >
4723 :set key=
4724< It is not possible to get the value of this option with ":set key" or
4725 "echo &key". This is to avoid showing it to someone who shouldn't
4726 know. It also means you cannot see it yourself once you have set it,
4727 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004728 You can use "&key" in an expression to detect whether encryption is
4729 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730
4731 *'keymap'* *'kmp'* *E544*
4732'keymap' 'kmp' string (default "")
4733 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 {only available when compiled with the |+keymap|
4735 feature}
4736 Name of a keyboard mapping. See |mbyte-keymap|.
4737 Setting this option to a valid keymap name has the side effect of
4738 setting 'iminsert' to one, so that the keymap becomes effective.
4739 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004740 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741
4742 *'keymodel'* *'km'*
4743'keymodel' 'km' string (default "")
4744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 List of comma separated words, which enable special things that keys
4746 can do. These values can be used:
4747 startsel Using a shifted special key starts selection (either
4748 Select mode or Visual mode, depending on "key" being
4749 present in 'selectmode').
4750 stopsel Using a not-shifted special key stops selection.
4751 Special keys in this context are the cursor keys, <End>, <Home>,
4752 <PageUp> and <PageDown>.
4753 The 'keymodel' option is set by the |:behave| command.
4754
4755 *'keywordprg'* *'kp'*
4756'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004757 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 Program to use for the |K| command. Environment variables are
4760 expanded |:set_env|. ":help" may be used to access the Vim internal
4761 help. (Note that previously setting the global option to the empty
4762 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004763 When the first character is ":", the command is invoked as a Vim
4764 Ex command prefixed with [count].
4765 When "man", "man -s" or an Ex command is used, Vim will automatically
4766 translate a count for the "K" command and pass it as the first
4767 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 See |option-backslash| about including spaces and backslashes.
4769 Example: >
4770 :set keywordprg=man\ -s
4771< This option cannot be set from a |modeline| or in the |sandbox|, for
4772 security reasons.
4773
4774 *'langmap'* *'lmap'* *E357* *E358*
4775'langmap' 'lmap' string (default "")
4776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 {only available when compiled with the |+langmap|
4778 feature}
4779 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004780 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004781 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 care of translating these special characters to the original meaning
4783 of the key. This means you don't have to change the keyboard mode to
4784 be able to execute Normal mode commands.
4785 This is the opposite of the 'keymap' option, where characters are
4786 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004787 Also consider setting 'langremap' to off, to prevent 'langmap' from
4788 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004789 This option cannot be set from a |modeline| or in the |sandbox|, for
4790 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004792 Example (for Greek, in UTF-8): *greek* >
4793 :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 +00004794< Example (exchanges meaning of z and y for commands): >
4795 :set langmap=zy,yz,ZY,YZ
4796<
4797 The 'langmap' option is a list of parts, separated with commas. Each
4798 part can be in one of two forms:
4799 1. A list of pairs. Each pair is a "from" character immediately
4800 followed by the "to" character. Examples: "aA", "aAbBcC".
4801 2. A list of "from" characters, a semi-colon and a list of "to"
4802 characters. Example: "abc;ABC"
4803 Example: "aA,fgh;FGH,cCdDeE"
4804 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004805 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806
4807 This will allow you to activate vim actions without having to switch
4808 back and forth between the languages. Your language characters will
4809 be understood as normal vim English characters (according to the
4810 langmap mappings) in the following cases:
4811 o Normal/Visual mode (commands, buffer/register names, user mappings)
4812 o Insert/Replace Mode: Register names after CTRL-R
4813 o Insert/Replace Mode: Mappings
4814 Characters entered in Command-line mode will NOT be affected by
4815 this option. Note that this option can be changed at any time
4816 allowing to switch between mappings for different languages/encodings.
4817 Use a mapping to avoid having to type it each time!
4818
4819 *'langmenu'* *'lm'*
4820'langmenu' 'lm' string (default "")
4821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 {only available when compiled with the |+menu| and
4823 |+multi_lang| features}
4824 Language to use for menu translation. Tells which file is loaded
4825 from the "lang" directory in 'runtimepath': >
4826 "lang/menu_" . &langmenu . ".vim"
4827< (without the spaces). For example, to always use the Dutch menus, no
4828 matter what $LANG is set to: >
4829 :set langmenu=nl_NL.ISO_8859-1
4830< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004831 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 If your $LANG is set to a non-English language but you do want to use
4833 the English menus: >
4834 :set langmenu=none
4835< This option must be set before loading menus, switching on filetype
4836 detection or syntax highlighting. Once the menus are defined setting
4837 this option has no effect. But you could do this: >
4838 :source $VIMRUNTIME/delmenu.vim
4839 :set langmenu=de_DE.ISO_8859-1
4840 :source $VIMRUNTIME/menu.vim
4841< Warning: This deletes all menus that you defined yourself!
4842
Bram Moolenaard94464e2015-11-02 15:28:18 +01004843 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004844'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004845 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004846 {only available when compiled with the |+langmap|
4847 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004848 This is just like 'langremap' but with the value inverted. It only
4849 exists for backwards compatibility. When setting 'langremap' then
4850 'langnoremap' is set to the inverted value, and the other way around.
4851
4852 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004853'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004854 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004855 {only available when compiled with the |+langmap|
4856 feature}
4857 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004858 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004859 'langmap' disables some of your mappings, try resetting this option.
4860 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004861 that works for you to avoid mappings to break.
4862
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 *'laststatus'* *'ls'*
4864'laststatus' 'ls' number (default 1)
4865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 The value of this option influences when the last window will have a
4867 status line:
4868 0: never
4869 1: only if there are at least two windows
4870 2: always
4871 The screen looks nicer with a status line if you have several
4872 windows, but it takes another screen line. |status-line|
4873
4874 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4875'lazyredraw' 'lz' boolean (default off)
4876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 When this option is set, the screen will not be redrawn while
4878 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004879 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 update use |:redraw|.
4881
4882 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4883'linebreak' 'lbr' boolean (default off)
4884 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004885 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004887 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 than at the last character that fits on the screen. Unlike
4889 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004890 it only affects the way the file is displayed, not its contents.
4891 If 'breakindent' is set, line is visually indented. Then, the value
4892 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004893 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 Note that <Tab> characters after an <EOL> are mostly not displayed
4895 with the right amount of white space.
4896
4897 *'lines'* *E593*
4898'lines' number (default 24 or terminal height)
4899 global
4900 Number of lines of the Vim window.
4901 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004902 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 When Vim is running in the GUI or in a resizable window, setting this
4904 option will cause the window size to be changed. When you only want
4905 to use the size for the GUI, put the command in your |gvimrc| file.
4906 Vim limits the number of lines to what fits on the screen. You can
4907 use this command to get the tallest window possible: >
4908 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004909< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004910 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 When you set this option and Vim is unable to change the physical
4912 number of lines of the display, the display may be messed up.
4913
4914 *'linespace'* *'lsp'*
4915'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 {only in the GUI}
4918 Number of pixel lines inserted between characters. Useful if the font
4919 uses the full character cell height, making lines touch each other.
4920 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004921 With some fonts there can be too much room between lines (to have
4922 space for ascents and descents). Then it makes sense to set
4923 'linespace' to a negative value. This may cause display problems
4924 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925
4926 *'lisp'* *'nolisp'*
4927'lisp' boolean (default off)
4928 local to buffer
4929 {not available when compiled without the |+lispindent|
4930 feature}
4931 Lisp mode: When <Enter> is typed in insert mode set the indent for
4932 the next line to Lisp standards (well, sort of). Also happens with
4933 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4934 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4935 better. Also see 'lispwords'.
4936 The '-' character is included in keyword characters. Redefines the
4937 "=" operator to use this same indentation algorithm rather than
4938 calling an external program if 'equalprg' is empty.
4939 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940
4941 *'lispwords'* *'lw'*
4942'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004943 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 {not available when compiled without the |+lispindent|
4945 feature}
4946 Comma separated list of words that influence the Lisp indenting.
4947 |'lisp'|
4948
4949 *'list'* *'nolist'*
4950'list' boolean (default off)
4951 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004952 List mode: By default show tabs as CTRL-I is displayed, display $
4953 after end of line. Useful to see the difference between tabs and
4954 spaces and for trailing blanks. Further changed by the 'listchars'
4955 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004956
4957 The cursor is displayed at the start of the space a Tab character
4958 occupies, not at the end as usual in Normal mode. To get this cursor
4959 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004960 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004961<
4962 Note that list mode will also affect formatting (set with 'textwidth'
4963 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 changing the way tabs are displayed.
4965
4966 *'listchars'* *'lcs'*
4967'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004968 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004969 Strings to use in 'list' mode and for the |:list| command. It is a
4970 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004971 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 eol:c Character to show at the end of each line. When
4973 omitted, there is no extra character at the end of the
4974 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004975 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004976 tab:xy[z] Two or three characters to be used to show a tab.
4977 The third character is optional.
4978
4979 tab:xy The 'x' is always used, then 'y' as many times as will
4980 fit. Thus "tab:>-" displays:
4981 >
4982 >-
4983 >--
4984 etc.
4985
4986 tab:xyz The 'z' is always used, then 'x' is prepended, and
4987 then 'y' is used as many times as will fit. Thus
4988 "tab:<->" displays:
4989 >
4990 <>
4991 <->
4992 <-->
4993 etc.
4994
4995 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004996 *lcs-space*
4997 space:c Character to show for a space. When omitted, spaces
4998 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004999 *lcs-multispace*
5000 multispace:c...
5001 One or more characters to use cyclically to show for
5002 multiple consecutive spaces. Overrides the "space"
5003 setting, except for single spaces. When omitted, the
5004 "space" setting is used. For example,
5005 `:set listchars=multispace:---+` shows ten consecutive
5006 spaces as:
5007 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005008 *lcs-lead*
5009 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005010 leading spaces are blank. Overrides the "space" and
5011 "multispace" settings for leading spaces. You can
5012 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005013 :set listchars+=tab:>-,lead:.
5014< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005015 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005016 trailing spaces are blank. Overrides the "space" and
5017 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005018 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 extends:c Character to show in the last column, when 'wrap' is
5020 off and the line continues beyond the right of the
5021 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005022 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005023 precedes:c Character to show in the first visible column of the
5024 physical line, when there is text preceding the
5025 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005026 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005027 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005028 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005029 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005030 nbsp:c Character to show for a non-breakable space character
5031 (0xA0 (160 decimal) and U+202F). Left blank when
5032 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005034 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005036 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005038 Each character can be specified as hex: >
5039 set listchars=eol:\\x24
5040 set listchars=eol:\\u21b5
5041 set listchars=eol:\\U000021b5
5042< Note that a double backslash is used. The number of hex characters
5043 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5044
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 Examples: >
5046 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005047 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 :set lcs=extends:>,precedes:<
5049< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005050 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5051 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005052 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053
5054 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5055'loadplugins' 'lpl' boolean (default on)
5056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057 When on the plugin scripts are loaded when starting up |load-plugins|.
5058 This option can be reset in your |vimrc| file to disable the loading
5059 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005060 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5061 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062
Bram Moolenaard94464e2015-11-02 15:28:18 +01005063 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005064'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005065 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005066 {only available when compiled with the |+lua/dyn|
5067 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005068 Specifies the name of the Lua shared library. The default is
5069 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005070 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005071 This option cannot be set from a |modeline| or in the |sandbox|, for
5072 security reasons.
5073
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005074 *'macatsui'* *'nomacatsui'*
5075'macatsui' boolean (default on)
5076 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005077 {not supported}
5078 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005079
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080 *'magic'* *'nomagic'*
5081'magic' boolean (default on)
5082 global
5083 Changes the special characters that can be used in search patterns.
5084 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005085 WARNING: Switching this option off most likely breaks plugins! That
5086 is because many patterns assume it's on and will fail when it's off.
5087 Only switch it off when working with old Vi scripts. In any other
5088 situation write patterns that work when 'magic' is on. Include "\M"
5089 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005090 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5091 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092
5093 *'makeef'* *'mef'*
5094'makeef' 'mef' string (default: "")
5095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 {not available when compiled without the |+quickfix|
5097 feature}
5098 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5099 and the |:grep| command.
5100 When it is empty, an internally generated temp file will be used.
5101 When "##" is included, it is replaced by a number to make the name
5102 unique. This makes sure that the ":make" command doesn't overwrite an
5103 existing file.
5104 NOT used for the ":cf" command. See 'errorfile' for that.
5105 Environment variables are expanded |:set_env|.
5106 See |option-backslash| about including spaces and backslashes.
5107 This option cannot be set from a |modeline| or in the |sandbox|, for
5108 security reasons.
5109
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005110 *'makeencoding'* *'menc'*
5111'makeencoding' 'menc' string (default "")
5112 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005113 Encoding used for reading the output of external commands. When empty,
5114 encoding is not converted.
5115 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5116 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5117 and `:laddfile`.
5118
5119 This would be mostly useful when you use MS-Windows and set 'encoding'
5120 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5121 'makeencoding' to "char" has the same effect as setting to the system
5122 locale encoding. Example: >
5123 :set encoding=utf-8
5124 :set makeencoding=char " system locale is used
5125<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 *'makeprg'* *'mp'*
5127'makeprg' 'mp' string (default "make", VMS: "MMS")
5128 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005129 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005130 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5131 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005132 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005133 Environment variables are expanded |:set_env|. See |option-backslash|
5134 about including spaces and backslashes.
5135 Note that a '|' must be escaped twice: once for ":set" and once for
5136 the interpretation of a command. When you use a filter called
5137 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 :set makeprg=gmake\ \\\|\ myfilter
5139< The placeholder "$*" can be given (even multiple times) to specify
5140 where the arguments will be included, for example: >
5141 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5142< This option cannot be set from a |modeline| or in the |sandbox|, for
5143 security reasons.
5144
5145 *'matchpairs'* *'mps'*
5146'matchpairs' 'mps' string (default "(:),{:},[:]")
5147 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005149 other.
5150 Only character pairs are allowed that are different, thus you cannot
5151 jump between two double quotes.
5152 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005153 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005154 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 :set mps+=<:>
5156
5157< A more exotic example, to jump between the '=' and ';' in an
5158 assignment, useful for languages like C and Java: >
5159 :au FileType c,cpp,java set mps+==:;
5160
5161< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005162 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163
5164 *'matchtime'* *'mat'*
5165'matchtime' 'mat' number (default 5)
5166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 Tenths of a second to show the matching paren, when 'showmatch' is
5168 set. Note that this is not in milliseconds, like other options that
5169 set a time. This is to be compatible with Nvi.
5170
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005171 *'maxcombine'* *'mco'*
5172'maxcombine' 'mco' number (default 2)
5173 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005174 The maximum number of combining characters supported for displaying.
5175 Only used when 'encoding' is "utf-8".
5176 The default is OK for most languages. Hebrew may require 4.
5177 Maximum value is 6.
5178 Even when this option is set to 2 you can still edit text with more
5179 combining characters, you just can't see them. Use |g8| or |ga|.
5180 See |mbyte-combining|.
5181
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 *'maxfuncdepth'* *'mfd'*
5183'maxfuncdepth' 'mfd' number (default 100)
5184 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005185 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005186 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 Maximum depth of function calls for user functions. This normally
5188 catches endless recursion. When using a recursive function with
5189 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5190 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005191 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005192 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 See also |:function|.
5194
5195 *'maxmapdepth'* *'mmd'* *E223*
5196'maxmapdepth' 'mmd' number (default 1000)
5197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 Maximum number of times a mapping is done without resulting in a
5199 character to be used. This normally catches endless mappings, like
5200 ":map x y" with ":map y x". It still does not catch ":map g wg",
5201 because the 'w' is used before the next mapping is done. See also
5202 |key-mapping|.
5203
5204 *'maxmem'* *'mm'*
5205'maxmem' 'mm' number (default between 256 to 5120 (system
5206 dependent) or half the amount of memory
5207 available)
5208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5210 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005211 other memory to be freed.
5212 The maximum usable value is about 2000000. Use this to work without a
5213 limit.
5214 The value is ignored when 'swapfile' is off.
5215 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005217 *'maxmempattern'* *'mmp'*
5218'maxmempattern' 'mmp' number (default 1000)
5219 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005220 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005221 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005222 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005223 When Vim runs into the limit it gives an error message and mostly
5224 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005225 Running into the limit often means that the pattern is very
5226 inefficient or too complex. This may already happen with the pattern
5227 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005228 Might also happen on redraw, when syntax rules try to match a complex
5229 text structure.
5230 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5231 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005232
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 *'maxmemtot'* *'mmt'*
5234'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5235 dependent) or half the amount of memory
5236 available)
5237 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005238 Maximum amount of memory in Kbyte to use for all buffers together.
5239 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005240 without a limit.
5241 On 64 bit machines higher values might work. But hey, do you really
5242 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005243 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005244 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005245 Buffers with 'swapfile' off still count to the total amount of memory
5246 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005247 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248
5249 *'menuitems'* *'mis'*
5250'menuitems' 'mis' number (default 25)
5251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 {not available when compiled without the |+menu|
5253 feature}
5254 Maximum number of items to use in a menu. Used for menus that are
5255 generated from a list of items, e.g., the Buffers menu. Changing this
5256 option has no direct effect, the menu must be refreshed first.
5257
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005258 *'mkspellmem'* *'msm'*
5259'mkspellmem' 'msm' string (default "460000,2000,500")
5260 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005261 {not available when compiled without the |+syntax|
5262 feature}
5263 Parameters for |:mkspell|. This tunes when to start compressing the
5264 word tree. Compression can be slow when there are many words, but
5265 it's needed to avoid running out of memory. The amount of memory used
5266 per word depends very much on how similar the words are, that's why
5267 this tuning is complicated.
5268
5269 There are three numbers, separated by commas:
5270 {start},{inc},{added}
5271
5272 For most languages the uncompressed word tree fits in memory. {start}
5273 gives the amount of memory in Kbyte that can be used before any
5274 compression is done. It should be a bit smaller than the amount of
5275 memory that is available to Vim.
5276
5277 When going over the {start} limit the {inc} number specifies the
5278 amount of memory in Kbyte that can be allocated before another
5279 compression is done. A low number means compression is done after
5280 less words are added, which is slow. A high number means more memory
5281 will be allocated.
5282
5283 After doing compression, {added} times 1024 words can be added before
5284 the {inc} limit is ignored and compression is done when any extra
5285 amount of memory is needed. A low number means there is a smaller
5286 chance of hitting the {inc} limit, less memory is used but it's
5287 slower.
5288
5289 The languages for which these numbers are important are Italian and
5290 Hungarian. The default works for when you have about 512 Mbyte. If
5291 you have 1 Gbyte you could use: >
5292 :set mkspellmem=900000,3000,800
5293< If you have less than 512 Mbyte |:mkspell| may fail for some
5294 languages, no matter what you set 'mkspellmem' to.
5295
Bram Moolenaar07607392019-05-26 19:20:43 +02005296 This option cannot be set from a |modeline| or in the |sandbox|.
5297
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005299'modeline' 'ml' boolean (Vim default: on (off for root),
5300 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005302 If 'modeline' is on 'modelines' gives the number of lines that is
5303 checked for set commands. If 'modeline' is off or 'modelines' is zero
5304 no lines are checked. See |modeline|.
5305
5306 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5307'modelineexpr' 'mle' boolean (default: off)
5308 global
5309 When on allow some options that are an expression to be set in the
5310 modeline. Check the option for whether it is affected by
5311 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005312 This option cannot be set from a |modeline| or in the |sandbox|, for
5313 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005314
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 *'modelines'* *'mls'*
5316'modelines' 'mls' number (default 5)
5317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 If 'modeline' is on 'modelines' gives the number of lines that is
5319 checked for set commands. If 'modeline' is off or 'modelines' is zero
5320 no lines are checked. See |modeline|.
5321 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5322 set and to the Vim default value when 'compatible' is reset.
5323
5324 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005325 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326'modifiable' 'ma' boolean (default on)
5327 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 When off the buffer contents cannot be changed. The 'fileformat' and
5329 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005330 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331
5332 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5333'modified' 'mod' boolean (default off)
5334 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 When on, the buffer is considered to be modified. This option is set
5336 when:
5337 1. A change was made to the text since it was last written. Using the
5338 |undo| command to go back to the original text will reset the
5339 option. But undoing changes that were made before writing the
5340 buffer will set the option again, since the text is different from
5341 when it was written.
5342 2. 'fileformat' or 'fileencoding' is different from its original
5343 value. The original value is set when the buffer is read or
5344 written. A ":set nomodified" command also resets the original
5345 values to the current values and the 'modified' option will be
5346 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005347 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005348 This option is not set when a change is made to the buffer as the
5349 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5350 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5351 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5353 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005354 Note that the text may actually be the same, e.g. 'modified' is set
5355 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356
5357 *'more'* *'nomore'*
5358'more' boolean (Vim default: on, Vi default: off)
5359 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 When on, listings pause when the whole screen is filled. You will get
5361 the |more-prompt|. When this option is off there are no pauses, the
5362 listing continues until finished.
5363 NOTE: This option is set to the Vi default value when 'compatible' is
5364 set and to the Vim default value when 'compatible' is reset.
5365
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005366 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005367'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005368 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005370 Enable the use of the mouse. Works for most terminals (xterm, Win32
5371 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5372 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5373 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005374 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 v Visual mode
5376 i Insert mode
5377 c Command-line mode
5378 h all previous modes when editing a help file
5379 a all previous modes
5380 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005381 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005383< If your terminal can't overrule the mouse events going to the
5384 application, use: >
5385 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005386< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005387 back to Vim using the mouse events.
5388 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5389 "xterm".
5390
5391 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 modeless selection. This doesn't move the text cursor.
5393
5394 See |mouse-using|. Also see |'clipboard'|.
5395
5396 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005397 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 the mouse buttons can still be used by keeping the shift key pressed.
5399 Also see the 'clipboard' option.
5400
5401 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5402'mousefocus' 'mousef' boolean (default off)
5403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 {only works in the GUI}
5405 The window that the mouse pointer is on is automatically activated.
5406 When changing the window layout or window focus in another way, the
5407 mouse pointer is moved to the window with keyboard focus. Off is the
5408 default because it makes using the pull down menus a little goofy, as
5409 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005410 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005411 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412
5413 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5414'mousehide' 'mh' boolean (default on)
5415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 {only works in the GUI}
5417 When on, the mouse pointer is hidden when characters are typed.
5418 The mouse pointer is restored when the mouse is moved.
5419
5420 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005421'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 Sets the model to use for the mouse. The name mostly specifies what
5424 the right mouse button is used for:
5425 extend Right mouse button extends a selection. This works
5426 like in an xterm.
5427 popup Right mouse button pops up a menu. The shifted left
5428 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005429 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430 popup_setpos Like "popup", but the cursor will be moved to the
5431 position where the mouse was clicked, and thus the
5432 selected operation will act upon the clicked object.
5433 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005434 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 course, that right clicking outside a selection will
5436 end Visual mode.
5437 Overview of what button does what for each model:
5438 mouse extend popup(_setpos) ~
5439 left click place cursor place cursor
5440 left drag start selection start selection
5441 shift-left search word extend selection
5442 right click extend selection popup menu (place cursor)
5443 right drag extend selection -
5444 middle click paste paste
5445
5446 In the "popup" model the right mouse button produces a pop-up menu.
5447 You need to define this first, see |popup-menu|.
5448
5449 Note that you can further refine the meaning of buttons with mappings.
5450 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5451 selection (because that's handled in the GUI code directly).
5452
5453 The 'mousemodel' option is set by the |:behave| command.
5454
5455 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005456'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5457 vs:leftright,vd:lrsizing,m:no,
5458 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 {only available when compiled with the |+mouseshape|
5461 feature}
5462 This option tells Vim what the mouse pointer should look like in
5463 different modes. The option is a comma separated list of parts, much
5464 like used for 'guicursor'. Each part consist of a mode/location-list
5465 and an argument-list:
5466 mode-list:shape,mode-list:shape,..
5467 The mode-list is a dash separated list of these modes/locations:
5468 In a normal window: ~
5469 n Normal mode
5470 v Visual mode
5471 ve Visual mode with 'selection' "exclusive" (same as 'v',
5472 if not specified)
5473 o Operator-pending mode
5474 i Insert mode
5475 r Replace mode
5476
5477 Others: ~
5478 c appending to the command-line
5479 ci inserting in the command-line
5480 cr replacing in the command-line
5481 m at the 'Hit ENTER' or 'More' prompts
5482 ml idem, but cursor in the last line
5483 e any mode, pointer below last window
5484 s any mode, pointer on a status line
5485 sd any mode, while dragging a status line
5486 vs any mode, pointer on a vertical separator line
5487 vd any mode, while dragging a vertical separator line
5488 a everywhere
5489
5490 The shape is one of the following:
5491 avail name looks like ~
5492 w x arrow Normal mouse pointer
5493 w x blank no pointer at all (use with care!)
5494 w x beam I-beam
5495 w x updown up-down sizing arrows
5496 w x leftright left-right sizing arrows
5497 w x busy The system's usual busy pointer
5498 w x no The system's usual 'no input' pointer
5499 x udsizing indicates up-down resizing
5500 x lrsizing indicates left-right resizing
5501 x crosshair like a big thin +
5502 x hand1 black hand
5503 x hand2 white hand
5504 x pencil what you write with
5505 x question big ?
5506 x rightup-arrow arrow pointing right-up
5507 w x up-arrow arrow pointing up
5508 x <number> any X11 pointer number (see X11/cursorfont.h)
5509
5510 The "avail" column contains a 'w' if the shape is available for Win32,
5511 x for X11.
5512 Any modes not specified or shapes not available use the normal mouse
5513 pointer.
5514
5515 Example: >
5516 :set mouseshape=s:udsizing,m:no
5517< will make the mouse turn to a sizing arrow over the status lines and
5518 indicate no input when the hit-enter prompt is displayed (since
5519 clicking the mouse has no effect in this state.)
5520
5521 *'mousetime'* *'mouset'*
5522'mousetime' 'mouset' number (default 500)
5523 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005524 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 time in msec between two mouse clicks for the second click to be
5526 recognized as a multi click.
5527
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005528 *'mzschemedll'*
5529'mzschemedll' string (default depends on the build)
5530 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005531 {only available when compiled with the |+mzscheme/dyn|
5532 feature}
5533 Specifies the name of the MzScheme shared library. The default is
5534 DYNAMIC_MZSCH_DLL which was specified at compile time.
5535 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005536 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005537 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005538 This option cannot be set from a |modeline| or in the |sandbox|, for
5539 security reasons.
5540
5541 *'mzschemegcdll'*
5542'mzschemegcdll' string (default depends on the build)
5543 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005544 {only available when compiled with the |+mzscheme/dyn|
5545 feature}
5546 Specifies the name of the MzScheme GC shared library. The default is
5547 DYNAMIC_MZGC_DLL which was specified at compile time.
5548 The value can be equal to 'mzschemedll' if it includes the GC code.
5549 Environment variables are expanded |:set_env|.
5550 This option cannot be set from a |modeline| or in the |sandbox|, for
5551 security reasons.
5552
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005553 *'mzquantum'* *'mzq'*
5554'mzquantum' 'mzq' number (default 100)
5555 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005556 {not available when compiled without the |+mzscheme|
5557 feature}
5558 The number of milliseconds between polls for MzScheme threads.
5559 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005560 NOTE: This option is set to the Vim default value when 'compatible'
5561 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005562
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005564'nrformats' 'nf' string (default "bin,octal,hex",
5565 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 This defines what bases Vim will consider for numbers when using the
5568 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5569 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005570 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005572 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005573 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005575 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 considered to be hexadecimal. Example: Using CTRL-X on
5577 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005578 bin If included, numbers starting with "0b" or "0B" will be
5579 considered to be binary. Example: Using CTRL-X on
5580 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005581 unsigned If included, numbers are recognized as unsigned. Thus a
5582 leading dash or negative sign won't be considered as part of
5583 the number. Examples:
5584 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5585 (without "unsigned" it would become "9-2021").
5586 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5587 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005588 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5589 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 Numbers which simply begin with a digit in the range 1-9 are always
5591 considered decimal. This also happens for numbers that are not
5592 recognized as octal or hex.
5593
5594 *'number'* *'nu'* *'nonumber'* *'nonu'*
5595'number' 'nu' boolean (default off)
5596 local to window
5597 Print the line number in front of each line. When the 'n' option is
5598 excluded from 'cpoptions' a wrapped line will not use the column of
5599 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005600 The 'numberwidth' option can be used to set the room used for the line
5601 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 When a long, wrapped line doesn't start with the first character, '-'
5603 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005604 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5605 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005606 *number_relativenumber*
5607 The 'relativenumber' option changes the displayed number to be
5608 relative to the cursor. Together with 'number' there are these
5609 four combinations (cursor in line 3):
5610
Bram Moolenaar3848e002016-03-19 18:42:29 +01005611 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005612 'nornu' 'nornu' 'rnu' 'rnu'
5613
5614 |apple | 1 apple | 2 apple | 2 apple
5615 |pear | 2 pear | 1 pear | 1 pear
5616 |nobody | 3 nobody | 0 nobody |3 nobody
5617 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005619 *'numberwidth'* *'nuw'*
5620'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5621 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005622 {only available when compiled with the |+linebreak|
5623 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005624 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005625 when the 'number' or 'relativenumber' option is set or printing lines
5626 with a line number. Since one space is always between the number and
5627 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005628 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005629 fit the highest line number in the buffer respectively the number of
5630 rows in the window, depending on whether 'number' or 'relativenumber'
5631 is set. Thus with the Vim default of 4 there is room for a line number
5632 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005633 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005634 NOTE: This option is set to the Vi default value when 'compatible' is
5635 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005636
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005637 *'omnifunc'* *'ofu'*
5638'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005639 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005640 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005641 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005642 This option specifies a function to be used for Insert mode omni
5643 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005644 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005645 invoked and what it should return. The value can be the name of a
5646 function, a |lambda| or a |Funcref|. See |option-value-function| for
5647 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005648 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005649 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005650 This option cannot be set from a |modeline| or in the |sandbox|, for
5651 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005652
5653
Bram Moolenaar02467872007-05-06 13:22:01 +00005654 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005655'opendevice' 'odev' boolean (default off)
5656 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005657 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005658 Enable reading and writing from devices. This may get Vim stuck on a
5659 device that can be opened but doesn't actually do the I/O. Therefore
5660 it is off by default.
5661 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5662 result in editing a device.
5663
5664
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005665 *'operatorfunc'* *'opfunc'*
5666'operatorfunc' 'opfunc' string (default: empty)
5667 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005668 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005669 See |:map-operator| for more info and an example. The value can be
5670 the name of a function, a |lambda| or a |Funcref|. See
5671 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005672
5673 This option cannot be set from a |modeline| or in the |sandbox|, for
5674 security reasons.
5675
5676
Bram Moolenaar251e1912011-06-19 05:09:16 +02005677 *'osfiletype'* *'oft'*
5678'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005680 This option was supported on RISC OS, which has been removed.
5681
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005683 *'packpath'* *'pp'*
5684'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005685 Directories used to find packages. See |packages|.
5686
5687
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005689'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690 global
5691 Specifies the nroff macros that separate paragraphs. These are pairs
5692 of two letters (see |object-motions|).
5693
5694 *'paste'* *'nopaste'*
5695'paste' boolean (default off)
5696 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005697 Put Vim in Paste mode. This is useful if you want to cut or copy
5698 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 unexpected effects.
5700 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005701 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 knows about pasting and will mostly do the right thing without 'paste'
5703 being set. The same is true for a terminal where Vim handles the
5704 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005705 This option is reset when starting the GUI. Thus if you set it in
5706 your .vimrc it will work in a terminal, but not in the GUI. Setting
5707 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5708 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 When the 'paste' option is switched on (also when it was already on):
5710 - mapping in Insert mode and Command-line mode is disabled
5711 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005713 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005714 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 - 'revins' is reset
5716 - 'ruler' is reset
5717 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005718 - 'smarttab' is reset
5719 - 'softtabstop' is set to 0
5720 - 'textwidth' is set to 0
5721 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005722 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005725 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005726 - 'indentexpr'
5727 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005728 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 NOTE: When you start editing another file while the 'paste' option is
5730 on, settings from the modelines or autocommands may change the
5731 settings again, causing trouble when pasting text. You might want to
5732 set the 'paste' option again.
5733 When the 'paste' option is reset the mentioned options are restored to
5734 the value before the moment 'paste' was switched from off to on.
5735 Resetting 'paste' before ever setting it does not have any effect.
5736 Since mapping doesn't work while 'paste' is active, you need to use
5737 the 'pastetoggle' option to toggle the 'paste' option with some key.
5738
5739 *'pastetoggle'* *'pt'*
5740'pastetoggle' 'pt' string (default "")
5741 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 When non-empty, specifies the key sequence that toggles the 'paste'
5743 option. This is like specifying a mapping: >
5744 :map {keys} :set invpaste<CR>
5745< Where {keys} is the value of 'pastetoggle'.
5746 The difference is that it will work even when 'paste' is set.
5747 'pastetoggle' works in Insert mode and Normal mode, but not in
5748 Command-line mode.
5749 Mappings are checked first, thus overrule 'pastetoggle'. However,
5750 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5751 this: >
5752 :map <F10> :set paste<CR>
5753 :map <F11> :set nopaste<CR>
5754 :imap <F10> <C-O>:set paste<CR>
5755 :imap <F11> <nop>
5756 :set pastetoggle=<F11>
5757< This will make <F10> start paste mode and <F11> stop paste mode.
5758 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5759 mode everything is inserted literally, except the 'pastetoggle' key
5760 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005761 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762
5763 *'pex'* *'patchexpr'*
5764'patchexpr' 'pex' string (default "")
5765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 {not available when compiled without the |+diff|
5767 feature}
5768 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005769 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770
Bram Moolenaardbc28022014-07-26 13:40:44 +02005771 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772'patchmode' 'pm' string (default "")
5773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 When non-empty the oldest version of a file is kept. This can be used
5775 to keep the original version of a file if you are changing files in a
5776 source distribution. Only the first time that a file is written a
5777 copy of the original file will be kept. The name of the copy is the
5778 name of the original file with the string in the 'patchmode' option
5779 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005780 ".orig" or ".org". 'backupdir' must not be empty for this to work
5781 (Detail: The backup file is renamed to the patchmode file after the
5782 new file has been successfully written, that's why it must be possible
5783 to write a backup file). If there was no file to be backed up, an
5784 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 When the 'backupskip' pattern matches, a patchmode file is not made.
5786 Using 'patchmode' for compressed files appends the extension at the
5787 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5788 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005789 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005791 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 other systems: ".,,")
5794 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005796 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5797 provided that the file being searched for has a relative path (not
5798 starting with "/", "./" or "../"). The directories in the 'path'
5799 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 - Use commas to separate directory names: >
5801 :set path=.,/usr/local/include,/usr/include
5802< - Spaces can also be used to separate directory names (for backwards
5803 compatibility with version 3.0). To have a space in a directory
5804 name, precede it with an extra backslash, and escape the space: >
5805 :set path=.,/dir/with\\\ space
5806< - To include a comma in a directory name precede it with an extra
5807 backslash: >
5808 :set path=.,/dir/with\\,comma
5809< - To search relative to the directory of the current file, use: >
5810 :set path=.
5811< - To search in the current directory use an empty string between two
5812 commas: >
5813 :set path=,,
5814< - A directory name may end in a ':' or '/'.
5815 - Environment variables are expanded |:set_env|.
5816 - When using |netrw.vim| URLs can be used. For example, adding
5817 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005818 - Search upwards and downwards in a directory tree using "*", "**" and
5819 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 {not available when compiled without the |+path_extra| feature}
5821 - Careful with '\' characters, type two to get one in the option: >
5822 :set path=.,c:\\include
5823< Or just use '/' instead: >
5824 :set path=.,c:/include
5825< Don't forget "." or files won't even be found in the same directory as
5826 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005827 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 it is something like 256 or 1024 characters.
5829 You can check if all the include files are found, using the value of
5830 'path', see |:checkpath|.
5831 The use of |:set+=| and |:set-=| is preferred when adding or removing
5832 directories from the list. This avoids problems when a future version
5833 uses another default. To remove the current directory use: >
5834 :set path-=
5835< To add the current directory use: >
5836 :set path+=
5837< To use an environment variable, you probably need to replace the
5838 separator. Here is an example to append $INCL, in which directory
5839 names are separated with a semi-colon: >
5840 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5841< Replace the ';' with a ':' or whatever separator is used. Note that
5842 this doesn't work when $INCL contains a comma or white space.
5843
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005844 *'perldll'*
5845'perldll' string (default depends on the build)
5846 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005847 {only available when compiled with the |+perl/dyn|
5848 feature}
5849 Specifies the name of the Perl shared library. The default is
5850 DYNAMIC_PERL_DLL, which was specified at compile time.
5851 Environment variables are expanded |:set_env|.
5852 This option cannot be set from a |modeline| or in the |sandbox|, for
5853 security reasons.
5854
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5856'preserveindent' 'pi' boolean (default off)
5857 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005858 When changing the indent of the current line, preserve as much of the
5859 indent structure as possible. Normally the indent is replaced by a
5860 series of tabs followed by spaces as required (unless |'expandtab'| is
5861 enabled, in which case only spaces are used). Enabling this option
5862 means the indent will preserve as many existing characters as possible
5863 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005864 'expandtab' does not apply to the preserved white space, a Tab remains
5865 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 NOTE: When using ">>" multiple times the resulting indent is a mix of
5867 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005868 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 Also see 'copyindent'.
5870 Use |:retab| to clean up white space.
5871
5872 *'previewheight'* *'pvh'*
5873'previewheight' 'pvh' number (default 12)
5874 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005875 {not available when compiled without the |+quickfix|
5876 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005878 commands. Used for |CTRL-W_}| when no count is given. Not used when
5879 'previewpopup' is set.
5880
5881 *'previewpopup'* *'pvp'*
5882'previewpopup' 'pvp' string (default empty)
5883 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005884 {not available when compiled without the |+textprop|
5885 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005886 When not empty a popup window is used for commands that would open a
5887 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005888 Not used for the insert completion info, add "popup" to
5889 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890
5891 *'previewwindow'* *'nopreviewwindow'*
5892 *'pvw'* *'nopvw'* *E590*
5893'previewwindow' 'pvw' boolean (default off)
5894 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005895 {not available when compiled without the |+quickfix|
5896 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005897 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898 set. It's normally not set directly, but by using one of the commands
5899 |:ptag|, |:pedit|, etc.
5900
5901 *'printdevice'* *'pdev'*
5902'printdevice' 'pdev' string (default empty)
5903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 {only available when compiled with the |+printer|
5905 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005906 The name of the printer to be used for |:hardcopy|.
5907 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005908 This option cannot be set from a |modeline| or in the |sandbox|, for
5909 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910
Bram Moolenaar8299df92004-07-10 09:47:34 +00005911 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005912'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 {only available when compiled with the |+printer|
5915 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005916 Sets the character encoding used when printing.
5917 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918
5919 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005920'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 {only available when compiled with the |+printer|
5923 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005924 Expression used to print the PostScript produced with |:hardcopy|.
5925 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005926 This option cannot be set from a |modeline| or in the |sandbox|, for
5927 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928
Bram Moolenaar8299df92004-07-10 09:47:34 +00005929 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930'printfont' 'pfn' string (default "courier")
5931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932 {only available when compiled with the |+printer|
5933 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005934 The name of the font that will be used for |:hardcopy|.
5935 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005936
5937 *'printheader'* *'pheader'*
5938'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940 {only available when compiled with the |+printer|
5941 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005942 The format of the header produced in |:hardcopy| output.
5943 See |pheader-option|.
5944
5945 *'printmbcharset'* *'pmbcs'*
5946'printmbcharset' 'pmbcs' string (default "")
5947 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005948 {only available when compiled with the |+printer|
5949 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005950 The CJK character set to be used for CJK output from |:hardcopy|.
5951 See |pmbcs-option|.
5952
5953 *'printmbfont'* *'pmbfn'*
5954'printmbfont' 'pmbfn' string (default "")
5955 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005956 {only available when compiled with the |+printer|
5957 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005958 List of font names to be used for CJK output from |:hardcopy|.
5959 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960
5961 *'printoptions'* *'popt'*
5962'printoptions' 'popt' string (default "")
5963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005965 List of items that control the format of the output of |:hardcopy|.
5966 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005968 *'prompt'* *'noprompt'*
5969'prompt' boolean (default on)
5970 global
5971 When on a ":" prompt is used in Ex mode.
5972
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005973 *'pumheight'* *'ph'*
5974'pumheight' 'ph' number (default 0)
5975 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005976 Determines the maximum number of items to show in the popup menu for
5977 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005978 |ins-completion-menu|.
5979
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005980 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005981'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005982 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005983 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005984 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005985
Bram Moolenaard94464e2015-11-02 15:28:18 +01005986 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005987'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005988 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005989 {only available when compiled with the |+python/dyn|
5990 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005991 Specifies the name of the Python 2.x shared library. The default is
5992 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005993 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005994 This option cannot be set from a |modeline| or in the |sandbox|, for
5995 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005996
Bram Moolenaar94073162018-01-31 21:49:05 +01005997 *'pythonhome'*
5998'pythonhome' string (default "")
5999 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006000 {only available when compiled with the |+python/dyn|
6001 feature}
6002 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6003 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6004 which was specified at compile time, will be used for the Python 2.x
6005 home directory.
6006 Environment variables are expanded |:set_env|.
6007 This option cannot be set from a |modeline| or in the |sandbox|, for
6008 security reasons.
6009
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006010 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006011'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006012 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006013 {only available when compiled with the |+python3/dyn|
6014 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006015 Specifies the name of the Python 3 shared library. The default is
6016 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006017 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006018 This option cannot be set from a |modeline| or in the |sandbox|, for
6019 security reasons.
6020
Bram Moolenaar94073162018-01-31 21:49:05 +01006021 *'pythonthreehome'*
6022'pythonthreehome' string (default "")
6023 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006024 {only available when compiled with the |+python3/dyn|
6025 feature}
6026 Specifies the name of the Python 3 home directory. When
6027 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6028 PYTHON3_HOME, which was specified at compile time, will be used for
6029 the Python 3 home directory.
6030 Environment variables are expanded |:set_env|.
6031 This option cannot be set from a |modeline| or in the |sandbox|, for
6032 security reasons.
6033
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006034 *'pyxversion'* *'pyx'*
6035'pyxversion' 'pyx' number (default depends on the build)
6036 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006037 {only available when compiled with the |+python| or
6038 the |+python3| feature}
6039 Specifies the python version used for pyx* functions and commands
6040 |python_x|. The default value is as follows:
6041
6042 Compiled with Default ~
6043 |+python| and |+python3| 0
6044 only |+python| 2
6045 only |+python3| 3
6046
6047 Available values are 0, 2 and 3.
6048 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6049 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6050 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6051 to 2 if Python 2 is available.
6052 See also: |has-pythonx|
6053
6054 If Vim is compiled with only |+python| or |+python3| setting
6055 'pyxversion' has no effect. The pyx* functions and commands are
6056 always the same as the compiled version.
6057
6058 This option cannot be set from a |modeline| or in the |sandbox|, for
6059 security reasons.
6060
Bram Moolenaar858ba062020-05-31 23:11:59 +02006061 *'quickfixtextfunc'* *'qftf'*
6062'quickfixtextfunc' 'qftf' string (default "")
6063 global
6064 {only available when compiled with the |+quickfix|
6065 feature}
6066 This option specifies a function to be used to get the text to display
6067 in the quickfix and location list windows. This can be used to
6068 customize the information displayed in the quickfix or location window
6069 for each entry in the corresponding quickfix or location list. See
6070 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006071 function and an example. The value can be the name of a function, a
6072 |lambda| or a |Funcref|. See |option-value-function| for more
6073 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006074
6075 This option cannot be set from a |modeline| or in the |sandbox|, for
6076 security reasons.
6077
Bram Moolenaar677ee682005-01-27 14:41:15 +00006078 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006079'quoteescape' 'qe' string (default "\")
6080 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006081 The characters that are used to escape quotes in a string. Used for
6082 objects like a', a" and a` |a'|.
6083 When one of the characters in this option is found inside a string,
6084 the following character will be skipped. The default value makes the
6085 text "foo\"bar\\" considered to be one string.
6086
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6088'readonly' 'ro' boolean (default off)
6089 local to buffer
6090 If on, writes fail unless you use a '!'. Protects you from
6091 accidentally overwriting a file. Default on when Vim is started
6092 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006093 When using ":w!" the 'readonly' option is reset for the current
6094 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006095 When using the ":view" command the 'readonly' option is set for the
6096 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006097 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006099 *'redrawtime'* *'rdt'*
6100'redrawtime' 'rdt' number (default 2000)
6101 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006102 {only available when compiled with the |+reltime|
6103 feature}
6104 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006105 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006106 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006107 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006108 matches will be highlighted.
6109 For syntax highlighting the time applies per window. When over the
6110 limit syntax highlighting is disabled until |CTRL-L| is used.
6111 This is used to avoid that Vim hangs when using a very complicated
6112 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006113
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006114 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006115'regexpengine' 're' number (default 0)
6116 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006117 This selects the default regexp engine. |two-engines|
6118 The possible values are:
6119 0 automatic selection
6120 1 old engine
6121 2 NFA engine
6122 Note that when using the NFA engine and the pattern contains something
6123 that is not supported the pattern will not match. This is only useful
6124 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006125 Using automatic selection enables Vim to switch the engine, if the
6126 default engine becomes too costly. E.g., when the NFA engine uses too
6127 many states. This should prevent Vim from hanging on a combination of
6128 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006129
Bram Moolenaar64486672010-05-16 15:46:46 +02006130 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6131'relativenumber' 'rnu' boolean (default off)
6132 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006133 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006134 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006135 precede some vertical motion commands (e.g. j k + -) with, without
6136 having to calculate it yourself. Especially useful in combination with
6137 other commands (e.g. y d c < > gq gw =).
6138 When the 'n' option is excluded from 'cpoptions' a wrapped
6139 line will not use the column of line numbers (this is the default when
6140 'compatible' isn't set).
6141 The 'numberwidth' option can be used to set the room used for the line
6142 number.
6143 When a long, wrapped line doesn't start with the first character, '-'
6144 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006145 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6146 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006147
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006148 The number in front of the cursor line also depends on the value of
6149 'number', see |number_relativenumber| for all combinations of the two
6150 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006151
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 *'remap'* *'noremap'*
6153'remap' boolean (default on)
6154 global
6155 Allows for mappings to work recursively. If you do not want this for
6156 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006157 NOTE: To avoid portability problems with Vim scripts, always keep
6158 this option at the default "on". Only switch it off when working with
6159 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006161 *'renderoptions'* *'rop'*
6162'renderoptions' 'rop' string (default: empty)
6163 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006164 {only available when compiled with GUI and DIRECTX on
6165 MS-Windows}
6166 Select a text renderer and set its options. The options depend on the
6167 renderer.
6168
6169 Syntax: >
6170 set rop=type:{renderer}(,{name}:{value})*
6171<
6172 Currently, only one optional renderer is available.
6173
6174 render behavior ~
6175 directx Vim will draw text using DirectX (DirectWrite). It makes
6176 drawn glyphs more beautiful than default GDI.
6177 It requires 'encoding' is "utf-8", and only works on
6178 MS-Windows Vista or newer version.
6179
6180 Options:
6181 name meaning type value ~
6182 gamma gamma float 1.0 - 2.2 (maybe)
6183 contrast enhancedContrast float (unknown)
6184 level clearTypeLevel float (unknown)
6185 geom pixelGeometry int 0 - 2 (see below)
6186 renmode renderingMode int 0 - 6 (see below)
6187 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006188 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006189
Bram Moolenaar92467d32017-12-05 13:22:16 +01006190 See this URL for detail (except for scrlines):
6191 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006192
6193 For geom: structure of a device pixel.
6194 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6195 1 - DWRITE_PIXEL_GEOMETRY_RGB
6196 2 - DWRITE_PIXEL_GEOMETRY_BGR
6197
6198 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006199 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006200
6201 For renmode: method of rendering glyphs.
6202 0 - DWRITE_RENDERING_MODE_DEFAULT
6203 1 - DWRITE_RENDERING_MODE_ALIASED
6204 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6205 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6206 4 - DWRITE_RENDERING_MODE_NATURAL
6207 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6208 6 - DWRITE_RENDERING_MODE_OUTLINE
6209
6210 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006211 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006212
6213 For taamode: antialiasing mode used for drawing text.
6214 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6215 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6216 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6217 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6218
6219 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006220 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6221
Bram Moolenaara338adc2018-01-31 20:51:47 +01006222 For scrlines:
6223 This was used for optimizing scrolling behavior, however this
6224 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006225
6226 Example: >
6227 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006228 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006229 set rop=type:directx
6230<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006231 If select a raster font (Courier, Terminal or FixedSys which
6232 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006233 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006234
6235 NOTE: It is known that some fonts and options combination
6236 causes trouble on drawing glyphs.
6237
Bram Moolenaar92467d32017-12-05 13:22:16 +01006238 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006239 special made fonts (True-Type fonts which includes only
6240 bitmap glyphs).
6241 - 'taamode:3' will not work with some vector fonts.
6242
6243 NOTE: With this option, you can display colored emoji
6244 (emoticon) in Windows 8.1 or later. To display colored emoji,
6245 there are some conditions which you should notice.
6246
6247 - If your font includes non-colored emoji already, it will
6248 be used.
6249 - If your font doesn't have emoji, the system chooses an
6250 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6251 will be used.
6252 - When this alternative font didn't have fixed width glyph,
6253 emoji might be rendered beyond the bounding box of drawing
6254 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006255
6256 Other render types are currently not supported.
6257
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 *'report'*
6259'report' number (default 2)
6260 global
6261 Threshold for reporting number of lines changed. When the number of
6262 changed lines is more than 'report' a message will be given for most
6263 ":" commands. If you want it always, set 'report' to 0.
6264 For the ":substitute" command the number of substitutions is used
6265 instead of the number of lines.
6266
6267 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6268'restorescreen' 'rs' boolean (default on)
6269 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006270 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 When set, the screen contents is restored when exiting Vim. This also
6272 happens when executing external commands.
6273
6274 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6275 options in your .vimrc. To disable restoring:
6276 set t_ti= t_te=
6277 To enable restoring (for an xterm):
6278 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6279 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6280
6281 *'revins'* *'ri'* *'norevins'* *'nori'*
6282'revins' 'ri' boolean (default off)
6283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 {only available when compiled with the |+rightleft|
6285 feature}
6286 Inserting characters in Insert mode will work backwards. See "typing
6287 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6288 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006289 NOTE: This option is reset when 'compatible' is set.
6290 This option is reset when 'paste' is set and restored when 'paste' is
6291 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292
6293 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6294'rightleft' 'rl' boolean (default off)
6295 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296 {only available when compiled with the |+rightleft|
6297 feature}
6298 When on, display orientation becomes right-to-left, i.e., characters
6299 that are stored in the file appear from the right to the left.
6300 Using this option, it is possible to edit files for languages that
6301 are written from the right to the left such as Hebrew and Arabic.
6302 This option is per window, so it is possible to edit mixed files
6303 simultaneously, or to view the same file in both ways (this is
6304 useful whenever you have a mixed text file with both right-to-left
6305 and left-to-right strings so that both sets are displayed properly
6306 in different windows). Also see |rileft.txt|.
6307
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006308 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309'rightleftcmd' 'rlc' string (default "search")
6310 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 {only available when compiled with the |+rightleft|
6312 feature}
6313 Each word in this option enables the command line editing to work in
6314 right-to-left mode for a group of commands:
6315
6316 search "/" and "?" commands
6317
6318 This is useful for languages such as Hebrew, Arabic and Farsi.
6319 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6320
Bram Moolenaard94464e2015-11-02 15:28:18 +01006321 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006322'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006323 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006324 {only available when compiled with the |+ruby/dyn|
6325 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006326 Specifies the name of the Ruby shared library. The default is
6327 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006328 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006329 This option cannot be set from a |modeline| or in the |sandbox|, for
6330 security reasons.
6331
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006333'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 {not available when compiled without the
6336 |+cmdline_info| feature}
6337 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006338 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 text in the file is shown on the far right:
6340 Top first line is visible
6341 Bot last line is visible
6342 All first and last line are visible
6343 45% relative position in the file
6344 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006345 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006347 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 this option takes precedence over 'ruler' and 'rulerformat'
6349 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006350 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 the text column (byte number) and the screen column are shown,
6352 separated with a dash.
6353 For an empty line "0-1" is shown.
6354 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006355 This option is reset when 'paste' is set and restored when 'paste' is
6356 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 If you don't want to see the ruler all the time but want to know where
6358 you are, use "g CTRL-G" |g_CTRL-G|.
6359 NOTE: This option is reset when 'compatible' is set.
6360
6361 *'rulerformat'* *'ruf'*
6362'rulerformat' 'ruf' string (default empty)
6363 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 {not available when compiled without the |+statusline|
6365 feature}
6366 When this option is not empty, it determines the content of the ruler
6367 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006368 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006369 This option cannot be set in a modeline when 'modelineexpr' is off.
6370
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 The default ruler width is 17 characters. To make the ruler 15
6372 characters wide, put "%15(" at the start and "%)" at the end.
6373 Example: >
6374 :set rulerformat=%15(%c%V\ %p%%%)
6375<
6376 *'runtimepath'* *'rtp'* *vimfiles*
6377'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006378 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 $VIM/vimfiles,
6380 $VIMRUNTIME,
6381 $VIM/vimfiles/after,
6382 $HOME/.vim/after"
6383 Amiga: "home:vimfiles,
6384 $VIM/vimfiles,
6385 $VIMRUNTIME,
6386 $VIM/vimfiles/after,
6387 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006388 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 $VIM/vimfiles,
6390 $VIMRUNTIME,
6391 $VIM/vimfiles/after,
6392 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006393 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 $VIMRUNTIME,
6395 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006396 Haiku: "$BE_USER_SETTINGS/vim,
6397 $VIM/vimfiles,
6398 $VIMRUNTIME,
6399 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006400 $BE_USER_SETTINGS/vim/after"
6401 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 $VIM/vimfiles,
6403 $VIMRUNTIME,
6404 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006405 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 This is a list of directories which will be searched for runtime
6408 files:
6409 filetype.vim filetypes by file name |new-filetype|
6410 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006411 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 colors/ color scheme files |:colorscheme|
6413 compiler/ compiler files |:compiler|
6414 doc/ documentation |write-local-help|
6415 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006416 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 indent/ indent scripts |indent-expression|
6418 keymap/ key mapping files |mbyte-keymap|
6419 lang/ menu translations |:menutrans|
6420 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006421 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 plugin/ plugin scripts |write-plugin|
6423 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006424 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 syntax/ syntax files |mysyntaxfile|
6426 tutor/ files for vimtutor |tutor|
6427
6428 And any other file searched for with the |:runtime| command.
6429
6430 The defaults for most systems are setup to search five locations:
6431 1. In your home directory, for your personal preferences.
6432 2. In a system-wide Vim directory, for preferences from the system
6433 administrator.
6434 3. In $VIMRUNTIME, for files distributed with Vim.
6435 *after-directory*
6436 4. In the "after" directory in the system-wide Vim directory. This is
6437 for the system administrator to overrule or add to the distributed
6438 defaults (rarely needed)
6439 5. In the "after" directory in your home directory. This is for
6440 personal preferences to overrule or add to the distributed defaults
6441 or system-wide settings (rarely needed).
6442
Bram Moolenaard0796902016-09-16 20:02:31 +02006443 More entries are added when using |packages|. If it gets very long
6444 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6445 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006446
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6448 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006449 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 wildcards.
6451 See |:runtime|.
6452 Example: >
6453 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6454< This will use the directory "~/vimruntime" first (containing your
6455 personal Vim runtime files), then "/mygroup/vim" (shared between a
6456 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6457 files).
6458 You probably should always include $VIMRUNTIME somewhere, to use the
6459 distributed runtime files. You can put a directory before $VIMRUNTIME
6460 to find files which replace a distributed runtime files. You can put
6461 a directory after $VIMRUNTIME to find files which add to distributed
6462 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006463 When Vim is started with |--clean| the home directory entries are not
6464 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 This option cannot be set from a |modeline| or in the |sandbox|, for
6466 security reasons.
6467
6468 *'scroll'* *'scr'*
6469'scroll' 'scr' number (default: half the window height)
6470 local to window
6471 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6472 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006473 changes. This may happen when enabling the |status-line| or
6474 'tabline' option after setting the 'scroll' option.
6475 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006476 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006477 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478
6479 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6480'scrollbind' 'scb' boolean (default off)
6481 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 See also |scroll-binding|. When this option is set, the current
6483 window scrolls as other scrollbind windows (windows that also have
6484 this option set) scroll. This option is useful for viewing the
6485 differences between two versions of a file, see 'diff'.
6486 See |'scrollopt'| for options that determine how this option should be
6487 interpreted.
6488 This option is mostly reset when splitting a window to edit another
6489 file. This means that ":split | edit file" results in two windows
6490 with scroll-binding, but ":split file" does not.
6491
Bram Moolenaarae20f342019-11-05 21:09:23 +01006492 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6493'scrollfocus' 'scf' boolean (default off)
6494 global
6495 {only for MS-Windows GUI}
6496 When using the scroll wheel and this option is set, the window under
6497 the mouse pointer is scrolled. With this option off the current
6498 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006499 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006500
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 *'scrolljump'* *'sj'*
6502'scrolljump' 'sj' number (default 1)
6503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 Minimal number of lines to scroll when the cursor gets off the
6505 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6506 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006507 When set to a negative number from -1 to -100 this is used as the
6508 percentage of the window height. Thus -50 scrolls half the window
6509 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 NOTE: This option is set to 1 when 'compatible' is set.
6511
6512 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006513'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006514 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 Minimal number of screen lines to keep above and below the cursor.
6516 This will make some context visible around where you are working. If
6517 you set it to a very large value (999) the cursor line will always be
6518 in the middle of the window (except at the start or end of the file or
6519 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006520 After using the local value, go back the global value with one of
6521 these two: >
6522 setlocal scrolloff<
6523 setlocal scrolloff=-1
6524< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 NOTE: This option is set to 0 when 'compatible' is set.
6526
6527 *'scrollopt'* *'sbo'*
6528'scrollopt' 'sbo' string (default "ver,jump")
6529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006531 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6532 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 The following words are available:
6534 ver Bind vertical scrolling for 'scrollbind' windows
6535 hor Bind horizontal scrolling for 'scrollbind' windows
6536 jump Applies to the offset between two windows for vertical
6537 scrolling. This offset is the difference in the first
6538 displayed line of the bound windows. When moving
6539 around in a window, another 'scrollbind' window may
6540 reach a position before the start or after the end of
6541 the buffer. The offset is not changed though, when
6542 moving back the 'scrollbind' window will try to scroll
6543 to the desired position when possible.
6544 When now making that window the current one, two
6545 things can be done with the relative offset:
6546 1. When "jump" is not included, the relative offset is
6547 adjusted for the scroll position in the new current
6548 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006549 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 2. When "jump" is included, the other windows are
6551 scrolled to keep the same relative offset. When
6552 going back to the other window, it still uses the
6553 same relative offset.
6554 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006555 When 'diff' mode is active there always is vertical scroll binding,
6556 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557
6558 *'sections'* *'sect'*
6559'sections' 'sect' string (default "SHNHH HUnhsh")
6560 global
6561 Specifies the nroff macros that separate sections. These are pairs of
6562 two letters (See |object-motions|). The default makes a section start
6563 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6564
6565 *'secure'* *'nosecure'* *E523*
6566'secure' boolean (default off)
6567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 When on, ":autocmd", shell and write commands are not allowed in
6569 ".vimrc" and ".exrc" in the current directory and map commands are
6570 displayed. Switch it off only if you know that you will not run into
6571 problems, or when the 'exrc' option is off. On Unix this option is
6572 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006573 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 'secure' at the end of your ~/.vimrc then.
6575 This option cannot be set from a |modeline| or in the |sandbox|, for
6576 security reasons.
6577
6578 *'selection'* *'sel'*
6579'selection' 'sel' string (default "inclusive")
6580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 This option defines the behavior of the selection. It is only used
6582 in Visual and Select mode.
6583 Possible values:
6584 value past line inclusive ~
6585 old no yes
6586 inclusive yes yes
6587 exclusive yes no
6588 "past line" means that the cursor is allowed to be positioned one
6589 character past the line.
6590 "inclusive" means that the last character of the selection is included
6591 in an operation. For example, when "x" is used to delete the
6592 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006593 When "old" is used and 'virtualedit' allows the cursor to move past
6594 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 Note that when "exclusive" is used and selecting from the end
6596 backwards, you cannot include the last character of a line, when
6597 starting in Normal mode and 'virtualedit' empty.
6598
6599 The 'selection' option is set by the |:behave| command.
6600
6601 *'selectmode'* *'slm'*
6602'selectmode' 'slm' string (default "")
6603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 This is a comma separated list of words, which specifies when to start
6605 Select mode instead of Visual mode, when a selection is started.
6606 Possible values:
6607 mouse when using the mouse
6608 key when using shifted special keys
6609 cmd when using "v", "V" or CTRL-V
6610 See |Select-mode|.
6611 The 'selectmode' option is set by the |:behave| command.
6612
6613 *'sessionoptions'* *'ssop'*
6614'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006615 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006617 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 feature}
6619 Changes the effect of the |:mksession| command. It is a comma
6620 separated list of words. Each word enables saving and restoring
6621 something:
6622 word save and restore ~
6623 blank empty windows
6624 buffers hidden and unloaded buffers, not just those in windows
6625 curdir the current directory
6626 folds manually created folds, opened/closed folds and local
6627 fold options
6628 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006629 and contain at least one lowercase letter. Only
6630 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 help the help window
6632 localoptions options and mappings local to a window or buffer (not
6633 global values for local options)
6634 options all options and mappings (also global values for local
6635 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006636 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 resize size of the Vim window: 'lines' and 'columns'
6638 sesdir the directory in which the session file is located
6639 will become the current directory (useful with
6640 projects accessed over a network from different
6641 systems)
6642 slash backslashes in file names replaced with forward
6643 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006644 tabpages all tab pages; without this only the current tab page
6645 is restored, so that you can make a session for each
6646 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006647 terminal include terminal windows where the command can be
6648 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 unix with Unix end-of-line format (single <NL>), even when
6650 on Windows or DOS
6651 winpos position of the whole Vim window
6652 winsize window sizes
6653
6654 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006655 When neither "curdir" nor "sesdir" is included, file names are stored
6656 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 "slash" and "unix" are useful on Windows when sharing session files
6658 with Unix. The Unix version of Vim cannot source dos format scripts,
6659 but the Windows version of Vim can source unix format scripts.
6660
6661 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006662'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 global
6664 Name of the shell to use for ! and :! commands. When changing the
6665 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6666 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006667 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 See |option-backslash| about including spaces and backslashes.
6669 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006670
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006671 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006672 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6674< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006675 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006677 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006679 Example with escaped space (Vim will do this when initializing the
6680 option from $SHELL): >
6681 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006682< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006683 backslashes are consumed by `:set`.
6684
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 Under MS-Windows, when the executable ends in ".com" it must be
6686 included. Thus setting the shell to "command.com" or "4dos.com"
6687 works, but "command" and "4dos" do not work for all commands (e.g.,
6688 filtering).
6689 For unknown reasons, when using "4dos.com" the current directory is
6690 changed to "C:\". To avoid this set 'shell' like this: >
6691 :set shell=command.com\ /c\ 4dos
6692< This option cannot be set from a |modeline| or in the |sandbox|, for
6693 security reasons.
6694
6695 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006696'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006697 Win32, when 'shell' contains "powershell":
6698 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006699 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006702 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6703 For MS-Windows, the default is set according to the value of 'shell',
6704 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006705 On Unix it can have more than one flag. Each white space separated
6706 part is passed as an argument to the shell command.
6707 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006708 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 This option cannot be set from a |modeline| or in the |sandbox|, for
6710 security reasons.
6711
6712 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006713'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6714 "2>&1| tee", or
6715 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 {not available when compiled without the |+quickfix|
6718 feature}
6719 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006720 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 including spaces and backslashes.
6722 The name of the temporary file can be represented by "%s" if necessary
6723 (the file name is appended automatically if no %s appears in the value
6724 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006725 For the Amiga the default is ">". For MS-Windows using powershell the
6726 default is "2>&1 | Out-File -Encoding default", otherwise the default
6727 is ">%s 2>&1". The output is directly saved in a file and not echoed
6728 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006729 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 in a file and echoed to the screen. If the 'shell' option is "csh" or
6731 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006732 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006733 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6734 means that stderr is also included. Before using the 'shell' option a
6735 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006736 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6737 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 The initialization of this option is done after reading the ".vimrc"
6739 and the other initializations, so that when the 'shell' option is set
6740 there, the 'shellpipe' option changes automatically, unless it was
6741 explicitly set before.
6742 When 'shellpipe' is set to an empty string, no redirection of the
6743 ":make" output will be done. This is useful if you use a 'makeprg'
6744 that writes to 'makeef' by itself. If you want no piping, but do
6745 want to include the 'makeef', set 'shellpipe' to a single space.
6746 Don't forget to precede the space with a backslash: ":set sp=\ ".
6747 In the future pipes may be used for filtering and this option will
6748 become obsolete (at least for Unix).
6749 This option cannot be set from a |modeline| or in the |sandbox|, for
6750 security reasons.
6751
6752 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006753'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 Quoting character(s), put around the command passed to the shell, for
6756 the "!" and ":!" commands. The redirection is kept outside of the
6757 quoting. See 'shellxquote' to include the redirection. It's
6758 probably not useful to set both options.
6759 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006760 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006761 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 This option cannot be set from a |modeline| or in the |sandbox|, for
6763 security reasons.
6764
6765 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006766'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6767 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 String to be used to put the output of a filter command in a temporary
6770 file. See also |:!|. See |option-backslash| about including spaces
6771 and backslashes.
6772 The name of the temporary file can be represented by "%s" if necessary
6773 (the file name is appended automatically if no %s appears in the value
6774 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006775 The default is ">". For Unix, if the 'shell' option is "csh" or
6776 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006777 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006778 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6779 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006780 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6781 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006782 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6783 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 The initialization of this option is done after reading the ".vimrc"
6785 and the other initializations, so that when the 'shell' option is set
6786 there, the 'shellredir' option changes automatically unless it was
6787 explicitly set before.
6788 In the future pipes may be used for filtering and this option will
6789 become obsolete (at least for Unix).
6790 This option cannot be set from a |modeline| or in the |sandbox|, for
6791 security reasons.
6792
6793 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6794'shellslash' 'ssl' boolean (default off)
6795 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006796 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006798 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006799 powershell.exe. Backward slashes can still be typed, but they are
6800 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 Note that setting or resetting this option has no effect for some
6802 existing file names, thus this option needs to be set before opening
6803 any file for best results. This might change in the future.
6804 'shellslash' only works when a backslash can be used as a path
6805 separator. To test if this is so use: >
6806 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006807< Also see 'completeslash'.
6808
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006809 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6810'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6811 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006812 When on, use temp files for shell commands. When off use a pipe.
6813 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006814 Currently a pipe is only supported on Unix and MS-Windows 2K and
6815 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006816 :if has("filterpipe")
6817< The advantage of using a pipe is that nobody can read the temp file
6818 and the 'shell' command does not need to support redirection.
6819 The advantage of using a temp file is that the file type and encoding
6820 can be detected.
6821 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6822 |FilterWritePost| autocommands event are not triggered when
6823 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006824 The `system()` function does not respect this option and always uses
6825 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006826 NOTE: This option is set to the Vim default value when 'compatible'
6827 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006828
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 *'shelltype'* *'st'*
6830'shelltype' 'st' number (default 0)
6831 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006832 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 On the Amiga this option influences the way how the commands work
6834 which use a shell.
6835 0 and 1: always use the shell
6836 2 and 3: use the shell only to filter lines
6837 4 and 5: use shell only for ':sh' command
6838 When not using the shell, the command is executed directly.
6839
6840 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6841 1 and 3: use "shell cmd" to start external commands
6842
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006843 *'shellxescape'* *'sxe'*
6844'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006845 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006846 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006847 When 'shellxquote' is set to "(" then the characters listed in this
6848 option will be escaped with a '^' character. This makes it possible
6849 to execute most external commands with cmd.exe.
6850
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 *'shellxquote'* *'sxq'*
6852'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006853 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006854 for Win32, when 'shell' is
6855 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006856 for Win32, when 'shell' contains "sh"
6857 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 for Unix, when using system(): "\"")
6859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 Quoting character(s), put around the command passed to the shell, for
6861 the "!" and ":!" commands. Includes the redirection. See
6862 'shellquote' to exclude the redirection. It's probably not useful
6863 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006864 When the value is '(' then ')' is appended. When the value is '"('
6865 then ')"' is appended.
6866 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006867 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006868 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6869 pwsh.exe which automatically strips off the first and last quote on a
6870 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6871 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006872 'shell', to reduce the need to set this option by the user. See
6873 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 This option cannot be set from a |modeline| or in the |sandbox|, for
6875 security reasons.
6876
6877 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6878'shiftround' 'sr' boolean (default off)
6879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 Round indent to multiple of 'shiftwidth'. Applies to > and <
6881 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6882 a multiple of 'shiftwidth' (this is Vi compatible).
6883 NOTE: This option is reset when 'compatible' is set.
6884
6885 *'shiftwidth'* *'sw'*
6886'shiftwidth' 'sw' number (default 8)
6887 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006888 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006890 When zero the 'ts' value will be used. Use the |shiftwidth()|
6891 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892
6893 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006894'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6895 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 This option helps to avoid all the |hit-enter| prompts caused by file
6898 messages, for example with CTRL-G, and to avoid some other messages.
6899 It is a list of flags:
6900 flag meaning when present ~
6901 f use "(3 of 5)" instead of "(file 3 of 5)"
6902 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006903 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 m use "[+]" instead of "[Modified]"
6905 n use "[New]" instead of "[New File]"
6906 r use "[RO]" instead of "[readonly]"
6907 w use "[w]" instead of "written" for file write message
6908 and "[a]" instead of "appended" for ':w >> file' command
6909 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6910 "[unix format]" and "[mac]" instead of "[mac format]".
6911 a all of the above abbreviations
6912
6913 o overwrite message for writing a file with subsequent message
6914 for reading a file (useful for ":wn" or when 'autowrite' on)
6915 O message for reading a file overwrites any previous message.
6916 Also for quickfix message (e.g., ":cn").
6917 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006918 hit TOP, continuing at BOTTOM" messages; when using the search
6919 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 t truncate file message at the start if it is too long to fit
6921 on the command-line, "<" will appear in the left most column.
6922 Ignored in Ex mode.
6923 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006924 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 Ignored in Ex mode.
6926 W don't give "written" or "[w]" when writing a file
6927 A don't give the "ATTENTION" message when an existing swap file
6928 is found.
6929 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006930 c don't give |ins-completion-menu| messages. For example,
6931 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6932 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006933 q use "recording" instead of "recording @a"
6934 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006935 was used for the command; note that this also affects messages
6936 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006937 S do not show search count message when searching, e.g.
6938 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939
6940 This gives you the opportunity to avoid that a change between buffers
6941 requires you to hit <Enter>, but still gives as useful a message as
6942 possible for the space available. To get the whole message that you
6943 would have got with 'shm' empty, use ":file!"
6944 Useful values:
6945 shm= No abbreviation of message.
6946 shm=a Abbreviation, but no loss of information.
6947 shm=at Abbreviation, and truncate message when necessary.
6948
6949 NOTE: This option is set to the Vi default value when 'compatible' is
6950 set and to the Vim default value when 'compatible' is reset.
6951
6952 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6953'shortname' 'sn' boolean (default off)
6954 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 Filenames are assumed to be 8 characters plus one extension of 3
6956 characters. Multiple dots in file names are not allowed. When this
6957 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006958 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006960 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961
6962 *'showbreak'* *'sbr'* *E595*
6963'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006964 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006965 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 feature}
6967 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006968 values are "> " or "+++ ": >
6969 :set showbreak=>\
6970< Note the backslash to escape the trailing space. It's easier like
6971 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006972 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006973< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 comma (in a future version the comma might be used to separate the
6975 part that is shown at the end and at the start of a line).
6976 The characters are highlighted according to the '@' flag in
6977 'highlight'.
6978 Note that tabs after the showbreak will be displayed differently.
6979 If you want the 'showbreak' to appear in between line numbers, add the
6980 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006981 A window-local value overrules a global value. If the global value is
6982 set and you want no value in the current window use NONE: >
6983 :setlocal showbreak=NONE
6984<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006986'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6987 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 {not available when compiled without the
6990 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006991 Show (partial) command in the last line of the screen. Set this
6992 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 In Visual mode the size of the selected area is shown:
6994 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006995 If the number of bytes is different it is also displayed: "2-6"
6996 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006998 - When selecting a block, the size in screen characters:
6999 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 NOTE: This option is set to the Vi default value when 'compatible' is
7001 set and to the Vim default value when 'compatible' is reset.
7002
7003 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7004'showfulltag' 'sft' boolean (default off)
7005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 When completing a word in insert mode (see |ins-completion|) from the
7007 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007008 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 matched a C function, you can see a template for what arguments are
7010 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007011 Note that this doesn't work well together with having "longest" in
7012 'completeopt', because the completion from the search pattern may not
7013 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014
7015 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7016'showmatch' 'sm' boolean (default off)
7017 global
7018 When a bracket is inserted, briefly jump to the matching one. The
7019 jump is only done if the match can be seen on the screen. The time to
7020 show the match can be set with 'matchtime'.
7021 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007022 seen or not).
7023 This option is reset when 'paste' is set and restored when 'paste' is
7024 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 When the 'm' flag is not included in 'cpoptions', typing a character
7026 will immediately move the cursor back to where it belongs.
7027 See the "sm" field in 'guicursor' for setting the cursor shape and
7028 blinking when showing the match.
7029 The 'matchpairs' option can be used to specify the characters to show
7030 matches for. 'rightleft' and 'revins' are used to look for opposite
7031 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007032 Also see the matchparen plugin for highlighting the match when moving
7033 around |pi_paren.txt|.
7034 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035
7036 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7037'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7038 global
7039 If in Insert, Replace or Visual mode put a message on the last line.
7040 Use the 'M' flag in 'highlight' to set the type of highlighting for
7041 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007042 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 doesn't mean XIM is really active, especially when 'imactivatekey' is
7044 not set.
7045 NOTE: This option is set to the Vi default value when 'compatible' is
7046 set and to the Vim default value when 'compatible' is reset.
7047
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007048 *'showtabline'* *'stal'*
7049'showtabline' 'stal' number (default 1)
7050 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007051 The value of this option specifies when the line with tab page labels
7052 will be displayed:
7053 0: never
7054 1: only if there are at least two tab pages
7055 2: always
7056 This is both for the GUI and non-GUI implementation of the tab pages
7057 line.
7058 See |tab-page| for more information about tab pages.
7059
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 *'sidescroll'* *'ss'*
7061'sidescroll' 'ss' number (default 0)
7062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 The minimal number of columns to scroll horizontally. Used only when
7064 the 'wrap' option is off and the cursor is moved off of the screen.
7065 When it is zero the cursor will be put in the middle of the screen.
7066 When using a slow terminal set it to a large number or 0. When using
7067 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7068 commands.
7069
7070 *'sidescrolloff'* *'siso'*
7071'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007072 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007074 right of the cursor if 'nowrap' is set. Setting this option to a
7075 value greater than 0 while having |'sidescroll'| also at a non-zero
7076 value makes some context visible in the line you are scrolling in
7077 horizontally (except at beginning of the line). Setting this option
7078 to a large value (like 999) has the effect of keeping the cursor
7079 horizontally centered in the window, as long as one does not come too
7080 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007081 After using the local value, go back the global value with one of
7082 these two: >
7083 setlocal sidescrolloff<
7084 setlocal sidescrolloff=-1
7085< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086
7087 Example: Try this together with 'sidescroll' and 'listchars' as
7088 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007089 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090
7091 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7092 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007093<
7094 *'signcolumn'* *'scl'*
7095'signcolumn' 'scl' string (default "auto")
7096 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007097 {not available when compiled without the |+signs|
7098 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007099 Whether or not to draw the signcolumn. Valid values are:
7100 "auto" only when there is a sign to display
7101 "no" never
7102 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007103 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007104 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105
7106
7107 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7108'smartcase' 'scs' boolean (default off)
7109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 Override the 'ignorecase' option if the search pattern contains upper
7111 case characters. Only used when the search pattern is typed and
7112 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007113 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7115 recalling the search pattern from history and hitting <Enter>.
7116 NOTE: This option is reset when 'compatible' is set.
7117
7118 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7119'smartindent' 'si' boolean (default off)
7120 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 {not available when compiled without the
7122 |+smartindent| feature}
7123 Do smart autoindenting when starting a new line. Works for C-like
7124 programs, but can also be used for other languages. 'cindent' does
7125 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007126 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007127 setting 'si' has no effect. 'indentexpr' is a more advanced
7128 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 Normally 'autoindent' should also be on when using 'smartindent'.
7130 An indent is automatically inserted:
7131 - After a line ending in '{'.
7132 - After a line starting with a keyword from 'cinwords'.
7133 - Before a line starting with '}' (only with the "O" command).
7134 When typing '}' as the first character in a new line, that line is
7135 given the same indent as the matching '{'.
7136 When typing '#' as the first character in a new line, the indent for
7137 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007138 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7140 When using the ">>" command, lines starting with '#' are not shifted
7141 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007142 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007143 This option is reset when 'paste' is set and restored when 'paste' is
7144 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145
7146 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7147'smarttab' 'sta' boolean (default off)
7148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007150 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7151 <BS> will delete a 'shiftwidth' worth of space at the start of the
7152 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007153 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007154 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7155 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007156 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007158 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007159 This option is reset when 'paste' is set and restored when 'paste' is
7160 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 NOTE: This option is reset when 'compatible' is set.
7162
7163 *'softtabstop'* *'sts'*
7164'softtabstop' 'sts' number (default 0)
7165 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 Number of spaces that a <Tab> counts for while performing editing
7167 operations, like inserting a <Tab> or using <BS>. It "feels" like
7168 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7169 used. This is useful to keep the 'ts' setting at its standard value
7170 of 8, while being able to edit like it is set to 'sts'. However,
7171 commands like "x" still work on the actual characters.
7172 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007173 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007174 'softtabstop' is set to 0 when the 'paste' option is set and restored
7175 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7177 spaces is minimized by using <Tab>s.
7178 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7179 set.
7180 NOTE: This option is set to 0 when 'compatible' is set.
7181
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007182 If Vim is compiled with the |+vartabs| feature then the value of
7183 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7184 anything other than an empty string.
7185
Bram Moolenaar217ad922005-03-20 22:37:15 +00007186 *'spell'* *'nospell'*
7187'spell' boolean (default off)
7188 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007189 {not available when compiled without the |+syntax|
7190 feature}
7191 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007192 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007193
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007194 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007195'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007196 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007197 {not available when compiled without the |+syntax|
7198 feature}
7199 Pattern to locate the end of a sentence. The following word will be
7200 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007201 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007202 When this check is not wanted make this option empty.
7203 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007204 Be careful with special characters, see |option-backslash| about
7205 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007206 To set this option automatically depending on the language, see
7207 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007208
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007209 *'spellfile'* *'spf'*
7210'spellfile' 'spf' string (default empty)
7211 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007212 {not available when compiled without the |+syntax|
7213 feature}
7214 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007215 commands. It must end in ".{encoding}.add". You need to include the
7216 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007217 *E765*
7218 It may also be a comma separated list of names. A count before the
7219 |zg| and |zw| commands can be used to access each. This allows using
7220 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007221 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007222 you: Using the first directory in 'runtimepath' that is writable. If
7223 there is no "spell" directory yet it will be created. For the file
7224 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007225 ignoring the region.
7226 The resulting ".spl" file will be used for spell checking, it does not
7227 have to appear in 'spelllang'.
7228 Normally one file is used for all regions, but you can add the region
7229 name if you want to. However, it will then only be used when
7230 'spellfile' is set to it, for entries in 'spelllang' only files
7231 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007232 This option cannot be set from a |modeline| or in the |sandbox|, for
7233 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007234
Bram Moolenaar217ad922005-03-20 22:37:15 +00007235 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007236'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007237 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007238 {not available when compiled without the |+syntax|
7239 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007240 A comma separated list of word list names. When the 'spell' option is
7241 on spellchecking will be done for these languages. Example: >
7242 set spelllang=en_us,nl,medical
7243< This means US English, Dutch and medical words are recognized. Words
7244 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007245 The word list name must consist of alphanumeric characters, a dash or
7246 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007247 recommended to separate the two letter language name from a
7248 specification. Thus "en-rare" is used for rare English words.
7249 A region name must come last and have the form "_xx", where "xx" is
7250 the two-letter, lower case region name. You can use more than one
7251 region by listing them: "en_us,en_ca" supports both US and Canadian
7252 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007253 Britain. (Note: currently en_au and en_nz dictionaries are older than
7254 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007255 If the name "cjk" is included East Asian characters are excluded from
7256 spell checking. This is useful when editing text that also has Asian
7257 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007258 Note that the "medical" dictionary does not exist, it is just an
7259 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007260 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007261 As a special case the name of a .spl file can be given as-is. The
7262 first "_xx" in the name is removed and used as the region name
7263 (_xx is an underscore, two letters and followed by a non-letter).
7264 This is mainly for testing purposes. You must make sure the correct
7265 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007266 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007267 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7268 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007269 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007270
Bram Moolenaar98692072006-02-04 00:57:42 +00007271 If the |spellfile.vim| plugin is active and you use a language name
7272 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7273 will ask you if you want to download the file.
7274
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007275 After this option has been set successfully, Vim will source the files
7276 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007277 up to the first character that is not an ASCII letter or number and
7278 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007279
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007280 *'spelloptions'* *'spo'*
7281'spelloptions' 'spo' string (default "")
7282 local to buffer
7283 {not available when compiled without the |+syntax|
7284 feature}
7285 A comma separated list of options for spell checking:
7286 camel When a word is CamelCased, assume "Cased" is a
7287 separate word: every upper-case character in a word
7288 that comes after a lower case character indicates the
7289 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007290
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007291 *'spellsuggest'* *'sps'*
7292'spellsuggest' 'sps' string (default "best")
7293 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007294 {not available when compiled without the |+syntax|
7295 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007296 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007297 the |spellsuggest()| function. This is a comma-separated list of
7298 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007299
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007300 best Internal method that works best for English. Finds
7301 changes like "fast" and uses a bit of sound-a-like
7302 scoring to improve the ordering.
7303
7304 double Internal method that uses two methods and mixes the
7305 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007306 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007307 word. That only works when the language specifies
7308 sound folding. Can be slow and doesn't always give
7309 better results.
7310
7311 fast Internal method that only checks for simple changes:
7312 character inserts/deletes/swaps. Works well for
7313 simple typing mistakes.
7314
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007315 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007316 Not used for |spellsuggest()|. The number of
7317 suggestions is never more than the value of 'lines'
7318 minus two.
7319
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007320 file:{filename} Read file {filename}, which must have two columns,
7321 separated by a slash. The first column contains the
7322 bad word, the second column the suggested good word.
7323 Example:
7324 theribal/terrible ~
7325 Use this for common mistakes that do not appear at the
7326 top of the suggestion list with the internal methods.
7327 Lines without a slash are ignored, use this for
7328 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007329 The word in the second column must be correct,
7330 otherwise it will not be used. Add the word to an
7331 ".add" file if it is currently flagged as a spelling
7332 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007333 The file is used for all languages.
7334
7335 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7336 trouble with spaces. |v:val| holds the badly spelled
7337 word. The expression must evaluate to a List of
7338 Lists, each with a suggestion and a score.
7339 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007340 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007341 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007342 internal methods use. A lower score is better.
7343 This may invoke |spellsuggest()| if you temporarily
7344 set 'spellsuggest' to exclude the "expr:" part.
7345 Errors are silently ignored, unless you set the
7346 'verbose' option to a non-zero value.
7347
7348 Only one of "best", "double" or "fast" may be used. The others may
7349 appear several times in any order. Example: >
7350 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7351<
7352 This option cannot be set from a |modeline| or in the |sandbox|, for
7353 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007354
7355
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7357'splitbelow' 'sb' boolean (default off)
7358 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 When on, splitting a window will put the new window below the current
7360 one. |:split|
7361
7362 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7363'splitright' 'spr' boolean (default off)
7364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 When on, splitting a window will put the new window right of the
7366 current one. |:vsplit|
7367
7368 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7369'startofline' 'sol' boolean (default on)
7370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007372 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007373 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007374 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 with a linewise operator, with "%" with a count and to buffer changing
7376 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7377 only has a line number, e.g., ":25" or ":+".
7378 In case of buffer changing commands the cursor is placed at the column
7379 where it was the last time the buffer was edited.
7380 NOTE: This option is set when 'compatible' is set.
7381
Bram Moolenaar00654022011-02-25 14:42:19 +01007382 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007384 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 {not available when compiled without the |+statusline|
7386 feature}
7387 When nonempty, this option determines the content of the status line.
7388 Also see |status-line|.
7389
7390 The option consists of printf style '%' items interspersed with
7391 normal text. Each status line item is of the form:
7392 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007393 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007394 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395
Bram Moolenaar238a5642006-02-21 22:12:05 +00007396 When the option starts with "%!" then it is used as an expression,
7397 evaluated and the result is used as the option value. Example: >
7398 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007399< The *g:statusline_winid* variable will be set to the |window-ID| of the
7400 window that the status line belongs to.
7401 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007402 Note that the "%!" expression is evaluated in the context of the
7403 current window and buffer, while %{} items are evaluated in the
7404 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007405
7406 When there is error while evaluating the option then it will be made
7407 empty to avoid further errors. Otherwise screen updating would loop.
7408
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 Note that the only effect of 'ruler' when this option is set (and
7410 'laststatus' is 2) is controlling the output of |CTRL-G|.
7411
7412 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007413 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007415 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 minwid Minimum width of the item, padding as set by '-' & '0'.
7417 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007418 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 on the left for text items. Numeric items will be
7420 shifted down to maxwid-2 digits followed by '>'number
7421 where number is the amount of missing digits, much like
7422 an exponential notation.
7423 item A one letter code as described below.
7424
7425 Following is a description of the possible statusline items. The
7426 second character in "item" is the type:
7427 N for number
7428 S for string
7429 F for flags as described below
7430 - not applicable
7431
7432 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007433 f S Path to the file in the buffer, as typed or relative to current
7434 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 F S Full path to the file in the buffer.
7436 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007437 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007439 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007441 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007443 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007445 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007447 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7449 being used: "<keymap>"
7450 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007451 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 B N As above, in hexadecimal.
7453 o N Byte number in file of byte under cursor, first byte is 1.
7454 Mnemonic: Offset from start of file (with one added)
7455 {not available when compiled without |+byte_offset| feature}
7456 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007457 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 l N Line number.
7459 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007460 c N Column number (byte index).
7461 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007462 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 p N Percentage through file in lines as in |CTRL-G|.
7464 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007465 percentage described for 'ruler'. Always 3 in length, unless
7466 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007467 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007469 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007470 Note that there is no '%' before the closing '}'. The
7471 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007472 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007473 {% - This is almost same as { except the result of the expression is
7474 re-evaluated as a statusline format string. Thus if the
7475 return value of expr contains % items they will get expanded.
7476 The expression can contain the } character, the end of
7477 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007478 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007479 func! Stl_filename() abort
7480 return "%t"
7481 endfunc
7482< `stl=%{Stl_filename()}` results in `"%t"`
7483 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007484 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 ( - Start of item group. Can be used for setting the width and
7486 alignment of a section. Must be followed by %) somewhere.
7487 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007488 T N For 'tabline': start of tab page N label. Use %T after the last
7489 label. This information is used for mouse clicks.
7490 X N For 'tabline': start of close tab N label. Use %X after the
7491 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7492 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 < - Where to truncate line if too long. Default is at the start.
7494 No width fields allowed.
7495 = - Separation point between left and right aligned items.
7496 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007497 # - Set highlight group. The name must follow and then a # again.
7498 Thus use %#HLname# for highlight group HLname. The same
7499 highlighting is used, also for the statusline of non-current
7500 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007502 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 The difference between User{N} and StatusLine will be applied
7504 to StatusLineNC for the statusline of non-current windows.
7505 The number N must be between 1 and 9. See |hl-User1..9|
7506
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007507 When displaying a flag, Vim removes the leading comma, if any, when
7508 that flag comes right after plaintext. This will make a nice display
7509 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510
Bram Moolenaar582fd852005-03-28 20:58:01 +00007511 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 not set) and a minwid is not set for the group, the whole group will
7513 become empty. This will make a group like the following disappear
7514 completely from the statusline when none of the flags are set. >
7515 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007516< Beware that an expression is evaluated each and every time the status
7517 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007518 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007519 While evaluating %{} the current buffer and current window will be set
7520 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007521 currently being drawn. The expression will evaluate in this context.
7522 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7523 real current buffer and "g:actual_curwin" to the |window-ID| of the
7524 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007525
Bram Moolenaar30b65812012-07-12 22:01:11 +02007526 The 'statusline' option will be evaluated in the |sandbox| if set from
7527 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007528 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007529
7530 It is not allowed to change text or jump to another window while
7531 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532
7533 If the statusline is not updated when you want it (e.g., after setting
7534 a variable that's used in an expression), you can force an update by
7535 setting an option without changing its value. Example: >
7536 :let &ro = &ro
7537
7538< A result of all digits is regarded a number for display purposes.
7539 Otherwise the result is taken as flag text and applied to the rules
7540 described above.
7541
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007542 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007544 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545
7546 Examples:
7547 Emulate standard status line with 'ruler' set >
7548 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7549< Similar, but add ASCII value of char under the cursor (like "ga") >
7550 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7551< Display byte count and byte value, modified flag in red. >
7552 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7553 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7554< Display a ,GZ flag if a compressed file is loaded >
7555 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7556< In the |:autocmd|'s: >
7557 :let b:gzflag = 1
7558< And: >
7559 :unlet b:gzflag
7560< And define this function: >
7561 :function VarExists(var, val)
7562 : if exists(a:var) | return a:val | else | return '' | endif
7563 :endfunction
7564<
7565 *'suffixes'* *'su'*
7566'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 Files with these suffixes get a lower priority when multiple files
7569 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007570 suffixes. Spaces after the comma are ignored. A dot is also seen as
7571 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572 separator, precede it with a backslash (see |option-backslash| about
7573 including spaces and backslashes).
7574 See 'wildignore' for completely ignoring files.
7575 The use of |:set+=| and |:set-=| is preferred when adding or removing
7576 suffixes from the list. This avoids problems when a future version
7577 uses another default.
7578
7579 *'suffixesadd'* *'sua'*
7580'suffixesadd' 'sua' string (default "")
7581 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 {not available when compiled without the
7583 |+file_in_path| feature}
7584 Comma separated list of suffixes, which are used when searching for a
7585 file for the "gf", "[I", etc. commands. Example: >
7586 :set suffixesadd=.java
7587<
7588 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7589'swapfile' 'swf' boolean (default on)
7590 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007591 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 swapfile is not wanted for a specific buffer. For example, with
7593 confidential information that even root must not be able to access.
7594 Careful: All text will be in memory:
7595 - Don't use this for big files.
7596 - Recovery will be impossible!
7597 A swapfile will only be present when |'updatecount'| is non-zero and
7598 'swapfile' is set.
7599 When 'swapfile' is reset, the swap file for the current buffer is
7600 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7601 non-zero, a swap file is immediately created.
7602 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007603 If you want to open a new buffer without creating a swap file for it,
7604 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007605 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606
7607 This option is used together with 'bufhidden' and 'buftype' to
7608 specify special kinds of buffers. See |special-buffers|.
7609
7610 *'swapsync'* *'sws'*
7611'swapsync' 'sws' string (default "fsync")
7612 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007614 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 When this option is empty parts of the swap file may be in memory and
7616 not written to disk. When the system crashes you may lose more work.
7617 On Unix the system does a sync now and then without Vim asking for it,
7618 so the disadvantage of setting this option off is small. On some
7619 systems the swap file will not be written at all. For a unix system
7620 setting it to "sync" will use the sync() call instead of the default
7621 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007622 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623
7624 *'switchbuf'* *'swb'*
7625'switchbuf' 'swb' string (default "")
7626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007628 Mostly for |quickfix| commands some values are also used for other
7629 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630 Possible values (comma separated list):
7631 useopen If included, jump to the first open window that
7632 contains the specified buffer (if there is one).
7633 Otherwise: Do not examine other windows.
7634 This setting is checked with |quickfix| commands, when
7635 jumping to errors (":cc", ":cn", "cp", etc.). It is
7636 also used in all buffer related split commands, for
7637 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007638 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007639 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007641 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007642 Otherwise: do not split, use current window (when used
7643 in the quickfix window: the previously used window or
7644 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007645 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007646 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007647 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007648 uselast If included, jump to the previously used window when
7649 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007651 *'synmaxcol'* *'smc'*
7652'synmaxcol' 'smc' number (default 3000)
7653 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007654 {not available when compiled without the |+syntax|
7655 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007656 Maximum column in which to search for syntax items. In long lines the
7657 text after this column is not highlighted and following lines may not
7658 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007659 This helps to avoid very slow redrawing for an XML file that is one
7660 long line.
7661 Set to zero to remove the limit.
7662
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 *'syntax'* *'syn'*
7664'syntax' 'syn' string (default empty)
7665 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 {not available when compiled without the |+syntax|
7667 feature}
7668 When this option is set, the syntax with this name is loaded, unless
7669 syntax highlighting has been switched off with ":syntax off".
7670 Otherwise this option does not always reflect the current syntax (the
7671 b:current_syntax variable does).
7672 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007673 not automatically recognized. Example, in an IDL file:
7674 /* vim: set syntax=idl : */ ~
7675 When a dot appears in the value then this separates two filetype
7676 names. Example:
7677 /* vim: set syntax=c.doxygen : */ ~
7678 This will use the "c" syntax first, then the "doxygen" syntax.
7679 Note that the second one must be prepared to be loaded as an addition,
7680 otherwise it will be skipped. More than one dot may appear.
7681 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 :set syntax=OFF
7683< To switch syntax highlighting on according to the current value of the
7684 'filetype' option: >
7685 :set syntax=ON
7686< What actually happens when setting the 'syntax' option is that the
7687 Syntax autocommand event is triggered with the value as argument.
7688 This option is not copied to another buffer, independent of the 's' or
7689 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007690 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007692 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007693'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007694 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007695 When nonempty, this option determines the content of the tab pages
7696 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007697 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007698
7699 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007700 option and only when there is no GUI tab line. When 'e' is in
7701 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007702 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007703
7704 The value is evaluated like with 'statusline'. You can use
7705 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007706 the text to be displayed. Use "%1T" for the first label, "%2T" for
7707 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007708
Bram Moolenaare12bab32019-01-08 22:02:56 +01007709 When changing something that is used in 'tabline' that does not
7710 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007711 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007712
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007713 Keep in mind that only one of the tab pages is the current one, others
7714 are invisible and you can't jump to their windows.
7715
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007716
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007717 *'tabpagemax'* *'tpm'*
7718'tabpagemax' 'tpm' number (default 10)
7719 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007720 Maximum number of tab pages to be opened by the |-p| command line
7721 argument or the ":tab all" command. |tabpage|
7722
7723
7724 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725'tabstop' 'ts' number (default 8)
7726 local to buffer
7727 Number of spaces that a <Tab> in the file counts for. Also see
7728 |:retab| command, and 'softtabstop' option.
7729
7730 Note: Setting 'tabstop' to any other value than 8 can make your file
7731 appear wrong in many places (e.g., when printing it).
7732
7733 There are four main ways to use tabs in Vim:
7734 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7735 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007736 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 behave like a tab appears every 4 (or 3) characters.
7738 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7739 'expandtab'. This way you will always insert spaces. The
7740 formatting will never be messed up when 'tabstop' is changed.
7741 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007742 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743 works when using Vim to edit the file.
7744 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7745 'noexpandtab'. This should then work (for initial indents only)
7746 for any tabstop setting that people use. It might be nice to have
7747 tabs after the first non-blank inserted as spaces if you do this
7748 though. Otherwise aligned comments will be wrong when 'tabstop' is
7749 changed.
7750
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007751 If Vim is compiled with the |+vartabs| feature then the value of
7752 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7753 than an empty string.
7754
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7756'tagbsearch' 'tbs' boolean (default on)
7757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007759 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 searching makes searching for a tag a LOT faster, but a linear search
7761 will find more tags if the tags file wasn't properly sorted.
7762 Vim normally assumes that your tags files are sorted, or indicate that
7763 they are not sorted. Only when this is not the case does the
7764 'tagbsearch' option need to be switched off.
7765
7766 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007767 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 certain files, or retry all files with a linear search. When
7769 'tagbsearch' is off, only a linear search is done.
7770
7771 Linear searching is done anyway, for one file, when Vim finds a line
7772 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007773 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774< [The whitespace before and after the '0' must be a single <Tab>]
7775
7776 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007777 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007778 instead of a normal tag name, a retry is done with a linear search.
7779 Tags in unsorted tags files, and matches with different case will only
7780 be found in the retry.
7781
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007782 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007783 linear search can be avoided when case is ignored. Use a value of '2'
7784 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7785 sorted with the -f switch to "sort" in most unices, as in the command:
7786 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7787 (at least 5.5) the --sort=foldcase switch can be used for this as
7788 well. Note that case must be folded to uppercase for this to work.
7789
7790 By default, tag searches are case-sensitive. Case is ignored when
7791 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7792 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007793 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7794 'tagcase' is "smart", and the pattern contains only lowercase
7795 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796
7797 When 'tagbsearch' is off, tags searching is slower when a full match
7798 exists, but faster when no full match exists. Tags in unsorted tags
7799 files may only be found with 'tagbsearch' off.
7800 When the tags file is not sorted, or sorted in a wrong way (not on
7801 ASCII byte value), 'tagbsearch' should be off, or the line given above
7802 must be included in the tags file.
7803 This option doesn't affect commands that find all matching tags (e.g.,
7804 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007806 *'tagcase'* *'tc'*
7807'tagcase' 'tc' string (default "followic")
7808 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007809 This option specifies how case is handled when searching the tags
7810 file:
7811 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007812 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007813 ignore Ignore case
7814 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007815 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007816 NOTE: This option is set to the Vi default value when 'compatible' is
7817 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007818
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007819 *'tagfunc'* *'tfu'*
7820'tagfunc' 'tfu' string (default: empty)
7821 local to buffer
7822 {not available when compiled without the |+eval|
7823 feature}
7824 This option specifies a function to be used to perform tag searches.
7825 The function gets the tag pattern and should return a List of matching
7826 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007827 function and an example. The value can be the name of a function, a
7828 |lambda| or a |Funcref|. See |option-value-function| for more
7829 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007830
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 *'taglength'* *'tl'*
7832'taglength' 'tl' number (default 0)
7833 global
7834 If non-zero, tags are significant up to this number of characters.
7835
7836 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7837'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7838 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007839 If on and using a tags file in another directory, file names in that
7840 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 NOTE: This option is set to the Vi default value when 'compatible' is
7842 set and to the Vim default value when 'compatible' is reset.
7843
7844 *'tags'* *'tag'* *E433*
7845'tags' 'tag' string (default "./tags,tags", when compiled with
7846 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7847 global or local to buffer |global-local|
7848 Filenames for the tag command, separated by spaces or commas. To
7849 include a space or comma in a file name, precede it with a backslash
7850 (see |option-backslash| about including spaces and backslashes).
7851 When a file name starts with "./", the '.' is replaced with the path
7852 of the current file. But only when the 'd' flag is not included in
7853 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7854 |tags-option|.
7855 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007856 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7857 find all files named "tags" below "/lib". The filename itself cannot
7858 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7859 files called "tags?". {not available when compiled without the
7860 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007861 The |tagfiles()| function can be used to get a list of the file names
7862 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7864 files are also supported. They are automatically recognized. The
7865 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7866 differences are ignored (MS-Windows). |emacs-tags|
7867 The use of |:set+=| and |:set-=| is preferred when adding or removing
7868 file names from the list. This avoids problems when a future version
7869 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870
7871 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7872'tagstack' 'tgst' boolean (default on)
7873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 When on, the |tagstack| is used normally. When off, a ":tag" or
7875 ":tselect" command with an argument will not push the tag onto the
7876 tagstack. A following ":tag" without an argument, a ":pop" command or
7877 any other command that uses the tagstack will use the unmodified
7878 tagstack, but does change the pointer to the active entry.
7879 Resetting this option is useful when using a ":tag" command in a
7880 mapping which should not change the tagstack.
7881
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007882 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007883'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007884 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007885 {only available when compiled with the |+tcl/dyn|
7886 feature}
7887 Specifies the name of the Tcl shared library. The default is
7888 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007889 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007890 This option cannot be set from a |modeline| or in the |sandbox|, for
7891 security reasons.
7892
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 *'term'* *E529* *E530* *E531*
7894'term' string (default is $TERM, if that fails:
7895 in the GUI: "builtin_gui"
7896 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007897 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 on Unix: "ansi"
7900 on VMS: "ansi"
7901 on Win 32: "win32")
7902 global
7903 Name of the terminal. Used for choosing the terminal control
7904 characters. Environment variables are expanded |:set_env|.
7905 For example: >
7906 :set term=$TERM
7907< See |termcap|.
7908
7909 *'termbidi'* *'tbidi'*
7910 *'notermbidi'* *'notbidi'*
7911'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 {only available when compiled with the |+arabic|
7914 feature}
7915 The terminal is in charge of Bi-directionality of text (as specified
7916 by Unicode). The terminal is also expected to do the required shaping
7917 that some languages (such as Arabic) require.
7918 Setting this option implies that 'rightleft' will not be set when
7919 'arabic' is set and the value of 'arabicshape' will be ignored.
7920 Note that setting 'termbidi' has the immediate effect that
7921 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7922 This option is reset when the GUI is started.
7923 For further details see |arabic.txt|.
7924
7925 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007926'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 Encoding used for the terminal. This specifies what character
7929 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007930 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007931 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007932 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007933 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7935 Any attempts to set a different value will be rejected, and an error
7936 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007937 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 because the Win32 system always passes Unicode characters.
7939 When empty, the same encoding is used as for the 'encoding' option.
7940 This is the normal value.
7941 Not all combinations for 'termencoding' and 'encoding' are valid. See
7942 |encoding-table|.
7943 The value for this option must be supported by internal conversions or
7944 iconv(). When this is not possible no conversion will be done and you
7945 will probably experience problems with non-ASCII characters.
7946 Example: You are working with the locale set to euc-jp (Japanese) and
7947 want to edit a UTF-8 file: >
7948 :let &termencoding = &encoding
7949 :set encoding=utf-8
7950< You need to do this when your system has no locale support for UTF-8.
7951
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007952 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007953'termguicolors' 'tgc' boolean (default off)
7954 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007955 {not available when compiled without the
7956 |+termguicolors| feature}
7957 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007958 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007959
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007960 Requires a ISO-8613-3 compatible terminal. If setting this option
7961 does not work (produces a colorless UI) reading |xterm-true-color|
7962 might help.
7963
7964 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7965 is required. Use this check to find out: >
7966 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007967< This requires Vim to be built with the |+vtp| feature.
7968
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007969 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007970 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007971
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007972 *'termwinkey'* *'twk'*
7973'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007974 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007975 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007976 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007977 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007978 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007979< The string must be one key stroke but can be multiple bytes.
7980 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007981 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007982 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007983
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007984 *'termwinscroll'* *'twsl'*
7985'termwinscroll' 'twsl' number (default 10000)
7986 local to buffer
7987 {not available when compiled without the
7988 |+terminal| feature}
7989 Number of scrollback lines to keep. When going over this limit the
7990 first 10% of the scrollback lines are deleted. This is just to reduce
7991 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00007992 Also used as a limit for text sent to the terminal in one write,
7993 multiplied by the number of columns times 3 (average number of bytes
7994 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007995
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007996 *'termwinsize'* *'tws'*
7997'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007998 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007999 Size used when opening the |terminal| window. Format:
8000 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008001 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008002 - When set with a "x" (e.g., "24x80") the terminal size is not
8003 adjusted to the window size. If the window is smaller only the
8004 top-left part is displayed.
8005 - When set with a "*" (e.g., "10*50") the terminal size follows the
8006 window size, but will not be smaller than the specified rows and/or
8007 columns.
8008 - When rows is zero then use the height of the window.
8009 - When columns is zero then use the width of the window.
8010 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008011 - Can be overruled in the |term_start()| options with "term_rows" and
8012 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008013
8014 Examples:
8015 "30x0" uses 30 rows and the current window width.
8016 "20*0" uses at least 20 rows and the current window width.
8017 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008018 Note that the command running in the terminal window may still change
8019 the size of the terminal. In that case the Vim window will be
8020 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008021
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008022 *'termwintype'* *'twt'*
8023'termwintype' 'twt' string (default "")
8024 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008025 {only available when compiled with the |terminal|
8026 feature on MS-Windows}
8027 Specify the virtual console (pty) used when opening the terminal
8028 window.
8029
8030 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008031 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008032 "winpty" use winpty, fail if not supported
8033 "conpty" use |ConPTY|, fail if not supported
8034
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008035 |ConPTY| support depends on the platform. Windows 10 October 2018
8036 Update is the first version that supports ConPTY, however it is still
8037 considered unstable. ConPTY might become stable in the next release
8038 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008039 supported then you cannot open a terminal window.
8040
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 *'terse'* *'noterse'*
8042'terse' boolean (default off)
8043 global
8044 When set: Add 's' flag to 'shortmess' option (this makes the message
8045 for a search that hits the start or end of the file not being
8046 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8047 shortens a lot of messages}
8048
8049 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8050'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 This option is obsolete. Use 'fileformats'.
8053 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8054 set to the default value for the current system. When 'textauto' is
8055 reset, 'fileformats' is made empty.
8056 NOTE: This option is set to the Vi default value when 'compatible' is
8057 set and to the Vim default value when 'compatible' is reset.
8058
8059 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008060'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061 others: default off)
8062 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 This option is obsolete. Use 'fileformat'.
8064 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8065 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8066 "unix".
8067
8068 *'textwidth'* *'tw'*
8069'textwidth' 'tw' number (default 0)
8070 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 Maximum width of text that is being inserted. A longer line will be
8072 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008073 this.
8074 'textwidth' is set to 0 when the 'paste' option is set and restored
8075 when 'paste' is reset.
8076 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008078 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 NOTE: This option is set to 0 when 'compatible' is set.
8080
8081 *'thesaurus'* *'tsr'*
8082'thesaurus' 'tsr' string (default "")
8083 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008084 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008085 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8086 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008087
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008088 This option is not used if 'thesaurusfunc' is set, either for the
8089 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008090
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008091 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008093 name. See |option-backslash| about using backslashes. The use of
8094 |:set+=| and |:set-=| is preferred when adding or removing directories
8095 from the list. This avoids problems when a future version uses
8096 another default. Backticks cannot be used in this option for security
8097 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008099 *'thesaurusfunc'* *tsrfu'*
8100'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008101 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008102 {not available when compiled without the |+eval|
8103 feature}
8104 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008105 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008106 The value can be the name of a function, a |lambda| or a |Funcref|.
8107 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008108
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008109 This option cannot be set from a |modeline| or in the |sandbox|, for
8110 security reasons.
8111
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8113'tildeop' 'top' boolean (default off)
8114 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 When on: The tilde command "~" behaves like an operator.
8116 NOTE: This option is reset when 'compatible' is set.
8117
8118 *'timeout'* *'to'* *'notimeout'* *'noto'*
8119'timeout' 'to' boolean (default on)
8120 global
8121 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008122'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 These two options together determine the behavior when part of a
8125 mapped key sequence or keyboard code has been received:
8126
8127 'timeout' 'ttimeout' action ~
8128 off off do not time out
8129 on on or off time out on :mappings and key codes
8130 off on time out on key codes
8131
8132 If both options are off, Vim will wait until either the complete
8133 mapping or key sequence has been received, or it is clear that there
8134 is no mapping or key sequence for the received characters. For
8135 example: if you have mapped "vl" and Vim has received 'v', the next
8136 character is needed to see if the 'v' is followed by an 'l'.
8137 When one of the options is on, Vim will wait for about 1 second for
8138 the next character to arrive. After that the already received
8139 characters are interpreted as single characters. The waiting time can
8140 be changed with the 'timeoutlen' option.
8141 On slow terminals or very busy systems timing out may cause
8142 malfunctioning cursor keys. If both options are off, Vim waits
8143 forever after an entered <Esc> if there are key codes that start
8144 with <Esc>. You will have to type <Esc> twice. If you do not have
8145 problems with key codes, but would like to have :mapped key
8146 sequences not timing out in 1 second, set the 'ttimeout' option and
8147 reset the 'timeout' option.
8148
8149 NOTE: 'ttimeout' is reset when 'compatible' is set.
8150
8151 *'timeoutlen'* *'tm'*
8152'timeoutlen' 'tm' number (default 1000)
8153 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008154
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008156'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 The time in milliseconds that is waited for a key code or mapped key
8159 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8160 when part of a command has been typed.
8161 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8162 different timeout value for key codes is desired set 'ttimeoutlen' to
8163 a non-negative number.
8164
8165 ttimeoutlen mapping delay key code delay ~
8166 < 0 'timeoutlen' 'timeoutlen'
8167 >= 0 'timeoutlen' 'ttimeoutlen'
8168
8169 The timeout only happens when the 'timeout' and 'ttimeout' options
8170 tell so. A useful setting would be >
8171 :set timeout timeoutlen=3000 ttimeoutlen=100
8172< (time out on mapping after three seconds, time out on key codes after
8173 a tenth of a second).
8174
8175 *'title'* *'notitle'*
8176'title' boolean (default off, on when title can be restored)
8177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 When on, the title of the window will be set to the value of
8179 'titlestring' (if it is not empty), or to:
8180 filename [+=-] (path) - VIM
8181 Where:
8182 filename the name of the file being edited
8183 - indicates the file cannot be modified, 'ma' off
8184 + indicates the file was modified
8185 = indicates the file is read-only
8186 =+ indicates the file is read-only and modified
8187 (path) is the path of the file being edited
8188 - VIM the server name |v:servername| or "VIM"
8189 Only works if the terminal supports setting window titles
8190 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008191 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8193 *X11*
8194 When Vim was compiled with HAVE_X11 defined, the original title will
8195 be restored if possible. The output of ":version" will include "+X11"
8196 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8197 works for the icon name |'icon'|.
8198 But: When Vim was started with the |-X| argument, restoring the title
8199 will not work (except in the GUI).
8200 If the title cannot be restored, it is set to the value of 'titleold'.
8201 You might want to restore the title outside of Vim then.
8202 When using an xterm from a remote machine you can use this command:
8203 rsh machine_name xterm -display $DISPLAY &
8204 then the WINDOWID environment variable should be inherited and the
8205 title of the window should change back to what it should be after
8206 exiting Vim.
8207
8208 *'titlelen'*
8209'titlelen' number (default 85)
8210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008212 title. When the title is longer, only the end of the path name is
8213 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 Using a percentage makes this adapt to the width of the window. But
8215 it won't work perfectly, because the actual number of characters
8216 available also depends on the font used and other things in the title
8217 bar. When 'titlelen' is zero the full path is used. Otherwise,
8218 values from 1 to 30000 percent can be used.
8219 'titlelen' is also used for the 'titlestring' option.
8220
8221 *'titleold'*
8222'titleold' string (default "Thanks for flying Vim")
8223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 This option will be used for the window title when exiting Vim if the
8225 original title cannot be restored. Only happens if 'title' is on or
8226 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008227 This option cannot be set from a |modeline| or in the |sandbox|, for
8228 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229 *'titlestring'*
8230'titlestring' string (default "")
8231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 When this option is not empty, it will be used for the title of the
8233 window. This happens only when the 'title' option is on.
8234 Only works if the terminal supports setting window titles (currently
8235 Amiga console, Win32 console, all GUI versions and terminals with a
8236 non-empty 't_ts' option).
8237 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008238 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008239
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 When this option contains printf-style '%' items, they will be
8241 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008242 This option cannot be set in a modeline when 'modelineexpr' is off.
8243
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 Example: >
8245 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8246 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8247< The value of 'titlelen' is used to align items in the middle or right
8248 of the available space.
8249 Some people prefer to have the file name first: >
8250 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8251< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008252 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 separating space only when needed.
8254 NOTE: Use of special characters in 'titlestring' may cause the display
8255 to be garbled (e.g., when it contains a CR or NL character).
8256 {not available when compiled without the |+statusline| feature}
8257
8258 *'toolbar'* *'tb'*
8259'toolbar' 'tb' string (default "icons,tooltips")
8260 global
8261 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8262 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008263 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264 possible values are:
8265 icons Toolbar buttons are shown with icons.
8266 text Toolbar buttons shown with text.
8267 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008268 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 tooltips Tooltips are active for toolbar buttons.
8270 Tooltips refer to the popup help text which appears after the mouse
8271 cursor is placed over a toolbar button for a brief moment.
8272
8273 If you want the toolbar to be shown with icons as well as text, do the
8274 following: >
8275 :set tb=icons,text
8276< Motif and Athena cannot display icons and text at the same time. They
8277 will show icons if both are requested.
8278
8279 If none of the strings specified in 'toolbar' are valid or if
8280 'toolbar' is empty, this option is ignored. If you want to disable
8281 the toolbar, you need to set the 'guioptions' option. For example: >
8282 :set guioptions-=T
8283< Also see |gui-toolbar|.
8284
8285 *'toolbariconsize'* *'tbis'*
8286'toolbariconsize' 'tbis' string (default "small")
8287 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008288 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008290 tiny Use tiny icons.
8291 small Use small icons (default).
8292 medium Use medium-sized icons.
8293 large Use large icons.
8294 huge Use even larger icons.
8295 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008297 the current theme. Common dimensions are giant=48x48, huge=32x32,
8298 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008299
8300 If 'toolbariconsize' is empty, the global default size as determined
8301 by user preferences or the current theme is used.
8302
8303 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8304'ttybuiltin' 'tbi' boolean (default on)
8305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 When on, the builtin termcaps are searched before the external ones.
8307 When off the builtin termcaps are searched after the external ones.
8308 When this option is changed, you should set the 'term' option next for
8309 the change to take effect, for example: >
8310 :set notbi term=$TERM
8311< See also |termcap|.
8312 Rationale: The default for this option is "on", because the builtin
8313 termcap entries are generally better (many systems contain faulty
8314 xterm entries...).
8315
8316 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8317'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8318 sun-cmd, screen, rxvt, dtterm or
8319 iris-ansi; also on when running Vim in
8320 a DOS console)
8321 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 Indicates a fast terminal connection. More characters will be sent to
8323 the screen for redrawing, instead of using insert/delete line
8324 commands. Improves smoothness of redrawing when there are multiple
8325 windows and the terminal does not support a scrolling region.
8326 Also enables the extra writing of characters at the end of each screen
8327 line for lines that wrap. This helps when using copy/paste with the
8328 mouse in an xterm and other terminals.
8329
8330 *'ttymouse'* *'ttym'*
8331'ttymouse' 'ttym' string (default depends on 'term')
8332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333 {only in Unix and VMS, doesn't work in the GUI; not
8334 available when compiled without |+mouse|}
8335 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008336 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 *xterm-mouse*
8338 xterm xterm-like mouse handling. The mouse generates
8339 "<Esc>[Mscr", where "scr" is three bytes:
8340 "s" = button state
8341 "c" = column plus 33
8342 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008343 This only works up to 223 columns! See "dec",
8344 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 xterm2 Works like "xterm", but with the xterm reporting the
8346 mouse position while the mouse is dragged. This works
8347 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008348 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 work. See below for how Vim detects this
8350 automatically.
8351 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008352 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008354 for the row and column. No other mouse events are
8355 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356 *dec-mouse*
8357 dec DEC terminal mouse handling. The mouse generates a
8358 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008359 This is also available for an Xterm, if it was
8360 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361 *jsbterm-mouse*
8362 jsbterm JSB term mouse handling.
8363 *pterm-mouse*
8364 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008365 *urxvt-mouse*
8366 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008367 The mouse works only if the terminal supports this
8368 encoding style, but it does not have 223 columns limit
8369 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008370 *sgr-mouse*
8371 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008372 mouse reporting. The mouse works even in columns
8373 beyond 223. This option is backward compatible with
8374 "xterm2" because it can also decode "xterm2" style
8375 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376
8377 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008378 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8379 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8381 recognized, if enabled at compile time. DEC terminal mouse codes
8382 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008383 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8384 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008386 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8387 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8388 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008389 Additionally, if vim is compiled with the |+termresponse| feature and
8390 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008391 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008393 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8394 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8395 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008396 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8397 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 :set t_RV=
8399<
8400 *'ttyscroll'* *'tsl'*
8401'ttyscroll' 'tsl' number (default 999)
8402 global
8403 Maximum number of lines to scroll the screen. If there are more lines
8404 to scroll the window is redrawn. For terminals where scrolling is
8405 very slow and redrawing is not slow this can be set to a small number,
8406 e.g., 3, to speed up displaying.
8407
8408 *'ttytype'* *'tty'*
8409'ttytype' 'tty' string (default from $TERM)
8410 global
8411 Alias for 'term', see above.
8412
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008413 *'undodir'* *'udir'*
8414'undodir' 'udir' string (default ".")
8415 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008416 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008417 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008418 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008419 "." means using the directory of the file. The undo file name for
8420 "file.txt" is ".file.txt.un~".
8421 For other directories the file name is the full path of the edited
8422 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008423 When writing: The first directory that exists is used. "." always
8424 works, no directories after "." will be used for writing.
8425 When reading all entries are tried to find an undo file. The first
8426 undo file that exists is used. When it cannot be read an error is
8427 given, no further entry is used.
8428 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008429 This option cannot be set from a |modeline| or in the |sandbox|, for
8430 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008431
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008432 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008433'undofile' 'udf' boolean (default off)
8434 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008435 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008436 When on, Vim automatically saves undo history to an undo file when
8437 writing a buffer to a file, and restores undo history from the same
8438 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008439 The directory where the undo file is stored is specified by 'undodir'.
8440 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008441 The undo file is not read when 'undoreload' causes the buffer from
8442 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008443 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008444 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008445
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008447'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008448 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008450 is kept in memory, higher numbers will cause more memory to be used.
8451 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8453 itself: >
8454 set ul=0
8455< But you can also get Vi compatibility by including the 'u' flag in
8456 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008457 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008458 Set to -1 for no undo at all. You might want to do this only for the
8459 current buffer: >
8460 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008462
8463 The local value is set to -123456 when the global value is to be used.
8464
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008465 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008467 *'undoreload'* *'ur'*
8468'undoreload' 'ur' number (default 10000)
8469 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008470 Save the whole buffer for undo when reloading it. This applies to the
8471 ":e!" command and reloading for when the buffer changed outside of
8472 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008473 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008474 of lines is smaller than the value of this option.
8475 Set this option to zero to disable undo for a reload.
8476
8477 When saving undo for a reload, any undo file is not read.
8478
8479 Note that this causes the whole buffer to be stored in memory. Set
8480 this option to a lower value if you run out of memory.
8481
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 *'updatecount'* *'uc'*
8483'updatecount' 'uc' number (default: 200)
8484 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 After typing this many characters the swap file will be written to
8486 disk. When zero, no swap file will be created at all (see chapter on
8487 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8488 Vim with the "-n" option, see |startup|. When editing in readonly
8489 mode this option will be initialized to 10000.
8490 The swapfile can be disabled per buffer with |'swapfile'|.
8491 When 'updatecount' is set from zero to non-zero, swap files are
8492 created for all buffers that have 'swapfile' set. When 'updatecount'
8493 is set to zero, existing swap files are not deleted.
8494 Also see |'swapsync'|.
8495 This option has no meaning in buffers where |'buftype'| is "nofile"
8496 or "nowrite".
8497
8498 *'updatetime'* *'ut'*
8499'updatetime' 'ut' number (default 4000)
8500 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 If this many milliseconds nothing is typed the swap file will be
8502 written to disk (see |crash-recovery|). Also used for the
8503 |CursorHold| autocommand event.
8504
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008505 *'varsofttabstop'* *'vsts'*
8506'varsofttabstop' 'vsts' string (default "")
8507 local to buffer
8508 {only available when compiled with the |+vartabs|
8509 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008510 A list of the number of spaces that a <Tab> counts for while editing,
8511 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8512 width <Tab>s are being inserted, while in fact a mixture of spaces
8513 and <Tab>s is used. Tab widths are separated with commas, with the
8514 final value applying to all subsequent tabs.
8515
8516 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008517 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008518 to use the following: >
8519 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008520< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8521 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008522
8523 Note that the value of |'softtabstop'| will be ignored while
8524 'varsofttabstop' is set.
8525
8526 *'vartabstop'* *'vts'*
8527'vartabstop' 'vts' string (default "")
8528 local to buffer
8529 {only available when compiled with the |+vartabs|
8530 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008531 A list of the number of spaces that a <Tab> in the file counts for,
8532 separated by commas. Each value corresponds to one tab, with the
8533 final value applying to all subsequent tabs. For example: >
8534 :set vartabstop=4,20,10,8
8535< This will make the first tab 4 spaces wide, the second 20 spaces,
8536 the third 10 spaces, and all following tabs 8 spaces.
8537
8538 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8539 is set.
8540
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 *'verbose'* *'vbs'*
8542'verbose' 'vbs' number (default 0)
8543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 When bigger than zero, Vim will give messages about what it is doing.
8545 Currently, these messages are given:
8546 >= 1 When the viminfo file is read or written.
8547 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008548 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008549 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008550 >= 8 Files for which a group of autocommands is executed.
8551 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008552 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 >= 12 Every executed function.
8554 >= 13 When an exception is thrown, caught, finished, or discarded.
8555 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008556 >= 15 Every executed Ex command from a script (truncated at 200
8557 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008558 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559
8560 This option can also be set with the "-V" argument. See |-V|.
8561 This option is also set by the |:verbose| command.
8562
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008563 When the 'verbosefile' option is set then the verbose messages are not
8564 displayed.
8565
8566 *'verbosefile'* *'vfile'*
8567'verbosefile' 'vfile' string (default empty)
8568 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008569 When not empty all messages are written in a file with this name.
8570 When the file exists messages are appended.
8571 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008572 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008573 Setting 'verbosefile' to a new value is like making it empty first.
8574 The difference with |:redir| is that verbose messages are not
8575 displayed when 'verbosefile' is set.
8576
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008578'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 "$VIM/vimfiles/view",
8580 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008581 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008582 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008584 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 feature}
8586 Name of the directory where to store files for |:mkview|.
8587 This option cannot be set from a |modeline| or in the |sandbox|, for
8588 security reasons.
8589
8590 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008591'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008593 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594 feature}
8595 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008596 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 word save and restore ~
8598 cursor cursor position in file and in window
8599 folds manually created folds, opened/closed folds and local
8600 fold options
8601 options options and mappings local to a window or buffer (not
8602 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008603 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 slash backslashes in file names replaced with forward
8605 slashes
8606 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008607 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008608 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008610 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008612 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613
8614 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008615'viminfo' 'vi' string (Vi default: "", Vim default for
8616 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008617 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8618 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008620 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621 feature}
8622 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008623 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8624 "NONE".
8625 The string should be a comma separated list of parameters, each
8626 consisting of a single character identifying the particular parameter,
8627 followed by a number or string which specifies the value of that
8628 parameter. If a particular character is left out, then the default
8629 value is used for that parameter. The following is a list of the
8630 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008632 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633 ! When included, save and restore global variables that start
8634 with an uppercase letter, and don't contain a lowercase
8635 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008636 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008637 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008638 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 " Maximum number of lines saved for each register. Old name of
8640 the '<' item, with the disadvantage that you need to put a
8641 backslash before the ", otherwise it will be recognized as the
8642 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008643 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 % When included, save and restore the buffer list. If Vim is
8645 started with a file name argument, the buffer list is not
8646 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008647 buffer list is restored from the viminfo file. Quickfix
8648 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8649 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008650 When followed by a number, the number specifies the maximum
8651 number of buffers that are stored. Without a number all
8652 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008653 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 ' Maximum number of previously edited files for which the marks
8655 are remembered. This parameter must always be included when
8656 'viminfo' is non-empty.
8657 Including this item also means that the |jumplist| and the
8658 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008659 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008660 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008661 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 patterns are also saved. When not included, the value of
8663 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008664 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008666 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008667 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 < Maximum number of lines saved for each register. If zero then
8669 registers are not saved. When not included, all lines are
8670 saved. '"' is the old name for this item.
8671 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008672 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008674 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008675 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 c When included, convert the text in the viminfo file from the
8677 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008678 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008679 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008680 f Whether file marks need to be stored. If zero, file marks ('0
8681 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008682 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008684 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 h Disable the effect of 'hlsearch' when loading the viminfo
8686 file. When not included, it depends on whether ":nohlsearch"
8687 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008688 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008690 the 'n'. Must be at the end of the option! If the
8691 'viminfofile' option is set, that file name overrides the one
8692 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008693 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008694 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 r Removable media. The argument is a string (up to the next
8696 ','). This parameter can be given several times. Each
8697 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008698 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8700 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8701 ignored. Maximum length of each 'r' argument is 50
8702 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008703 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 s Maximum size of an item in Kbyte. If zero then registers are
8705 not saved. Currently only applies to registers. The default
8706 "s10" will exclude registers with more than 10 Kbyte of text.
8707 Also see the '<' item above: line count limit.
8708
8709 Example: >
8710 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8711<
8712 '50 Marks will be remembered for the last 50 files you
8713 edited.
8714 <1000 Contents of registers (up to 1000 lines each) will be
8715 remembered.
8716 s100 Registers with more than 100 Kbyte text are skipped.
8717 :0 Command-line history will not be saved.
8718 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8719 no / Since '/' is not specified, the default will be used,
8720 that is, save all of the search history, and also the
8721 previous search and substitute patterns.
8722 no % The buffer list will not be saved nor read back.
8723 no h 'hlsearch' highlighting will be restored.
8724
8725 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8726 load the contents of the file, this is not done automatically.
8727
8728 This option cannot be set from a |modeline| or in the |sandbox|, for
8729 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008730 NOTE: This option is set to the Vim default value when 'compatible'
8731 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008733 *'viminfofile'* *'vif'*
8734'viminfofile' 'vif' string (default: "")
8735 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008736 {not available when compiled without the |+viminfo|
8737 feature}
8738 When non-empty, overrides the file name used for viminfo.
8739 When equal to "NONE" no viminfo file will be read or written.
8740 This option can be set with the |-i| command line flag. The |--clean|
8741 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008742 This option cannot be set from a |modeline| or in the |sandbox|, for
8743 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008744
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 *'virtualedit'* *'ve'*
8746'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008747 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 A comma separated list of these words:
8749 block Allow virtual editing in Visual block mode.
8750 insert Allow virtual editing in Insert mode.
8751 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008752 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008753 none When used as the local value, do not allow virtual
8754 editing even when the global value is set. When used
8755 as the global value, "none" is the same as "".
8756 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008757
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008759 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 of the line. Useful for selecting a rectangle in Visual mode and
8761 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008762 "onemore" is not the same, it will only allow moving the cursor just
8763 after the last character of the line. This makes some commands more
8764 consistent. Previously the cursor was always past the end of the line
8765 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008766 break some plugins or Vim scripts. For example because |l| can move
8767 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008768 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008769 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008770 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008771 It doesn't make sense to combine "all" with "onemore", but you will
8772 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008773 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008774 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775
8776 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8777'visualbell' 'vb' boolean (default off)
8778 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008779 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008781 use: >
8782 :set vb t_vb=
8783< If you want a short flash, you can use this on many terminals: >
8784 :set vb t_vb=[?5h$<100>[?5l
8785< Here $<100> specifies the time, you can use a smaller or bigger value
8786 to get a shorter or longer flash.
8787
8788 Note: Vim will limit the bell to once per half a second. This avoids
8789 having to wait for the flashing to finish when there are lots of
8790 bells, e.g. on key repeat. This also happens without 'visualbell'
8791 set.
8792
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8794 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8795 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008796
8797 Note: When the GUI starts, 't_vb' is reset to its default value. You
8798 might want to set it again in your |gvimrc|.
8799
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 Does not work on the Amiga, you always get a screen flash.
8801 Also see 'errorbells'.
8802
8803 *'warn'* *'nowarn'*
8804'warn' boolean (default on)
8805 global
8806 Give a warning message when a shell command is used while the buffer
8807 has been changed.
8808
8809 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8810'weirdinvert' 'wiv' boolean (default off)
8811 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008812 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 It is provided for backwards compatibility with version 4.x.
8814 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8815 vice versa. Has no effect when the GUI is running.
8816
8817 *'whichwrap'* *'ww'*
8818'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 Allow specified keys that move the cursor left/right to move to the
8821 previous/next line when the cursor is on the first/last character in
8822 the line. Concatenate characters to allow this for these keys:
8823 char key mode ~
8824 b <BS> Normal and Visual
8825 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008826 h "h" Normal and Visual (not recommended)
8827 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 < <Left> Normal and Visual
8829 > <Right> Normal and Visual
8830 ~ "~" Normal
8831 [ <Left> Insert and Replace
8832 ] <Right> Insert and Replace
8833 For example: >
8834 :set ww=<,>,[,]
8835< allows wrap only when cursor keys are used.
8836 When the movement keys are used in combination with a delete or change
8837 operator, the <EOL> also counts for a character. This makes "3h"
8838 different from "3dh" when the cursor crosses the end of a line. This
8839 is also true for "x" and "X", because they do the same as "dl" and
8840 "dh". If you use this, you may also want to use the mapping
8841 ":map <BS> X" to make backspace delete the character in front of the
8842 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008843 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008844 line (not an empty line) then it will not move to the next line. This
8845 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 NOTE: This option is set to the Vi default value when 'compatible' is
8847 set and to the Vim default value when 'compatible' is reset.
8848
8849 *'wildchar'* *'wc'*
8850'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 Character you have to type to start wildcard expansion in the
8853 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008854 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 The character is not recognized when used inside a macro. See
8856 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008857 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008859 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008860< NOTE: This option is set to the Vi default value when 'compatible' is
8861 set and to the Vim default value when 'compatible' is reset.
8862
8863 *'wildcharm'* *'wcm'*
8864'wildcharm' 'wcm' number (default: none (0))
8865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008867 recognized when used inside a macro. You can find "spare" command-line
8868 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869 you'll never actually type 'wildcharm', just use it in mappings that
8870 automatically invoke completion mode, e.g.: >
8871 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008872 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873< Then after typing :ss you can use CTRL-P & CTRL-N.
8874
8875 *'wildignore'* *'wig'*
8876'wildignore' 'wig' string (default "")
8877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 {not available when compiled without the |+wildignore|
8879 feature}
8880 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008881 patterns is ignored when expanding |wildcards|, completing file or
8882 directory names, and influences the result of |expand()|, |glob()| and
8883 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008884 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8885 Also see 'suffixes'.
8886 Example: >
8887 :set wildignore=*.o,*.obj
8888< The use of |:set+=| and |:set-=| is preferred when adding or removing
8889 a pattern from the list. This avoids problems when a future version
8890 uses another default.
8891
Bram Moolenaar94950a92010-12-02 16:01:29 +01008892
Bram Moolenaar81af9252010-12-10 20:35:50 +01008893 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008894'wildignorecase' 'wic' boolean (default off)
8895 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008896 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008897 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008898 Does not apply when the shell is used to expand wildcards, which
8899 happens when there are special characters.
8900
8901
Bram Moolenaar071d4272004-06-13 20:20:40 +00008902 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008903'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008905 {not available if compiled without the |+wildmenu|
8906 feature}
8907 When 'wildmenu' is on, command-line completion operates in an enhanced
8908 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8909 the possible matches are shown just above the command line, with the
8910 first match highlighted (overwriting the status line, if there is
8911 one). Keys that show the previous/next match, such as <Tab> or
8912 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8913 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8914 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008915 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 If there are more matches than can fit in the line, a ">" is shown on
8917 the right and/or a "<" is shown on the left. The status line scrolls
8918 as needed.
8919 The "wildmenu" mode is abandoned when a key is hit that is not used
8920 for selecting a completion.
8921 While the "wildmenu" is active the following keys have special
8922 meanings:
8923
8924 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8925 <Down> - in filename/menu name completion: move into a
8926 subdirectory or submenu.
8927 <CR> - in menu completion, when the cursor is just after a
8928 dot: move into a submenu.
8929 <Up> - in filename/menu name completion: move up into
8930 parent directory or parent menu.
8931
8932 This makes the menus accessible from the console |console-menus|.
8933
8934 If you prefer the <Left> and <Right> keys to move the cursor instead
8935 of selecting a different match, use this: >
8936 :cnoremap <Left> <Space><BS><Left>
8937 :cnoremap <Right> <Space><BS><Right>
8938<
8939 The "WildMenu" highlighting is used for displaying the current match
8940 |hl-WildMenu|.
8941
8942 *'wildmode'* *'wim'*
8943'wildmode' 'wim' string (Vim default: "full")
8944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008945 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008946 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008947 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 first part specifies the behavior for the first use of 'wildchar',
8949 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008950
8951 Each part consists of a colon separated list consisting of the
8952 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008953 "" Complete only the first match.
8954 "full" Complete the next full match. After the last match,
8955 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008956 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 "longest" Complete till longest common string. If this doesn't
8958 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008959 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008960 "lastused" When completing buffer names and more than one buffer
8961 matches, sort buffers by time last used (other than
8962 the current buffer).
8963 When there is only a single match, it is fully completed in all cases.
8964
8965 Examples of useful colon-separated values:
8966 "longest:full" Like "longest", but also start 'wildmenu' if it is
8967 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 "list:full" When more than one match, list all matches and
8969 complete first match.
8970 "list:longest" When more than one match, list all matches and
8971 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008972 "list:lastused" When more than one buffer matches, list all matches
8973 and sort buffers by time last used (other than the
8974 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975
8976 Examples: >
8977 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008978< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008979 :set wildmode=longest,full
8980< Complete longest common string, then each full match >
8981 :set wildmode=list:full
8982< List all matches and complete each full match >
8983 :set wildmode=list,full
8984< List all matches without completing, then each full match >
8985 :set wildmode=longest,list
8986< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008987 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008988
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008989 *'wildoptions'* *'wop'*
8990'wildoptions' 'wop' string (default "")
8991 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008992 {not available when compiled without the |+wildignore|
8993 feature}
8994 A list of words that change how command line completion is done.
8995 Currently only one word is allowed:
8996 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008997 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008998 is displayed per line. Often used tag kinds are:
8999 d #define
9000 f function
9001 Also see |cmdline-completion|.
9002
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003 *'winaltkeys'* *'wak'*
9004'winaltkeys' 'wak' string (default "menu")
9005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006 {only used in Win32, Motif, GTK and Photon GUI}
9007 Some GUI versions allow the access to menu entries by using the ALT
9008 key in combination with a character that appears underlined in the
9009 menu. This conflicts with the use of the ALT key for mappings and
9010 entering special characters. This option tells what to do:
9011 no Don't use ALT keys for menus. ALT key combinations can be
9012 mapped, but there is no automatic handling. This can then be
9013 done with the |:simalt| command.
9014 yes ALT key handling is done by the windowing system. ALT key
9015 combinations cannot be mapped.
9016 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009017 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009018 keys can be mapped.
9019 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9020 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009021 This option is not used for <F10>; on Win32 and with GTK <F10> will
9022 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009024 *'wincolor'* *'wcr'*
9025'wincolor' 'wcr' string (default empty)
9026 local to window
9027 Highlight group name to use for this window instead of the Normal
9028 color |hl-Normal|.
9029
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009030 *'window'* *'wi'*
9031'window' 'wi' number (default screen height - 1)
9032 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009033 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9034 window and the value is smaller than 'lines' minus one. The screen
9035 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009036 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9037 in a much smarter way, taking care of wrapping lines.
9038 When resizing the Vim window, the value is smaller than 1 or more than
9039 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009040 Note: Do not confuse this with the height of the Vim window, use
9041 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009042
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043 *'winheight'* *'wh'* *E591*
9044'winheight' 'wh' number (default 1)
9045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009046 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009047 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009048 focus goes to a window that is smaller, its size is increased, at the
9049 cost of the height of other windows.
9050 Set 'winheight' to a small number for normal editing.
9051 Set it to 999 to make the current window fill most of the screen.
9052 Other windows will be only 'winminheight' high. This has the drawback
9053 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9054 to create only two windows, set the option after startup is done,
9055 using the |VimEnter| event: >
9056 au VimEnter * set winheight=999
9057< Minimum value is 1.
9058 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059 height of the current window.
9060 'winheight' applies to the current window. Use 'winminheight' to set
9061 the minimal height for other windows.
9062
9063 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9064'winfixheight' 'wfh' boolean (default off)
9065 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009066 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009067 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9068 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069 The height may be changed anyway when running out of room.
9070
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009071 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9072'winfixwidth' 'wfw' boolean (default off)
9073 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009074 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009075 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009076 The width may be changed anyway when running out of room.
9077
Bram Moolenaar071d4272004-06-13 20:20:40 +00009078 *'winminheight'* *'wmh'*
9079'winminheight' 'wmh' number (default 1)
9080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009081 The minimal height of a window, when it's not the current window.
9082 This is a hard minimum, windows will never become smaller.
9083 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9084 status bar) if necessary. They will return to at least one line when
9085 they become active (since the cursor has to have somewhere to go.)
9086 Use 'winheight' to set the minimal height of the current window.
9087 This option is only checked when making a window smaller. Don't use a
9088 large number, it will cause errors when opening more than a few
9089 windows. A value of 0 to 3 is reasonable.
9090
9091 *'winminwidth'* *'wmw'*
9092'winminwidth' 'wmw' number (default 1)
9093 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 The minimal width of a window, when it's not the current window.
9095 This is a hard minimum, windows will never become smaller.
9096 When set to zero, windows may be "squashed" to zero columns (i.e. just
9097 a vertical separator) if necessary. They will return to at least one
9098 line when they become active (since the cursor has to have somewhere
9099 to go.)
9100 Use 'winwidth' to set the minimal width of the current window.
9101 This option is only checked when making a window smaller. Don't use a
9102 large number, it will cause errors when opening more than a few
9103 windows. A value of 0 to 12 is reasonable.
9104
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009105 *'winptydll'*
9106'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9107 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009108 {only available when compiled with the |terminal|
9109 feature on MS-Windows}
9110 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009111 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009112 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009113 a fallback.
9114 Environment variables are expanded |:set_env|.
9115 This option cannot be set from a |modeline| or in the |sandbox|, for
9116 security reasons.
9117
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118 *'winwidth'* *'wiw'* *E592*
9119'winwidth' 'wiw' number (default 20)
9120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121 Minimal number of columns for the current window. This is not a hard
9122 minimum, Vim will use fewer columns if there is not enough room. If
9123 the current window is smaller, its size is increased, at the cost of
9124 the width of other windows. Set it to 999 to make the current window
9125 always fill the screen. Set it to a small number for normal editing.
9126 The width is not adjusted after one of the commands to change the
9127 width of the current window.
9128 'winwidth' applies to the current window. Use 'winminwidth' to set
9129 the minimal width for other windows.
9130
9131 *'wrap'* *'nowrap'*
9132'wrap' boolean (default on)
9133 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009134 This option changes how text is displayed. It doesn't change the text
9135 in the buffer, see 'textwidth' for that.
9136 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009137 displaying continues on the next line. When off lines will not wrap
9138 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139 moved to a part that is not shown, the screen will scroll
9140 horizontally.
9141 The line will be broken in the middle of a word if necessary. See
9142 'linebreak' to get the break at a word boundary.
9143 To make scrolling horizontally a bit more useful, try this: >
9144 :set sidescroll=5
9145 :set listchars+=precedes:<,extends:>
9146< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009147 This option can't be set from a |modeline| when the 'diff' option is
9148 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009149
9150 *'wrapmargin'* *'wm'*
9151'wrapmargin' 'wm' number (default 0)
9152 local to buffer
9153 Number of characters from the right window border where wrapping
9154 starts. When typing text beyond this limit, an <EOL> will be inserted
9155 and inserting continues on the next line.
9156 Options that add a margin, such as 'number' and 'foldcolumn', cause
9157 the text width to be further reduced. This is Vi compatible.
9158 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009159 This option is set to 0 when 'paste' is set and restored when 'paste'
9160 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009161 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009162
9163 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9164'wrapscan' 'ws' boolean (default on) *E384* *E385*
9165 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009166 Searches wrap around the end of the file. Also applies to |]s| and
9167 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009168
9169 *'write'* *'nowrite'*
9170'write' boolean (default on)
9171 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172 Allows writing files. When not set, writing a file is not allowed.
9173 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009174 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009175 argument. Filtering text is still possible, even though this requires
9176 writing a temporary file.
9177
9178 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9179'writeany' 'wa' boolean (default off)
9180 global
9181 Allows writing to any file with no need for "!" override.
9182
9183 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9184'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9185 otherwise)
9186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187 Make a backup before overwriting a file. The backup is removed after
9188 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009189 also on.
9190 WARNING: Switching this option off means that when Vim fails to write
9191 your buffer correctly and then, for whatever reason, Vim exits, you
9192 lose both the original file and what you were writing. Only reset
9193 this option if your file system is almost full and it makes the write
9194 fail (and make sure not to exit Vim until the write was successful).
9195 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009197 Depending on 'backupcopy' the backup is a new file or the original
9198 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009199 NOTE: This option is set to the default value when 'compatible' is
9200 set.
9201
9202 *'writedelay'* *'wd'*
9203'writedelay' 'wd' number (default 0)
9204 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009205 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009206 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009207 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009209 vim:tw=78:ts=8:noet:ft=help:norl: