blob: f0939e61bb0d146acbd4d58c89b304336ec29d9d [file] [log] [blame]
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00001*options.txt* For Vim version 8.2. Last change: 2021 Dec 21
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')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000388 let &tagfunc = Fn
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000389 " 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
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001228 If the expression starts with s: or |<SID>|, then it is replaced with
1229 the script ID (|local-function|). Example: >
1230 set bexpr=s:MyBalloonExpr()
1231 set bexpr=<SID>SomeBalloonExpr()
1232<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001233 The expression will be evaluated in the |sandbox| when set from a
1234 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001235 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001236
1237 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001238 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001239
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001240 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001241 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001242< When they are supported "\n" characters will start a new line. If the
1243 expression evaluates to a |List| this is equal to using each List item
1244 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001245 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001246
Bram Moolenaar165bc692015-07-21 17:53:25 +02001247 *'belloff'* *'bo'*
1248'belloff' 'bo' string (default "")
1249 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001250 Specifies for which events the bell will not be rung. It is a comma
1251 separated list of items. For each item that is present, the bell
1252 will be silenced. This is most useful to specify specific events in
1253 insert mode to be silenced.
1254
1255 item meaning when present ~
1256 all All events.
1257 backspace When hitting <BS> or <Del> and deleting results in an
1258 error.
1259 cursor Fail to move around using the cursor keys or
1260 <PageUp>/<PageDown> in |Insert-mode|.
1261 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1262 |i_CTRL-X_CTRL-T|.
1263 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1264 |i_CTRL-E|.
1265 ctrlg Unknown Char after <C-G> in Insert mode.
1266 error Other Error occurred (e.g. try to join last line)
1267 (mostly used in |Normal-mode| or |Cmdline-mode|).
1268 esc hitting <Esc> in |Normal-mode|.
1269 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001270 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001271 insertmode Pressing <Esc> in 'insertmode'.
1272 lang Calling the beep module for Lua/Mzscheme/TCL.
1273 mess No output available for |g<|.
1274 showmatch Error occurred for 'showmatch' function.
1275 operator Empty region error |cpo-E|.
1276 register Unknown register after <C-R> in |Insert-mode|.
1277 shell Bell from shell output |:!|.
1278 spell Error happened on spell suggest.
1279 wildmode More matches in |cmdline-completion| available
1280 (depends on the 'wildmode' setting).
1281
Bram Moolenaar036986f2017-03-16 17:41:02 +01001282 This is most useful to fine tune when in Insert mode the bell should
1283 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001284 indicate that an error occurred. It can be silenced by adding the
1285 "error" keyword.
1286
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1288'binary' 'bin' boolean (default off)
1289 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 This option should be set before editing a binary file. You can also
1291 use the |-b| Vim argument. When this option is switched on a few
1292 options will be changed (also when it already was on):
1293 'textwidth' will be set to 0
1294 'wrapmargin' will be set to 0
1295 'modeline' will be off
1296 'expandtab' will be off
1297 Also, 'fileformat' and 'fileformats' options will not be used, the
1298 file is read and written like 'fileformat' was "unix" (a single <NL>
1299 separates lines).
1300 The 'fileencoding' and 'fileencodings' options will not be used, the
1301 file is read without conversion.
1302 NOTE: When you start editing a(nother) file while the 'bin' option is
1303 on, settings from autocommands may change the settings again (e.g.,
1304 'textwidth'), causing trouble when editing. You might want to set
1305 'bin' again when the file has been loaded.
1306 The previous values of these options are remembered and restored when
1307 'bin' is switched from on to off. Each buffer has its own set of
1308 saved option values.
1309 To edit a file with 'binary' set you can use the |++bin| argument.
1310 This avoids you have to do ":set bin", which would have effect for all
1311 files you edit.
1312 When writing a file the <EOL> for the last line is only written if
1313 there was one in the original file (normally Vim appends an <EOL> to
1314 the last line if there is none; this would make the file longer). See
1315 the 'endofline' option.
1316
1317 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1318'bioskey' 'biosk' boolean (default on)
1319 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001320 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001321 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322
1323 *'bomb'* *'nobomb'*
1324'bomb' boolean (default off)
1325 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 When writing a file and the following conditions are met, a BOM (Byte
1327 Order Mark) is prepended to the file:
1328 - this option is on
1329 - the 'binary' option is off
1330 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1331 endian variants.
1332 Some applications use the BOM to recognize the encoding of the file.
1333 Often used for UCS-2 files on MS-Windows. For other applications it
1334 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001335 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1337 check for the presence of the BOM is done and 'bomb' set accordingly.
1338 Unless 'binary' is set, it is removed from the first line, so that you
1339 don't see it when editing. When you don't change the options, the BOM
1340 will be restored when writing the file.
1341
1342 *'breakat'* *'brk'*
1343'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1344 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001345 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 feature}
1347 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001348 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1349 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001351 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001352'breakindent' 'bri' boolean (default off)
1353 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001354 {not available when compiled without the |+linebreak|
1355 feature}
1356 Every wrapped line will continue visually indented (same amount of
1357 space as the beginning of that line), thus preserving horizontal blocks
1358 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001359 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001360
1361 *'breakindentopt'* *'briopt'*
1362'breakindentopt' 'briopt' string (default empty)
1363 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001364 {not available when compiled without the |+linebreak|
1365 feature}
1366 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001367 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001368 min:{n} Minimum text width that will be kept after
1369 applying 'breakindent', even if the resulting
1370 text should normally be narrower. This prevents
1371 text indented almost to the right window border
1372 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001373 shift:{n} After applying 'breakindent', the wrapped line's
1374 beginning will be shifted by the given number of
1375 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001376 indentation (negative) or emphasizing the line
1377 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001378 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001379 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001380 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001381 numbered or bulleted list (using the
1382 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001383 list:-1 Uses the length of a match with 'formatlistpat'
1384 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001385 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001386
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001388'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001390 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001392 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001393 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 buffer Use the directory of the related buffer.
1395 current Use the current directory.
1396 {path} Use the specified directory
1397
1398 *'bufhidden'* *'bh'*
1399'bufhidden' 'bh' string (default: "")
1400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 This option specifies what happens when a buffer is no longer
1402 displayed in a window:
1403 <empty> follow the global 'hidden' option
1404 hide hide the buffer (don't unload it), also when 'hidden'
1405 is not set
1406 unload unload the buffer, also when 'hidden' is set or using
1407 |:hide|
1408 delete delete the buffer from the buffer list, also when
1409 'hidden' is set or using |:hide|, like using
1410 |:bdelete|
1411 wipe wipe out the buffer from the buffer list, also when
1412 'hidden' is set or using |:hide|, like using
1413 |:bwipeout|
1414
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001415 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001416 are lost without a warning. Also, these values may break autocommands
1417 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418 This option is used together with 'buftype' and 'swapfile' to specify
1419 special kinds of buffers. See |special-buffers|.
1420
1421 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1422'buflisted' 'bl' boolean (default: on)
1423 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 When this option is set, the buffer shows up in the buffer list. If
1425 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1426 This option is reset by Vim for buffers that are only used to remember
1427 a file name or marks. Vim sets it when starting to edit a buffer.
1428 But not when moving to a buffer with ":buffer".
1429
1430 *'buftype'* *'bt'* *E382*
1431'buftype' 'bt' string (default: "")
1432 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 The value of this option specifies the type of a buffer:
1434 <empty> normal buffer
1435 nofile buffer which is not related to a file and will not be
1436 written
1437 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001438 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001439 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001441 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 help help buffer (you are not supposed to set this
1443 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001444 terminal buffer for a |terminal| (you are not supposed to set
1445 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001446 prompt buffer where only the last line can be edited, meant
1447 to be used by a plugin, see |prompt-buffer|
1448 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001449 popup buffer used in a popup window, see |popup|.
1450 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451
1452 This option is used together with 'bufhidden' and 'swapfile' to
1453 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001454 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455
1456 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001457 One such effect is that Vim will not check the timestamp of the file,
1458 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459
Bram Moolenaar280f1262006-01-30 00:14:18 +00001460 A "quickfix" buffer is only used for the error list and the location
1461 list. This value is set by the |:cwindow| and |:lwindow| commands and
1462 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463
1464 "nofile" and "nowrite" buffers are similar:
1465 both: The buffer is not to be written to disk, ":w" doesn't
1466 work (":w filename" does work though).
1467 both: The buffer is never considered to be |'modified'|.
1468 There is no warning when the changes will be lost, for
1469 example when you quit Vim.
1470 both: A swap file is only created when using too much memory
1471 (when 'swapfile' has been reset there is never a swap
1472 file).
1473 nofile only: The buffer name is fixed, it is not handled like a
1474 file name. It is not modified in response to a |:cd|
1475 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001476 both: When using ":e bufname" and already editing "bufname"
1477 the buffer is made empty and autocommands are
1478 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001479 *E676*
1480 "acwrite" implies that the buffer name is not related to a file, like
1481 "nofile", but it will be written. Thus, in contrast to "nofile" and
1482 "nowrite", ":w" does work and a modified buffer can't be abandoned
1483 without saving. For writing there must be matching |BufWriteCmd|,
1484 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485
1486 *'casemap'* *'cmp'*
1487'casemap' 'cmp' string (default: "internal,keepascii")
1488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 Specifies details about changing the case of letters. It may contain
1490 these words, separated by a comma:
1491 internal Use internal case mapping functions, the current
1492 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001493 matters when 'encoding' is a Unicode encoding,
1494 "latin1" or "iso-8859-15". When "internal" is
1495 omitted, the towupper() and towlower() system library
1496 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1498 case mapping, the current locale is not effective.
1499 This probably only matters for Turkish.
1500
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001501 *'cdhome'* *'cdh'*
1502'cdhome' 'cdh' boolean (default: off)
1503 global
1504 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1505 current working directory to the |$HOME| directory like in Unix.
1506 When off, those commands just print the current directory name.
1507 On Unix this option has no effect.
1508 NOTE: This option is reset when 'compatible' is set.
1509
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 *'cdpath'* *'cd'* *E344* *E346*
1511'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 {not available when compiled without the
1514 |+file_in_path| feature}
1515 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001516 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1517 searched for has a relative path, not an absolute part starting with
1518 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 The 'cdpath' option's value has the same form and semantics as
1520 |'path'|. Also see |file-searching|.
1521 The default value is taken from $CDPATH, with a "," prepended to look
1522 in the current directory first.
1523 If the default value taken from $CDPATH is not what you want, include
1524 a modified version of the following command in your vimrc file to
1525 override it: >
1526 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1527< This option cannot be set from a |modeline| or in the |sandbox|, for
1528 security reasons.
1529 (parts of 'cdpath' can be passed to the shell to expand file names).
1530
1531 *'cedit'*
1532'cedit' string (Vi default: "", Vim default: CTRL-F)
1533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 The key used in Command-line Mode to open the command-line window.
1535 The default is CTRL-F when 'compatible' is off.
1536 Only non-printable keys are allowed.
1537 The key can be specified as a single character, but it is difficult to
1538 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001539 :exe "set cedit=\<C-Y>"
1540 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541< |Nvi| also has this option, but it only uses the first character.
1542 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001543 NOTE: This option is set to the Vim default value when 'compatible'
1544 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545
1546 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1547'charconvert' 'ccv' string (default "")
1548 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001549 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 An expression that is used for character encoding conversion. It is
1551 evaluated when a file that is to be read or has been written has a
1552 different encoding from what is desired.
1553 'charconvert' is not used when the internal iconv() function is
1554 supported and is able to do the conversion. Using iconv() is
1555 preferred, because it is much faster.
1556 'charconvert' is not used when reading stdin |--|, because there is no
1557 file to convert from. You will have to save the text in a file first.
1558 The expression must return zero or an empty string for success,
1559 non-zero for failure.
1560 The possible encoding names encountered are in 'encoding'.
1561 Additionally, names given in 'fileencodings' and 'fileencoding' are
1562 used.
1563 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1564 is done internally by Vim, 'charconvert' is not used for this.
1565 'charconvert' is also used to convert the viminfo file, if the 'c'
1566 flag is present in 'viminfo'. Also used for Unicode conversion.
1567 Example: >
1568 set charconvert=CharConvert()
1569 fun CharConvert()
1570 system("recode "
1571 \ . v:charconvert_from . ".." . v:charconvert_to
1572 \ . " <" . v:fname_in . " >" v:fname_out)
1573 return v:shell_error
1574 endfun
1575< The related Vim variables are:
1576 v:charconvert_from name of the current encoding
1577 v:charconvert_to name of the desired encoding
1578 v:fname_in name of the input file
1579 v:fname_out name of the output file
1580 Note that v:fname_in and v:fname_out will never be the same.
1581 Note that v:charconvert_from and v:charconvert_to may be different
1582 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1583 Encryption is not done by Vim when using 'charconvert'. If you want
1584 to encrypt the file after conversion, 'charconvert' should take care
1585 of this.
1586 This option cannot be set from a |modeline| or in the |sandbox|, for
1587 security reasons.
1588
1589 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1590'cindent' 'cin' boolean (default off)
1591 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 {not available when compiled without the |+cindent|
1593 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001594 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 that trigger reindenting in insert mode and 'cinoptions' to set your
1596 preferred indent style.
1597 If 'indentexpr' is not empty, it overrules 'cindent'.
1598 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1599 the "=" operator indents using this algorithm rather than calling an
1600 external program.
1601 See |C-indenting|.
1602 When you don't like the way 'cindent' works, try the 'smartindent'
1603 option or 'indentexpr'.
1604 This option is not used when 'paste' is set.
1605 NOTE: This option is reset when 'compatible' is set.
1606
1607 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001608'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 {not available when compiled without the |+cindent|
1611 feature}
1612 A list of keys that, when typed in Insert mode, cause reindenting of
1613 the current line. Only used if 'cindent' is on and 'indentexpr' is
1614 empty.
1615 For the format of this option see |cinkeys-format|.
1616 See |C-indenting|.
1617
1618 *'cinoptions'* *'cino'*
1619'cinoptions' 'cino' string (default "")
1620 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 {not available when compiled without the |+cindent|
1622 feature}
1623 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1624 program. See |cinoptions-values| for the values of this option, and
1625 |C-indenting| for info on C indenting in general.
1626
1627
1628 *'cinwords'* *'cinw'*
1629'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1630 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 {not available when compiled without both the
1632 |+cindent| and the |+smartindent| features}
1633 These keywords start an extra indent in the next line when
1634 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1635 an appropriate place (inside {}).
1636 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1637 matter, include the keyword both the uppercase and lowercase:
1638 "if,If,IF".
1639
1640 *'clipboard'* *'cb'*
1641'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1642 for X-windows, "" otherwise)
1643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 {only in GUI versions or when the |+xterm_clipboard|
1645 feature is included}
1646 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001647 Note: if one of the items is "exclude:", then you can't add an item
1648 after that. Therefore do append an item with += but use ^= to
1649 prepend, e.g.: >
1650 set clipboard^=unnamed
1651< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001653 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654 unnamed When included, Vim will use the clipboard register '*'
1655 for all yank, delete, change and put operations which
1656 would normally go to the unnamed register. When a
1657 register is explicitly specified, it will always be
1658 used regardless of whether "unnamed" is in 'clipboard'
1659 or not. The clipboard register can always be
1660 explicitly accessed using the "* notation. Also see
1661 |gui-clipboard|.
1662
Bram Moolenaar30b65812012-07-12 22:01:11 +02001663 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001664 unnamedplus A variant of the "unnamed" flag which uses the
1665 clipboard register '+' (|quoteplus|) instead of
1666 register '*' for all yank, delete, change and put
1667 operations which would normally go to the unnamed
1668 register. When "unnamed" is also included to the
1669 option, yank operations (but not delete, change or
1670 put) will additionally copy the text into register
1671 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001672 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001673 Availability can be checked with: >
1674 if has('unnamedplus')
1675<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001676 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 autoselect Works like the 'a' flag in 'guioptions': If present,
1678 then whenever Visual mode is started, or the Visual
1679 area extended, Vim tries to become the owner of the
1680 windowing system's global selection or put the
1681 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001682 register "*. See |'go-a'| and |quotestar| for details.
1683 When the GUI is active, the 'a' flag in 'guioptions'
1684 is used, when the GUI is not active, this "autoselect"
1685 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 Also applies to the modeless selection.
1687
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001688 *clipboard-autoselectplus*
1689 autoselectplus Like "autoselect" but using the + register instead of
1690 the * register. Compare to the 'P' flag in
1691 'guioptions'.
1692
1693 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 autoselectml Like "autoselect", but for the modeless selection
1695 only. Compare to the 'A' flag in 'guioptions'.
1696
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001697 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001698 html When the clipboard contains HTML, use this when
1699 pasting. When putting text on the clipboard, mark it
1700 as HTML. This works to copy rendered HTML from
1701 Firefox, paste it as raw HTML in Vim, select the HTML
1702 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001703 You probably want to add this only temporarily,
1704 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001705 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001706
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001707 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 exclude:{pattern}
1709 Defines a pattern that is matched against the name of
1710 the terminal 'term'. If there is a match, no
1711 connection will be made to the X server. This is
1712 useful in this situation:
1713 - Running Vim in a console.
1714 - $DISPLAY is set to start applications on another
1715 display.
1716 - You do not want to connect to the X server in the
1717 console, but do want this in a terminal emulator.
1718 To never connect to the X server use: >
1719 exclude:.*
1720< This has the same effect as using the |-X| argument.
1721 Note that when there is no connection to the X server
1722 the window title won't be restored and the clipboard
1723 cannot be accessed.
1724 The value of 'magic' is ignored, {pattern} is
1725 interpreted as if 'magic' was on.
1726 The rest of the option value will be used for
1727 {pattern}, this must be the last entry.
1728
1729 *'cmdheight'* *'ch'*
1730'cmdheight' 'ch' number (default 1)
1731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 Number of screen lines to use for the command-line. Helps avoiding
1733 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001734 The value of this option is stored with the tab page, so that each tab
1735 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736
1737 *'cmdwinheight'* *'cwh'*
1738'cmdwinheight' 'cwh' number (default 7)
1739 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 Number of screen lines to use for the command-line window. |cmdwin|
1741
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001742 *'colorcolumn'* *'cc'*
1743'colorcolumn' 'cc' string (default "")
1744 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001745 {not available when compiled without the |+syntax|
1746 feature}
1747 'colorcolumn' is a comma separated list of screen columns that are
1748 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1749 text. Will make screen redrawing slower.
1750 The screen column can be an absolute number, or a number preceded with
1751 '+' or '-', which is added to or subtracted from 'textwidth'. >
1752
1753 :set cc=+1 " highlight column after 'textwidth'
1754 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1755 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1756<
1757 When 'textwidth' is zero then the items with '-' and '+' are not used.
1758 A maximum of 256 columns are highlighted.
1759
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 *'columns'* *'co'* *E594*
1761'columns' 'co' number (default 80 or terminal width)
1762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001764 initialization and does not have to be set by hand. Also see
1765 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 When Vim is running in the GUI or in a resizable window, setting this
1767 option will cause the window size to be changed. When you only want
1768 to use the size for the GUI, put the command in your |gvimrc| file.
1769 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001770 number of columns of the display, the display may be messed up. For
1771 the GUI it is always possible and Vim limits the number of columns to
1772 what fits on the screen. You can use this command to get the widest
1773 window possible: >
1774 :set columns=9999
1775< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776
1777 *'comments'* *'com'* *E524* *E525*
1778'comments' 'com' string (default
1779 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1780 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 A comma separated list of strings that can start a comment line. See
1782 |format-comments|. See |option-backslash| about using backslashes to
1783 insert a space.
1784
1785 *'commentstring'* *'cms'* *E537*
1786'commentstring' 'cms' string (default "/*%s*/")
1787 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 {not available when compiled without the |+folding|
1789 feature}
1790 A template for a comment. The "%s" in the value is replaced with the
1791 comment text. Currently only used to add markers for folding, see
1792 |fold-marker|.
1793
1794 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001795'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001796 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 This option has the effect of making Vim either more Vi-compatible, or
1799 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001800
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001802 other options are also changed as a side effect.
1803 NOTE: Setting or resetting this option can have a lot of unexpected
1804 effects: Mappings are interpreted in another way, undo behaves
1805 differently, etc. If you set this option in your vimrc file, you
1806 should probably put it at the very start.
1807
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 By default this option is on and the Vi defaults are used for the
1809 options. This default was chosen for those people who want to use Vim
1810 just like Vi, and don't even (want to) know about the 'compatible'
1811 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001812 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001813 this option is switched off, and all options that have not been
1814 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001815 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001816 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001817 happen for the system-wide vimrc or gvimrc file, nor for a file given
1818 with the |-u| argument). Also see |compatible-default| and
1819 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 You can also set this option with the "-C" argument, and reset it with
1821 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001822 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823
Bram Moolenaar214641f2017-03-05 17:04:09 +01001824 When this option is set, numerous other options are set to make Vim as
1825 Vi-compatible as possible. When this option is unset, various options
1826 are set to make Vim more useful. The table below lists all the
1827 options affected.
1828 The {?} column indicates when the options are affected:
1829 + Means that the option is set to the value given in {set value} when
1830 'compatible' is set.
1831 & Means that the option is set to the value given in {set value} when
1832 'compatible' is set AND is set to its Vim default value when
1833 'compatible' is unset.
1834 - Means the option is NOT changed when setting 'compatible' but IS
1835 set to its Vim default when 'compatible' is unset.
1836 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837
Bram Moolenaar036986f2017-03-16 17:41:02 +01001838 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001839
1840 'allowrevins' + off no CTRL-_ command
1841 'antialias' + off don't use antialiased fonts
1842 'arabic' + off reset arabic-related options
1843 'arabicshape' + on correct character shapes
1844 'backspace' + "" normal backspace
1845 'backup' + off no backup file
1846 'backupcopy' & Unix: "yes" backup file is a copy
1847 else: "auto" copy or rename backup file
1848 'balloonexpr' + "" text to show in evaluation balloon
1849 'breakindent' + off don't indent when wrapping lines
1850 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001851 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001852 'cindent' + off no C code indentation
1853 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1854 'copyindent' + off don't copy indent structure
1855 'cpoptions' & (all flags) Vi-compatible flags
1856 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001857 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001858 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001859 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001860 'cscopeverbose' + off see |cscopeverbose|
1861 'delcombine' + off unicode: delete whole char combination
1862 'digraph' + off no digraphs
1863 'esckeys' & off no <Esc>-keys in Insert mode
1864 'expandtab' + off tabs not expanded to spaces
1865 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001866 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001867 'formatexpr' + "" use 'formatprg' for auto-formatting
1868 'formatoptions' & "vt" Vi compatible formatting
1869 'gdefault' + off no default 'g' flag for ":s"
1870 'history' & 0 no commandline history
1871 'hkmap' + off no Hebrew keyboard mapping
1872 'hkmapp' + off no phonetic Hebrew keyboard mapping
1873 'hlsearch' + off no highlighting of search matches
1874 'incsearch' + off no incremental searching
1875 'indentexpr' + "" no indenting by expression
1876 'insertmode' + off do not start in Insert mode
1877 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001879 'joinspaces' + on insert 2 spaces after period
1880 'modeline' & off no modelines
1881 'more' & off no pauses in listings
1882 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1883 'numberwidth' & 8 min number of columns for line number
1884 'preserveindent'+ off don't preserve current indent structure
1885 when changing it
1886 'revins' + off no reverse insert
1887 'ruler' + off no ruler
1888 'scrolljump' + 1 no jump scroll
1889 'scrolloff' + 0 no scroll offset
1890 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1891 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001892 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001893 'showcmd' & off command characters not shown
1894 'showmode' & off current mode not shown
1895 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1896 'smartcase' + off no automatic ignore case switch
1897 'smartindent' + off no smart indentation
1898 'smarttab' + off no smart tab size
1899 'softtabstop' + 0 tabs are always 'tabstop' positions
1900 'startofline' + on goto startofline with some commands
1901 'tagcase' & "followic" 'ignorecase' when searching tags file
1902 'tagrelative' & off tag file names are not relative
1903 'termguicolors' + off don't use highlight-(guifg|guibg)
1904 'textauto' & off no automatic textmode detection
1905 'textwidth' + 0 no automatic line wrap
1906 'tildeop' + off tilde is not an operator
1907 'ttimeout' + off no terminal timeout
1908 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001909 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001910 'virtualedit' + "" cursor can only be placed on characters
1911 'whichwrap' & "" left-right movements don't wrap
1912 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001914 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915
1916 *'complete'* *'cpt'* *E535*
1917'complete' 'cpt' string (default: ".,w,b,u,t,i")
1918 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 This option specifies how keyword completion |ins-completion| works
1920 when CTRL-P or CTRL-N are used. It is also used for whole-line
1921 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1922 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001923 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 w scan buffers from other windows
1925 b scan other loaded buffers that are in the buffer list
1926 u scan the unloaded buffers that are in the buffer list
1927 U scan the buffers that are not in the buffer list
1928 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001929 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 k{dict} scan the file {dict}. Several "k" flags can be given,
1931 patterns are valid too. For example: >
1932 :set cpt=k/usr/dict/*,k~/spanish
1933< s scan the files given with the 'thesaurus' option
1934 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1935 are valid too.
1936 i scan current and included files
1937 d scan current and included files for defined name or macro
1938 |i_CTRL-X_CTRL-D|
1939 ] tag completion
1940 t same as "]"
1941
1942 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1943 not executed, this may lead to unexpected completions from some files
1944 (gzipped files for example). Unloaded buffers are not scanned for
1945 whole-line completion.
1946
1947 The default is ".,w,b,u,t,i", which means to scan:
1948 1. the current buffer
1949 2. buffers in other windows
1950 3. other loaded buffers
1951 4. unloaded buffers
1952 5. tags
1953 6. included files
1954
1955 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001956 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1957 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001959 *'completefunc'* *'cfu'*
1960'completefunc' 'cfu' string (default: empty)
1961 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001962 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001963 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001964 This option specifies a function to be used for Insert mode completion
1965 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001966 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001967 invoked and what it should return. The value can be the name of a
1968 function, a |lambda| or a |Funcref|. See |option-value-function| for
1969 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001970 This option cannot be set from a |modeline| or in the |sandbox|, for
1971 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001972
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001973 *'completeslash'* *'csl'*
1974'completeslash' 'csl' string (default: "")
1975 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001976 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001977 When this option is set it overrules 'shellslash' for completion:
1978 - When this option is set to "slash", a forward slash is used for path
1979 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001980 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001981 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001982 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001983 - When this option is empty, same character is used as for
1984 'shellslash'.
1985 For Insert mode completion the buffer-local value is used. For
1986 command line completion the global value is used.
1987
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001988 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001989'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001990 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001991 A comma separated list of options for Insert mode completion
1992 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001993
1994 menu Use a popup menu to show the possible completions. The
1995 menu is only shown when there is more than one match and
1996 sufficient colors are available. |ins-completion-menu|
1997
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001998 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001999 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002000 match, e.g., what file it comes from.
2001
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002002 longest Only insert the longest common text of the matches. If
2003 the menu is displayed you can use CTRL-L to add more
2004 characters. Whether case is ignored depends on the kind
2005 of completion. For buffer text the 'ignorecase' option is
2006 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002007
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002008 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002009 completion in the preview window. Only works in
2010 combination with "menu" or "menuone".
2011
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002012 popup Show extra information about the currently selected
2013 completion in a popup window. Only works in combination
2014 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002015 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002016 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002017
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002018 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002019 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002020 |CompleteChanged| autocommand to fetch the info and call
2021 |popup_show()| once the popup has been filled.
2022 See the example at |complete-popuphidden|.
2023 {only works when compiled with the |+textprop| feature}
2024
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002025 noinsert Do not insert any text for a match until the user selects
2026 a match from the menu. Only works in combination with
2027 "menu" or "menuone". No effect if "longest" is present.
2028
2029 noselect Do not select a match in the menu, force the user to
2030 select one from the menu. Only works in combination with
2031 "menu" or "menuone".
2032
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002033
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002034 *'completepopup'* *'cpp'*
2035'completepopup' 'cpp' string (default empty)
2036 global
2037 {not available when compiled without the |+textprop|
2038 or |+quickfix| feature}
2039 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002040 properties of the info popup when it is created. If an info popup
2041 window already exists it is closed, so that the option value is
2042 applied when it is created again.
2043 You can also use |popup_findinfo()| and then set properties for an
2044 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002045
2046
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002047 *'concealcursor'* *'cocu'*
2048'concealcursor' 'cocu' string (default: "")
2049 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002050 {not available when compiled without the |+conceal|
2051 feature}
2052 Sets the modes in which text in the cursor line can also be concealed.
2053 When the current mode is listed then concealing happens just like in
2054 other lines.
2055 n Normal mode
2056 v Visual mode
2057 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002058 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002059
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002060 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002061 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002062 are moving around text is concealed, but when starting to insert text
2063 or selecting a Visual area the concealed text is displayed, so that
2064 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002065 Keep in mind that the cursor position is not always where it's
2066 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002067
2068
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002069 *'conceallevel'* *'cole'*
2070'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002071 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002072 {not available when compiled without the |+conceal|
2073 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002074 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2075 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002076
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002077 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002078 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002079 1 Each block of concealed text is replaced with one
2080 character. If the syntax item does not have a custom
2081 replacement character defined (see |:syn-cchar|) the
2082 character defined in 'listchars' is used (default is a
2083 space).
2084 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002085 2 Concealed text is completely hidden unless it has a
2086 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002087 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002088 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002089
Bram Moolenaara7781e02010-07-19 20:13:22 +02002090 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002091 edit and copy the text. This can be changed with the 'concealcursor'
2092 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002093
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2095'confirm' 'cf' boolean (default off)
2096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002097 When 'confirm' is on, certain operations that would normally
2098 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2099 instead raise a |dialog| asking if you wish to save the current
2100 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2101 If 'confirm' is off you can still activate confirmation for one
2102 command only (this is most useful in mappings) with the |:confirm|
2103 command.
2104 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2105
2106 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2107'conskey' 'consk' boolean (default off)
2108 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002109 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110
2111 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2112'copyindent' 'ci' boolean (default off)
2113 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114 Copy the structure of the existing lines indent when autoindenting a
2115 new line. Normally the new indent is reconstructed by a series of
2116 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2117 in which case only spaces are used). Enabling this option makes the
2118 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002119 existing line. 'expandtab' has no effect on these characters, a Tab
2120 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002122 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 Also see 'preserveindent'.
2124
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002125 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126'cpoptions' 'cpo' string (Vim default: "aABceFs",
2127 Vi default: all flags)
2128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002130 this indicates Vi-compatible behavior. This is used for things where
2131 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 'cpoptions' stands for "compatible-options".
2133 Commas can be added for readability.
2134 To avoid problems with flags that are added in the future, use the
2135 "+=" and "-=" feature of ":set" |add-option-flags|.
2136 NOTE: This option is set to the Vi default value when 'compatible' is
2137 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002138 NOTE: This option is set to the POSIX default value at startup when
2139 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002140 variable exists |posix|. This means Vim tries to behave like the
2141 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142
2143 contains behavior ~
2144 *cpo-a*
2145 a When included, a ":read" command with a file name
2146 argument will set the alternate file name for the
2147 current window.
2148 *cpo-A*
2149 A When included, a ":write" command with a file name
2150 argument will set the alternate file name for the
2151 current window.
2152 *cpo-b*
2153 b "\|" in a ":map" command is recognized as the end of
2154 the map command. The '\' is included in the mapping,
2155 the text after the '|' is interpreted as the next
2156 command. Use a CTRL-V instead of a backslash to
2157 include the '|' in the mapping. Applies to all
2158 mapping, abbreviation, menu and autocmd commands.
2159 See also |map_bar|.
2160 *cpo-B*
2161 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002162 abbreviations, user commands and the "to" part of the
2163 menu commands. Remove this flag to be able to use a
2164 backslash like a CTRL-V. For example, the command
2165 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 'B' included: "\^[" (^[ is a real <Esc>)
2167 'B' excluded: "<Esc>" (5 characters)
2168 ('<' excluded in both cases)
2169 *cpo-c*
2170 c Searching continues at the end of any match at the
2171 cursor position, but not further than the start of the
2172 next line. When not present searching continues
2173 one character from the cursor position. With 'c'
2174 "abababababab" only gets three matches when repeating
2175 "/abab", without 'c' there are five matches.
2176 *cpo-C*
2177 C Do not concatenate sourced lines that start with a
2178 backslash. See |line-continuation|.
2179 *cpo-d*
2180 d Using "./" in the 'tags' option doesn't mean to use
2181 the tags file relative to the current file, but the
2182 tags file in the current directory.
2183 *cpo-D*
2184 D Can't use CTRL-K to enter a digraph after Normal mode
2185 commands with a character argument, like |r|, |f| and
2186 |t|.
2187 *cpo-e*
2188 e When executing a register with ":@r", always add a
2189 <CR> to the last line, also when the register is not
2190 linewise. If this flag is not present, the register
2191 is not linewise and the last line does not end in a
2192 <CR>, then the last line is put on the command-line
2193 and can be edited before hitting <CR>.
2194 *cpo-E*
2195 E It is an error when using "y", "d", "c", "g~", "gu" or
2196 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002197 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 This makes "y0" fail in the first column.
2199 *cpo-f*
2200 f When included, a ":read" command with a file name
2201 argument will set the file name for the current buffer,
2202 if the current buffer doesn't have a file name yet.
2203 *cpo-F*
2204 F When included, a ":write" command with a file name
2205 argument will set the file name for the current
2206 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002207 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 *cpo-g*
2209 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002210 *cpo-H*
2211 H When using "I" on a line with only blanks, insert
2212 before the last blank. Without this flag insert after
2213 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 *cpo-i*
2215 i When included, interrupting the reading of a file will
2216 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002217 *cpo-I*
2218 I When moving the cursor up or down just after inserting
2219 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 *cpo-j*
2221 j When joining lines, only add two spaces after a '.',
2222 not after '!' or '?'. Also see 'joinspaces'.
2223 *cpo-J*
2224 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002225 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 white space.
2227 *cpo-k*
2228 k Disable the recognition of raw key codes in
2229 mappings, abbreviations, and the "to" part of menu
2230 commands. For example, if <Key> sends ^[OA (where ^[
2231 is <Esc>), the command ":map X ^[OA" results in X
2232 being mapped to:
2233 'k' included: "^[OA" (3 characters)
2234 'k' excluded: "<Key>" (one key code)
2235 Also see the '<' flag below.
2236 *cpo-K*
2237 K Don't wait for a key code to complete when it is
2238 halfway a mapping. This breaks mapping <F1><F1> when
2239 only part of the second <F1> has been read. It
2240 enables cancelling the mapping by typing <F1><Esc>.
2241 *cpo-l*
2242 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002243 literally, only "\]", "\^", "\-" and "\\" are special.
2244 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2246 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002247 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 *cpo-L*
2249 L When the 'list' option is set, 'wrapmargin',
2250 'textwidth', 'softtabstop' and Virtual Replace mode
2251 (see |gR|) count a <Tab> as two characters, instead of
2252 the normal behavior of a <Tab>.
2253 *cpo-m*
2254 m When included, a showmatch will always wait half a
2255 second. When not included, a showmatch will wait half
2256 a second or until a character is typed. |'showmatch'|
2257 *cpo-M*
2258 M When excluded, "%" matching will take backslashes into
2259 account. Thus in "( \( )" and "\( ( \)" the outer
2260 parenthesis match. When included "%" ignores
2261 backslashes, which is Vi compatible.
2262 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002263 n When included, the column used for 'number' and
2264 'relativenumber' will also be used for text of wrapped
2265 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 *cpo-o*
2267 o Line offset to search command is not remembered for
2268 next search.
2269 *cpo-O*
2270 O Don't complain if a file is being overwritten, even
2271 when it didn't exist when editing it. This is a
2272 protection against a file unexpectedly created by
2273 someone else. Vi didn't complain about this.
2274 *cpo-p*
2275 p Vi compatible Lisp indenting. When not present, a
2276 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002277 *cpo-P*
2278 P When included, a ":write" command that appends to a
2279 file will set the file name for the current buffer, if
2280 the current buffer doesn't have a file name yet and
2281 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002282 *cpo-q*
2283 q When joining multiple lines leave the cursor at the
2284 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 *cpo-r*
2286 r Redo ("." command) uses "/" to repeat a search
2287 command, instead of the actually used search string.
2288 *cpo-R*
2289 R Remove marks from filtered lines. Without this flag
2290 marks are kept like |:keepmarks| was used.
2291 *cpo-s*
2292 s Set buffer options when entering the buffer for the
2293 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002294 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 set when the buffer is created.
2296 *cpo-S*
2297 S Set buffer options always when entering a buffer
2298 (except 'readonly', 'fileformat', 'filetype' and
2299 'syntax'). This is the (most) Vi compatible setting.
2300 The options are set to the values in the current
2301 buffer. When you change an option and go to another
2302 buffer, the value is copied. Effectively makes the
2303 buffer options global to all buffers.
2304
2305 's' 'S' copy buffer options
2306 no no when buffer created
2307 yes no when buffer first entered (default)
2308 X yes each time when buffer entered (vi comp.)
2309 *cpo-t*
2310 t Search pattern for the tag command is remembered for
2311 "n" command. Otherwise Vim only puts the pattern in
2312 the history for search pattern, but doesn't change the
2313 last used search pattern.
2314 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002315 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 *cpo-v*
2317 v Backspaced characters remain visible on the screen in
2318 Insert mode. Without this flag the characters are
2319 erased from the screen right away. With this flag the
2320 screen newly typed text overwrites backspaced
2321 characters.
2322 *cpo-w*
2323 w When using "cw" on a blank character, only change one
2324 character and not all blanks until the start of the
2325 next word.
2326 *cpo-W*
2327 W Don't overwrite a readonly file. When omitted, ":w!"
2328 overwrites a readonly file, if possible.
2329 *cpo-x*
2330 x <Esc> on the command-line executes the command-line.
2331 The default in Vim is to abandon the command-line,
2332 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002333 *cpo-X*
2334 X When using a count with "R" the replaced text is
2335 deleted only once. Also when repeating "R" with "."
2336 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002338 y A yank command can be redone with ".". Think twice if
2339 you really want to use this, it may break some
2340 plugins, since most people expect "." to only repeat a
2341 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002342 *cpo-Z*
2343 Z When using "w!" while the 'readonly' option is set,
2344 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 *cpo-!*
2346 ! When redoing a filter command, use the last used
2347 external command, whatever it was. Otherwise the last
2348 used -filter- command is used.
2349 *cpo-$*
2350 $ When making a change to one line, don't redisplay the
2351 line, but put a '$' at the end of the changed text.
2352 The changed text will be overwritten when you type the
2353 new text. The line is redisplayed if you type any
2354 command that moves the cursor from the insertion
2355 point.
2356 *cpo-%*
2357 % Vi-compatible matching is done for the "%" command.
2358 Does not recognize "#if", "#endif", etc.
2359 Does not recognize "/*" and "*/".
2360 Parens inside single and double quotes are also
2361 counted, causing a string that contains a paren to
2362 disturb the matching. For example, in a line like
2363 "if (strcmp("foo(", s))" the first paren does not
2364 match the last one. When this flag is not included,
2365 parens inside single and double quotes are treated
2366 specially. When matching a paren outside of quotes,
2367 everything inside quotes is ignored. When matching a
2368 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002369 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002370 This flag is also used for other features, such as
2371 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002372 *cpo--*
2373 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002374 it would go above the first line or below the last
2375 line. Without it the cursor moves to the first or
2376 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002377 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002378 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002379 *cpo-+*
2380 + When included, a ":write file" command will reset the
2381 'modified' flag of the buffer, even though the buffer
2382 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002383 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 * Use ":*" in the same way as ":@". When not included,
2385 ":*" is an alias for ":'<,'>", select the Visual area.
2386 *cpo-<*
2387 < Disable the recognition of special key codes in |<>|
2388 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002389 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 ":map X <Tab>" results in X being mapped to:
2391 '<' included: "<Tab>" (5 characters)
2392 '<' excluded: "^I" (^I is a real <Tab>)
2393 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002394 *cpo->*
2395 > When appending to a register, put a line break before
2396 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002397 *cpo-;*
2398 ; When using |,| or |;| to repeat the last |t| search
2399 and the cursor is right in front of the searched
2400 character, the cursor won't move. When not included,
2401 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002402 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002403
2404 POSIX flags. These are not included in the Vi default value, except
2405 when $VIM_POSIX was set on startup. |posix|
2406
2407 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002408 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002409 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002410 *cpo-&*
2411 & When ":preserve" was used keep the swap file when
2412 exiting normally while this buffer is still loaded.
2413 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002414 *cpo-\*
2415 \ Backslash in a [] range in a search pattern is taken
2416 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002417 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2418 '\' excluded: "/[ \-]" finds <Space> and '-'
2419 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002420 *cpo-/*
2421 / When "%" is used as the replacement string in a |:s|
2422 command, use the previous replacement string. |:s%|
2423 *cpo-{*
2424 { The |{| and |}| commands also stop at a "{" character
2425 at the start of a line.
2426 *cpo-.*
2427 . The ":chdir" and ":cd" commands fail if the current
2428 buffer is modified, unless ! is used. Vim doesn't
2429 need this, since it remembers the full path of an
2430 opened file.
2431 *cpo-bar*
2432 | The value of the $LINES and $COLUMNS environment
2433 variables overrule the terminal size values obtained
2434 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002435
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002437 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002438'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002439 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002440 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002441 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002442 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002443 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002444 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002445 blowfish Blowfish method. Medium strong encryption but it has
2446 an implementation flaw. Requires Vim 7.3 or later,
2447 files can NOT be read by Vim 7.2 and older. This adds
2448 a "seed" to the file, every time you write the file
2449 the encrypted bytes will be different.
2450 *blowfish2*
2451 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002452 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002453 and older. This adds a "seed" to the file, every time
2454 you write the file the encrypted bytes will be
2455 different. The whole undo file is encrypted, not just
2456 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002457 *E1193* *E1194* *E1195* *E1196*
2458 *E1197* *E1198* *E1199* *E1200* *E1201*
2459 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2460 Code. Medium strong till strong encryption.
2461 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002462 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002463 It adds a seed and a message authentication code (MAC)
2464 to the file. This needs at least a Vim 8.2.3022 to
2465 read the encrypted file.
2466 Encryption of swap files is not supported, therefore
2467 no swap file will be used when xchacha20 encryption is
2468 enabled.
2469 Encryption of undo files is not yet supported,
2470 therefore no undo file will currently be written.
2471 CURRENTLY EXPERIMENTAL: Files written with this method
2472 might have to be read back with the same version of
2473 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002474
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002475 You should use "blowfish2", also to re-encrypt older files.
2476
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002477 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002478 to the detected method of the file being read. Thus if you write it
2479 without changing 'cryptmethod' the same method will be used.
2480 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002481 explicitly write it, you don't get a warning unless there are other
2482 modifications. Also see |:X|.
2483
2484 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002485 the value "blowfish2". When setting the local value to an empty
2486 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002487
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002488 When a new encryption method is added in a later version of Vim, and
2489 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002490 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002491
2492
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 *'cscopepathcomp'* *'cspc'*
2494'cscopepathcomp' 'cspc' number (default 0)
2495 global
2496 {not available when compiled without the |+cscope|
2497 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 Determines how many components of the path to show in a list of tags.
2499 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002500 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501
2502 *'cscopeprg'* *'csprg'*
2503'cscopeprg' 'csprg' string (default "cscope")
2504 global
2505 {not available when compiled without the |+cscope|
2506 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 Specifies the command to execute cscope. See |cscopeprg|.
2508 This option cannot be set from a |modeline| or in the |sandbox|, for
2509 security reasons.
2510
2511 *'cscopequickfix'* *'csqf'*
2512'cscopequickfix' 'csqf' string (default "")
2513 global
2514 {not available when compiled without the |+cscope|
2515 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 Specifies whether to use quickfix window to show cscope results.
2517 See |cscopequickfix|.
2518
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002519 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002520'cscoperelative' 'csre' boolean (default off)
2521 global
2522 {not available when compiled without the |+cscope|
2523 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002524 In the absence of a prefix (-P) for cscope. setting this option enables
2525 to use the basename of cscope.out path as the prefix.
2526 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002527 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002528
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2530'cscopetag' 'cst' boolean (default off)
2531 global
2532 {not available when compiled without the |+cscope|
2533 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 Use cscope for tag commands. See |cscope-options|.
2535 NOTE: This option is reset when 'compatible' is set.
2536
2537 *'cscopetagorder'* *'csto'*
2538'cscopetagorder' 'csto' number (default 0)
2539 global
2540 {not available when compiled without the |+cscope|
2541 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 Determines the order in which ":cstag" performs a search. See
2543 |cscopetagorder|.
2544 NOTE: This option is set to 0 when 'compatible' is set.
2545
2546 *'cscopeverbose'* *'csverb'*
2547 *'nocscopeverbose'* *'nocsverb'*
2548'cscopeverbose' 'csverb' boolean (default off)
2549 global
2550 {not available when compiled without the |+cscope|
2551 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 Give messages when adding a cscope database. See |cscopeverbose|.
2553 NOTE: This option is reset when 'compatible' is set.
2554
Bram Moolenaar860cae12010-06-05 23:22:07 +02002555 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2556'cursorbind' 'crb' boolean (default off)
2557 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002558 When this option is set, as the cursor in the current
2559 window moves other cursorbound windows (windows that also have
2560 this option set) move their cursors to the corresponding line and
2561 column. This option is useful for viewing the
2562 differences between two versions of a file (see 'diff'); in diff mode,
2563 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002564 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002565
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002566
2567 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2568'cursorcolumn' 'cuc' boolean (default off)
2569 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002570 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002571 feature}
2572 Highlight the screen column of the cursor with CursorColumn
2573 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2574 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002575 If you only want the highlighting in the current window you can use
2576 these autocommands: >
2577 au WinLeave * set nocursorline nocursorcolumn
2578 au WinEnter * set cursorline cursorcolumn
2579<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002580
2581 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2582'cursorline' 'cul' boolean (default off)
2583 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002584 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002585 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002586 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2587 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002588 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002589 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002590
2591
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002592 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002593'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002594 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002595 {not available when compiled without the |+syntax|
2596 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002597 Comma separated list of settings for how 'cursorline' is displayed.
2598 Valid values:
2599 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002600 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002601 "screenline" Highlight only the screen line of the cursor with
2602 CursorLine |hl-CursorLine|.
2603 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002604 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002605
2606 Special value:
2607 "both" Alias for the values "line,number".
2608
2609 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002610
2611
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 *'debug'*
2613'debug' string (default "")
2614 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002615 These values can be used:
2616 msg Error messages that would otherwise be omitted will be given
2617 anyway.
2618 throw Error messages that would otherwise be omitted will be given
2619 anyway and also throw an exception and set |v:errmsg|.
2620 beep A message will be given when otherwise only a beep would be
2621 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002622 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002623 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2624 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625
2626 *'define'* *'def'*
2627'define' 'def' string (default "^\s*#\s*define")
2628 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002629 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630 pattern, just like for the "/" command. This option is used for the
2631 commands like "[i" and "[d" |include-search|. The 'isident' option is
2632 used to recognize the defined name after the match:
2633 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2634 See |option-backslash| about inserting backslashes to include a space
2635 or backslash.
2636 The default value is for C programs. For C++ this value would be
2637 useful, to include const type declarations: >
2638 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002639< You can also use "\ze" just before the name and continue the pattern
2640 to check what is following. E.g. for Javascript, if a function is
2641 defined with "func_name = function(args)": >
2642 ^\s*\ze\i\+\s*=\s*function(
2643< If the function is defined with "func_name : function() {...": >
2644 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002646 To avoid that use `:let` with a single quote string: >
2647 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002648<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649
2650 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2651'delcombine' 'deco' boolean (default off)
2652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 If editing Unicode and this option is set, backspace and Normal mode
2654 "x" delete each combining character on its own. When it is off (the
2655 default) the character along with its combining characters are
2656 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002657 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658
2659 This is useful for Arabic, Hebrew and many other languages where one
2660 may have combining characters overtop of base characters, and want
2661 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002662 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663
2664 *'dictionary'* *'dict'*
2665'dictionary' 'dict' string (default "")
2666 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 List of file names, separated by commas, that are used to lookup words
2668 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2669 contain a list of words. This can be one word per line, or several
2670 words per line, separated by non-keyword characters (white space is
2671 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002672
2673 When this option is empty or an entry "spell" is present, and spell
2674 checking is enabled, words in the word lists for the currently active
2675 'spelllang' are used. See |spell|.
2676
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002677 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 after a comma are ignored, otherwise spaces are included in the file
2679 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002680 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 Where to find a list of words?
2682 - On FreeBSD, there is the file "/usr/share/dict/words".
2683 - In the Simtel archive, look in the "msdos/linguist" directory.
2684 - In "miscfiles" of the GNU collection.
2685 The use of |:set+=| and |:set-=| is preferred when adding or removing
2686 directories from the list. This avoids problems when a future version
2687 uses another default.
2688 Backticks cannot be used in this option for security reasons.
2689
2690 *'diff'* *'nodiff'*
2691'diff' boolean (default off)
2692 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 {not available when compiled without the |+diff|
2694 feature}
2695 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002696 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697
2698 *'dex'* *'diffexpr'*
2699'diffexpr' 'dex' string (default "")
2700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 {not available when compiled without the |+diff|
2702 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002703 Expression which is evaluated to obtain a diff file (either ed-style
2704 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 This option cannot be set from a |modeline| or in the |sandbox|, for
2706 security reasons.
2707
2708 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002709'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 {not available when compiled without the |+diff|
2712 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002713 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 All are optional. Items must be separated by a comma.
2715
2716 filler Show filler lines, to keep the text
2717 synchronized with a window that has inserted
2718 lines at the same position. Mostly useful
2719 when windows are side-by-side and 'scrollbind'
2720 is set.
2721
2722 context:{n} Use a context of {n} lines between a change
2723 and a fold that contains unchanged lines.
2724 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002725 When using zero the context is actually one,
2726 since folds require a line in between, also
2727 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 See |fold-diff|.
2729
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002730 iblank Ignore changes where lines are all blank. Adds
2731 the "-B" flag to the "diff" command if
2732 'diffexpr' is empty. Check the documentation
2733 of the "diff" command for what this does
2734 exactly.
2735 NOTE: the diff windows will get out of sync,
2736 because no differences between blank lines are
2737 taken into account.
2738
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 icase Ignore changes in case of text. "a" and "A"
2740 are considered the same. Adds the "-i" flag
2741 to the "diff" command if 'diffexpr' is empty.
2742
2743 iwhite Ignore changes in amount of white space. Adds
2744 the "-b" flag to the "diff" command if
2745 'diffexpr' is empty. Check the documentation
2746 of the "diff" command for what this does
2747 exactly. It should ignore adding trailing
2748 white space, but not leading white space.
2749
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002750 iwhiteall Ignore all white space changes. Adds
2751 the "-w" flag to the "diff" command if
2752 'diffexpr' is empty. Check the documentation
2753 of the "diff" command for what this does
2754 exactly.
2755
2756 iwhiteeol Ignore white space changes at end of line.
2757 Adds the "-Z" flag to the "diff" command if
2758 'diffexpr' is empty. Check the documentation
2759 of the "diff" command for what this does
2760 exactly.
2761
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002762 horizontal Start diff mode with horizontal splits (unless
2763 explicitly specified otherwise).
2764
2765 vertical Start diff mode with vertical splits (unless
2766 explicitly specified otherwise).
2767
Bram Moolenaarc8234772019-11-10 21:00:27 +01002768 closeoff When a window is closed where 'diff' is set
2769 and there is only one window remaining in the
2770 same tab page with 'diff' set, execute
2771 `:diffoff` in that window. This undoes a
2772 `:diffsplit` command.
2773
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002774 hiddenoff Do not use diff mode for a buffer when it
2775 becomes hidden.
2776
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002777 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2778 starting diff mode. Without this 2 is used.
2779
Bram Moolenaar4223d432021-02-10 13:18:17 +01002780 followwrap Follow the 'wrap' option and leave as it is.
2781
Bram Moolenaare828b762018-09-10 17:51:58 +02002782 internal Use the internal diff library. This is
2783 ignored when 'diffexpr' is set. *E960*
2784 When running out of memory when writing a
2785 buffer this item will be ignored for diffs
2786 involving that buffer. Set the 'verbose'
2787 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788
Bram Moolenaare828b762018-09-10 17:51:58 +02002789 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002790 Use the indent heuristic for the internal
2791 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002792
2793 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002794 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002795 algorithms are:
2796 myers the default algorithm
2797 minimal spend extra time to generate the
2798 smallest possible diff
2799 patience patience diff algorithm
2800 histogram histogram diff algorithm
2801
2802 Examples: >
2803 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002805 :set diffopt=internal,filler,foldcolumn:3
2806 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807<
2808 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2809'digraph' 'dg' boolean (default off)
2810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 {not available when compiled without the |+digraphs|
2812 feature}
2813 Enable the entering of digraphs in Insert mode with {char1} <BS>
2814 {char2}. See |digraphs|.
2815 NOTE: This option is reset when 'compatible' is set.
2816
2817 *'directory'* *'dir'*
2818'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002819 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 for Unix: ".,~/tmp,/var/tmp,/tmp")
2821 global
2822 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002823 Recommended value: ".,~/vimswap//" - this will put the swap file next
2824 to the edited file if possible, and in your personal swap directory
2825 otherwise. Make sure "~/vimswap//" is only readable for you.
2826
2827 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 - The swap file will be created in the first directory where this is
2829 possible.
2830 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002831 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832 - A directory "." means to put the swap file in the same directory as
2833 the edited file. On Unix, a dot is prepended to the file name, so
2834 it doesn't show in a directory listing. On MS-Windows the "hidden"
2835 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002836 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2837 the swap file relative to where the edited file is. The leading "."
2838 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002839 - For Unix and Win32, if a directory ends in two path separators "//",
2840 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002841 with all path separators replaced by percent '%' signs (including
2842 the colon following the drive letter on Win32). This will ensure
2843 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002844 On Win32, it is also possible to end with "\\". However, When a
2845 separating comma is following, you must use "//", since "\\" will
2846 include the comma in the file name. Therefore it is recommended to
2847 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 - Spaces after the comma are ignored, other spaces are considered part
2849 of the directory name. To have a space at the start of a directory
2850 name, precede it with a backslash.
2851 - To include a comma in a directory name precede it with a backslash.
2852 - A directory name may end in an ':' or '/'.
2853 - Environment variables are expanded |:set_env|.
2854 - Careful with '\' characters, type one before a space, type two to
2855 get one in the option (see |option-backslash|), for example: >
2856 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2857< - For backwards compatibility with Vim version 3.0 a '>' at the start
2858 of the option is removed.
2859 Using "." first in the list is recommended. This means that editing
2860 the same file twice will result in a warning. Using "/tmp" on Unix is
2861 discouraged: When the system crashes you lose the swap file.
2862 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002863 choice than "/tmp". But others on the computer may be able to see the
2864 files, and it can contain a lot of files, your swap files get lost in
2865 the crowd. That is why a "tmp" directory in your home directory is
2866 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 The use of |:set+=| and |:set-=| is preferred when adding or removing
2868 directories from the list. This avoids problems when a future version
2869 uses another default.
2870 This option cannot be set from a |modeline| or in the |sandbox|, for
2871 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872
2873 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002874'display' 'dy' string (default "", set to "truncate" in
2875 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 Change the way text is displayed. This is comma separated list of
2878 flags:
2879 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002880 in a window will be displayed. "@@@" is put in the
2881 last columns of the last screen line to indicate the
2882 rest of the line is not displayed.
2883 truncate Like "lastline", but "@@@" is displayed in the first
2884 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 uhex Show unprintable characters hexadecimal as <xx>
2886 instead of using ^C and ~C.
2887
Bram Moolenaard0796902016-09-16 20:02:31 +02002888 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002889 doesn't fit is replaced with "@" lines.
2890
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 *'eadirection'* *'ead'*
2892'eadirection' 'ead' string (default "both")
2893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 Tells when the 'equalalways' option applies:
2895 ver vertically, width of windows is not affected
2896 hor horizontally, height of windows is not affected
2897 both width and height of windows is affected
2898
2899 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2900'edcompatible' 'ed' boolean (default off)
2901 global
2902 Makes the 'g' and 'c' flags of the ":substitute" command to be
2903 toggled each time the flag is given. See |complex-change|. See
2904 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002905 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002906 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907
Bram Moolenaar03413f42016-04-12 21:07:15 +02002908 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002909'emoji' 'emo' boolean (default: on)
2910 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002911 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002912 This excludes "text emoji" characters, which are normally displayed as
2913 single width. Unfortunately there is no good specification for this
2914 and it has been determined on trial-and-error basis. Use the
2915 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002916
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002918'encoding' 'enc' string (default for MS-Windows: "utf-8",
2919 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 Sets the character encoding used inside Vim. It applies to text in
2922 the buffers, registers, Strings in expressions, text stored in the
2923 viminfo file, etc. It sets the kind of characters which Vim can work
2924 with. See |encoding-names| for the possible values.
2925
2926 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002927 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002929 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930
Bram Moolenaar865242e2010-07-14 21:12:05 +02002931 This option cannot be set from a |modeline|. It would most likely
2932 corrupt the text.
2933
Bram Moolenaar3df01732017-02-17 22:47:16 +01002934 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2935 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 'encoding', "utf-8" is the natural choice for the environment and
2937 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002938 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 versions, and to avoid changing the encoding of newly created files
2940 without your knowledge (in case 'fileencodings' is empty).
2941
2942 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002943 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 iconv() or as specified with 'charconvert'.
2945
Bram Moolenaar207f0092020-08-30 17:20:20 +02002946 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002947 can use: >
2948 if has("multi_byte_encoding")
2949<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 Normally 'encoding' will be equal to your current locale. This will
2951 be the default if Vim recognizes your environment settings. If
2952 'encoding' is not set to the current locale, 'termencoding' must be
2953 set to convert typed and displayed text. See |encoding-table|.
2954
2955 When you set this option, it fires the |EncodingChanged| autocommand
2956 event so that you can set up fonts if necessary.
2957
2958 When the option is set, the value is converted to lowercase. Thus
2959 you can set it with uppercase values too. Underscores are translated
2960 to '-' signs.
2961 When the encoding is recognized, it is changed to the standard name.
2962 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2963 "iso-8859-2" and "utf8" becomes "utf-8".
2964
2965 Note: "latin1" is also used when the encoding could not be detected.
2966 This only works when editing files in the same encoding! When the
2967 actual character set is not latin1, make sure 'fileencoding' and
2968 'fileencodings' are empty. When conversion is needed, switch to using
2969 utf-8.
2970
2971 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2972 You don't notice this while editing, but it does matter for the
2973 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2974 setting 'encoding' to one of these values instead of utf-8 only has
2975 effect for encoding used for files when 'fileencoding' is empty.
2976
Bram Moolenaar661b1822005-07-28 22:36:45 +00002977 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2978 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979
2980 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2981'endofline' 'eol' boolean (default on)
2982 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002984 is on, or 'fixeol' option is off, no <EOL> will be written for the
2985 last line in the file. This option is automatically set or reset when
2986 starting to edit a new file, depending on whether file has an <EOL>
2987 for the last line in the file. Normally you don't have to set or
2988 reset this option.
2989 When 'binary' is off and 'fixeol' is on the value is not used when
2990 writing the file. When 'binary' is on or 'fixeol' is off it is used
2991 to remember the presence of a <EOL> for the last line in the file, so
2992 that when you write the file the situation from the original file can
2993 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994
2995 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2996'equalalways' 'ea' boolean (default on)
2997 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002999 splitting or closing a window. This also happens the moment the
3000 option is switched on. When off, splitting a window will reduce the
3001 size of the current window and leave the other windows the same. When
3002 closing a window the extra lines are given to the window next to it
3003 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 When mixing vertically and horizontally split windows, a minimal size
3005 is computed and some windows may be larger if there is room. The
3006 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003007 Changing the height and width of a window can be avoided by setting
3008 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003009 If a window size is specified when creating a new window sizes are
3010 currently not equalized (it's complicated, but may be implemented in
3011 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012
3013 *'equalprg'* *'ep'*
3014'equalprg' 'ep' string (default "")
3015 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003017 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003018 or 'indentexpr'. When Vim was compiled without internal formatting,
3019 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003020 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 about including spaces and backslashes.
3022 This option cannot be set from a |modeline| or in the |sandbox|, for
3023 security reasons.
3024
3025 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3026'errorbells' 'eb' boolean (default off)
3027 global
3028 Ring the bell (beep or screen flash) for error messages. This only
3029 makes a difference for error messages, the bell will be used always
3030 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003031 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003032 screen flash or do nothing. See 'belloff' to finetune when to ring the
3033 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034
3035 *'errorfile'* *'ef'*
3036'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3037 others: "errors.err")
3038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 {not available when compiled without the |+quickfix|
3040 feature}
3041 Name of the errorfile for the QuickFix mode (see |:cf|).
3042 When the "-q" command-line argument is used, 'errorfile' is set to the
3043 following argument. See |-q|.
3044 NOT used for the ":make" command. See 'makeef' for that.
3045 Environment variables are expanded |:set_env|.
3046 See |option-backslash| about including spaces and backslashes.
3047 This option cannot be set from a |modeline| or in the |sandbox|, for
3048 security reasons.
3049
3050 *'errorformat'* *'efm'*
3051'errorformat' 'efm' string (default is very long)
3052 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 {not available when compiled without the |+quickfix|
3054 feature}
3055 Scanf-like description of the format for the lines in the error file
3056 (see |errorformat|).
3057
3058 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3059'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 Function keys that start with an <Esc> are recognized in Insert
3062 mode. When this option is off, the cursor and function keys cannot be
3063 used in Insert mode if they start with an <Esc>. The advantage of
3064 this is that the single <Esc> is recognized immediately, instead of
3065 after one second. Instead of resetting this option, you might want to
3066 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3067 when 'esckeys' is off, you can still map anything, but the cursor keys
3068 won't work by default.
3069 NOTE: This option is set to the Vi default value when 'compatible' is
3070 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003071 NOTE: when this option is off then the |modifyOtherKeys| functionality
3072 is disabled while in Insert mode to avoid ending Insert mode with any
3073 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074
3075 *'eventignore'* *'ei'*
3076'eventignore' 'ei' string (default "")
3077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003079 When set to "all" or when "all" is one of the items, all autocommand
3080 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 Otherwise this is a comma separated list of event names. Example: >
3082 :set ei=WinEnter,WinLeave
3083<
3084 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3085'expandtab' 'et' boolean (default off)
3086 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003088 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3090 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003091 This option is reset when the 'paste' option is set and restored when
3092 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 NOTE: This option is reset when 'compatible' is set.
3094
3095 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3096'exrc' 'ex' boolean (default off)
3097 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003099 directory.
3100
3101 Setting this option is a potential security leak. E.g., consider
3102 unpacking a package or fetching files from github, a .vimrc in there
3103 might be a trojan horse. BETTER NOT SET THIS OPTION!
3104 Instead, define an autocommand in your .vimrc to set options for a
3105 matching directory.
3106
3107 If you do switch this option on you should also consider setting the
3108 'secure' option (see |initialization|).
3109 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 This option cannot be set from a |modeline| or in the |sandbox|, for
3111 security reasons.
3112
3113 *'fileencoding'* *'fenc'* *E213*
3114'fileencoding' 'fenc' string (default: "")
3115 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003117
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003119 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 When 'fileencoding' is empty, the same value as 'encoding' will be
3121 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003122 No error will be given when the value is set, only when it is used,
3123 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003124 Conversion will also be done when 'encoding' and 'fileencoding' are
3125 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3126 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003128 'encoding' is "utf-8" or another Unicode encoding, conversion
3129 is most likely done in a way that the reverse conversion
3130 results in the same text. When 'encoding' is not "utf-8" some
3131 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003132
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 See 'encoding' for the possible values. Additionally, values may be
3134 specified that can be handled by the converter, see
3135 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003136
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 When reading a file 'fileencoding' will be set from 'fileencodings'.
3138 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003139 'fileencoding', use the |++enc| argument. One exception: when
3140 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003141 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003142
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3144 When the option is set, the value is converted to lowercase. Thus
3145 you can set it with uppercase values too. '_' characters are
3146 replaced with '-'. If a name is recognized from the list for
3147 'encoding', it is replaced by the standard name. For example
3148 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003149
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 When this option is set, after starting to edit a file, the 'modified'
3151 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003152
3153 Keep in mind that changing 'fenc' from a modeline happens
3154 AFTER the text has been read, thus it applies to when the file will be
3155 written. If you do set 'fenc' in a modeline, you might want to set
3156 'nomodified' to avoid not being able to ":q".
3157
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 This option can not be changed when 'modifiable' is off.
3159
3160 *'fe'*
3161 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003162 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 old short name was 'fe', which is no longer used.
3164
3165 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003166'fileencodings' 'fencs' string (default: "ucs-bom",
3167 "ucs-bom,utf-8,default,latin1" when
3168 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 This is a list of character encodings considered when starting to edit
3171 an existing file. When a file is read, Vim tries to use the first
3172 mentioned character encoding. If an error is detected, the next one
3173 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003174 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 an empty string, which means the value of 'encoding' is used.
3176 WARNING: Conversion can cause loss of information! When
3177 'encoding' is "utf-8" (or one of the other Unicode variants)
3178 conversion is most likely done in a way that the reverse
3179 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003180 "utf-8" some non-ASCII characters may be lost! You can use
3181 the |++bad| argument to specify what is done with characters
3182 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 For an empty file or a file with only ASCII characters most encodings
3184 will work and the first entry of 'fileencodings' will be used (except
3185 "ucs-bom", which requires the BOM to be present). If you prefer
3186 another encoding use an BufReadPost autocommand event to test if your
3187 preferred encoding is to be used. Example: >
3188 au BufReadPost * if search('\S', 'w') == 0 |
3189 \ set fenc=iso-2022-jp | endif
3190< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3191 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003192 When the |++enc| argument is used then the value of 'fileencodings' is
3193 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003194 Note that 'fileencodings' is not used for a new file, the global value
3195 of 'fileencoding' is used instead. You can set it with: >
3196 :setglobal fenc=iso-8859-2
3197< This means that a non-existing file may get a different encoding than
3198 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 The special value "ucs-bom" can be used to check for a Unicode BOM
3200 (Byte Order Mark) at the start of the file. It must not be preceded
3201 by "utf-8" or another Unicode encoding for this to work properly.
3202 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3203 because Vim cannot detect an error, thus the encoding is always
3204 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003205 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003206 environment. On MS-Windows this is the system encoding. Otherwise
3207 this is the default value for 'encoding'. It is useful when
3208 'encoding' is set to "utf-8" and your environment uses a non-latin1
3209 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003210 When 'encoding' is "utf-8" and a file contains an illegal byte
3211 sequence it won't be recognized as UTF-8. You can use the |8g8|
3212 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 WRONG VALUES: WHAT'S WRONG:
3214 latin1,utf-8 "latin1" will always be used
3215 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3216 file
3217 cp1250,latin1 "cp1250" will always be used
3218 If 'fileencodings' is empty, 'fileencoding' is not modified.
3219 See 'fileencoding' for the possible values.
3220 Setting this option does not have an effect until the next time a file
3221 is read.
3222
3223 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003224'fileformat' 'ff' string (MS-Windows default: "dos",
3225 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 This gives the <EOL> of the current buffer, which is used for
3228 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003229 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 unix <NL>
3231 mac <CR>
3232 When "dos" is used, CTRL-Z at the end of a file is ignored.
3233 See |file-formats| and |file-read|.
3234 For the character encoding of the file see 'fileencoding'.
3235 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003236 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 This option is set automatically when starting to edit a file and
3238 'fileformats' is not empty and 'binary' is off.
3239 When this option is set, after starting to edit a file, the 'modified'
3240 option is set, because the file would be different when written.
3241 This option can not be changed when 'modifiable' is off.
3242 For backwards compatibility: When this option is set to "dos",
3243 'textmode' is set, otherwise 'textmode' is reset.
3244
3245 *'fileformats'* *'ffs'*
3246'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003247 Vim+Vi MS-Windows: "dos,unix",
3248 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 Vi Cygwin: "unix,dos",
3250 Vi others: "")
3251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 This gives the end-of-line (<EOL>) formats that will be tried when
3253 starting to edit a new buffer and when reading a file into an existing
3254 buffer:
3255 - When empty, the format defined with 'fileformat' will be used
3256 always. It is not set automatically.
3257 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003258 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 'fileformats' name will be used when a file is read into an existing
3260 buffer, no matter what 'fileformat' for that buffer is set to.
3261 - When more than one name is present, separated by commas, automatic
3262 <EOL> detection will be done when reading a file. When starting to
3263 edit a file, a check is done for the <EOL>:
3264 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3265 'fileformat' is set to "dos".
3266 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003267 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003269 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3270 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003271 This means that "mac" is only chosen when:
3272 "unix" is not present or no <NL> is found in the file, and
3273 "dos" is not present or no <CR><NL> is found in the file.
3274 Except: if "unix" was chosen, but there is a <CR> before
3275 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003276 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 4. If 'fileformat' is still not set, the first name from
3278 'fileformats' is used.
3279 When reading a file into an existing buffer, the same is done, but
3280 this happens like 'fileformat' has been set appropriately for that
3281 file only, the option is not changed.
3282 When 'binary' is set, the value of 'fileformats' is not used.
3283
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003284 When Vim starts up with an empty buffer the first item is used. You
3285 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003286
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3288 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3289 done:
3290 - When 'fileformats' is empty, there is no automatic detection. Dos
3291 format will be used.
3292 - When 'fileformats' is set to one or more names, automatic detection
3293 is done. This is based on the first <NL> in the file: If there is a
3294 <CR> in front of it, Dos format is used, otherwise Unix format is
3295 used.
3296 Also see |file-formats|.
3297 For backwards compatibility: When this option is set to an empty
3298 string or one format (no comma is included), 'textauto' is reset,
3299 otherwise 'textauto' is set.
3300 NOTE: This option is set to the Vi default value when 'compatible' is
3301 set and to the Vim default value when 'compatible' is reset.
3302
Bram Moolenaarbf884932013-04-05 22:26:15 +02003303 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3304'fileignorecase' 'fic' boolean (default on for systems where case in file
3305 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003306 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003307 When set case is ignored when using file names and directories.
3308 See 'wildignorecase' for only ignoring case when doing completion.
3309
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 *'filetype'* *'ft'*
3311'filetype' 'ft' string (default: "")
3312 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 When this option is set, the FileType autocommand event is triggered.
3314 All autocommands that match with the value of this option will be
3315 executed. Thus the value of 'filetype' is used in place of the file
3316 name.
3317 Otherwise this option does not always reflect the current file type.
3318 This option is normally set when the file type is detected. To enable
3319 this use the ":filetype on" command. |:filetype|
3320 Setting this option to a different value is most useful in a modeline,
3321 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003322 Example, for in an IDL file:
3323 /* vim: set filetype=idl : */ ~
3324 |FileType| |filetypes|
3325 When a dot appears in the value then this separates two filetype
3326 names. Example:
3327 /* vim: set filetype=c.doxygen : */ ~
3328 This will use the "c" filetype first, then the "doxygen" filetype.
3329 This works both for filetype plugins and for syntax files. More than
3330 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 This option is not copied to another buffer, independent of the 's' or
3332 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003333 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334
3335 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003336'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003338 {not available when compiled without the |+folding|
3339 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 Characters to fill the statuslines and vertical separators.
3341 It is a comma separated list of items:
3342
3343 item default Used for ~
3344 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003345 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 vert:c '|' vertical separators |:vsplit|
3347 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003348 foldopen:c '-' mark the beginning of a fold
3349 foldclose:c '+' show a closed fold
3350 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003352 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003354 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003355 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 otherwise.
3357
3358 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003359 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360< This is similar to the default, except that these characters will also
3361 be used when there is highlighting.
3362
Bram Moolenaar008bff92021-03-04 21:55:58 +01003363 For "stl" and "stlnc" single-byte and multibyte characters are
3364 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003365
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 The highlighting used for these items:
3367 item highlight group ~
3368 stl:c StatusLine |hl-StatusLine|
3369 stlnc:c StatusLineNC |hl-StatusLineNC|
3370 vert:c VertSplit |hl-VertSplit|
3371 fold:c Folded |hl-Folded|
3372 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003373 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003375 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3376'fixendofline' 'fixeol' boolean (default on)
3377 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003378 When writing a file and this option is on, <EOL> at the end of file
3379 will be restored if missing. Turn this option off if you want to
3380 preserve the situation from the original file.
3381 When the 'binary' option is set the value of this option doesn't
3382 matter.
3383 See the 'endofline' option.
3384
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003386'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 {only available when compiled with the |+rightleft|
3389 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003390 This option was for using Farsi, which has been removed. See
3391 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392
3393 *'foldclose'* *'fcl'*
3394'foldclose' 'fcl' string (default "")
3395 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 {not available when compiled without the |+folding|
3397 feature}
3398 When set to "all", a fold is closed when the cursor isn't in it and
3399 its level is higher than 'foldlevel'. Useful if you want folds to
3400 automatically close when moving out of them.
3401
3402 *'foldcolumn'* *'fdc'*
3403'foldcolumn' 'fdc' number (default 0)
3404 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 {not available when compiled without the |+folding|
3406 feature}
3407 When non-zero, a column with the specified width is shown at the side
3408 of the window which indicates open and closed folds. The maximum
3409 value is 12.
3410 See |folding|.
3411
3412 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3413'foldenable' 'fen' boolean (default on)
3414 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 {not available when compiled without the |+folding|
3416 feature}
3417 When off, all folds are open. This option can be used to quickly
3418 switch between showing all text unfolded and viewing the text with
3419 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003420 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 'foldenable' is off.
3422 This option is set by commands that create a new fold or close a fold.
3423 See |folding|.
3424
3425 *'foldexpr'* *'fde'*
3426'foldexpr' 'fde' string (default: "0")
3427 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003429 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003431 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003432
Bram Moolenaar30b65812012-07-12 22:01:11 +02003433 The expression will be evaluated in the |sandbox| if set from a
3434 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003435 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003436 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003437
3438 It is not allowed to change text or jump to another window while
3439 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440
3441 *'foldignore'* *'fdi'*
3442'foldignore' 'fdi' string (default: "#")
3443 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 {not available when compiled without the |+folding|
3445 feature}
3446 Used only when 'foldmethod' is "indent". Lines starting with
3447 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003448 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 The default "#" works well for C programs. See |fold-indent|.
3450
3451 *'foldlevel'* *'fdl'*
3452'foldlevel' 'fdl' number (default: 0)
3453 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 {not available when compiled without the |+folding|
3455 feature}
3456 Sets the fold level: Folds with a higher level will be closed.
3457 Setting this option to zero will close all folds. Higher numbers will
3458 close fewer folds.
3459 This option is set by commands like |zm|, |zM| and |zR|.
3460 See |fold-foldlevel|.
3461
3462 *'foldlevelstart'* *'fdls'*
3463'foldlevelstart' 'fdls' number (default: -1)
3464 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 {not available when compiled without the |+folding|
3466 feature}
3467 Sets 'foldlevel' when starting to edit another buffer in a window.
3468 Useful to always start editing with all folds closed (value zero),
3469 some folds closed (one) or no folds closed (99).
3470 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003471 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 ignores this option and closes all folds.
3473 It is also done before BufReadPre autocommands, to allow an autocmd to
3474 overrule the 'foldlevel' value for specific files.
3475 When the value is negative, it is not used.
3476
3477 *'foldmarker'* *'fmr'* *E536*
3478'foldmarker' 'fmr' string (default: "{{{,}}}")
3479 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 {not available when compiled without the |+folding|
3481 feature}
3482 The start and end marker used when 'foldmethod' is "marker". There
3483 must be one comma, which separates the start and end marker. The
3484 marker is a literal string (a regular expression would be too slow).
3485 See |fold-marker|.
3486
3487 *'foldmethod'* *'fdm'*
3488'foldmethod' 'fdm' string (default: "manual")
3489 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 {not available when compiled without the |+folding|
3491 feature}
3492 The kind of folding used for the current window. Possible values:
3493 |fold-manual| manual Folds are created manually.
3494 |fold-indent| indent Lines with equal indent form a fold.
3495 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3496 |fold-marker| marker Markers are used to specify folds.
3497 |fold-syntax| syntax Syntax highlighting items specify folds.
3498 |fold-diff| diff Fold text that is not changed.
3499
3500 *'foldminlines'* *'fml'*
3501'foldminlines' 'fml' number (default: 1)
3502 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 {not available when compiled without the |+folding|
3504 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003505 Sets the number of screen lines above which a fold can be displayed
3506 closed. Also for manually closed folds. With the default value of
3507 one a fold can only be closed if it takes up two or more screen lines.
3508 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003509 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 "zc" to close a fold, which is displayed open because it's smaller
3511 than 'foldminlines', a following "zc" may close a containing fold.
3512
3513 *'foldnestmax'* *'fdn'*
3514'foldnestmax' 'fdn' number (default: 20)
3515 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 {not available when compiled without the |+folding|
3517 feature}
3518 Sets the maximum nesting of folds for the "indent" and "syntax"
3519 methods. This avoids that too many folds will be created. Using more
3520 than 20 doesn't work, because the internal limit is 20.
3521
3522 *'foldopen'* *'fdo'*
3523'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3524 search,tag,undo")
3525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 {not available when compiled without the |+folding|
3527 feature}
3528 Specifies for which type of commands folds will be opened, if the
3529 command moves the cursor into a closed fold. It is a comma separated
3530 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003531 NOTE: When the command is part of a mapping this option is not used.
3532 Add the |zv| command to the mapping to get the same effect.
3533 (rationale: the mapping may want to control opening folds itself)
3534
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 item commands ~
3536 all any
3537 block "(", "{", "[[", "[{", etc.
3538 hor horizontal movements: "l", "w", "fx", etc.
3539 insert any command in Insert mode
3540 jump far jumps: "G", "gg", etc.
3541 mark jumping to a mark: "'m", CTRL-O, etc.
3542 percent "%"
3543 quickfix ":cn", ":crew", ":make", etc.
3544 search search for a pattern: "/", "n", "*", "gd", etc.
3545 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003546 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 tag jumping to a tag: ":ta", CTRL-T, etc.
3548 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 When a movement command is used for an operator (e.g., "dl" or "y%")
3550 this option is not used. This means the operator will include the
3551 whole closed fold.
3552 Note that vertical movements are not here, because it would make it
3553 very difficult to move onto a closed fold.
3554 In insert mode the folds containing the cursor will always be open
3555 when text is inserted.
3556 To close folds you can re-apply 'foldlevel' with the |zx| command or
3557 set the 'foldclose' option to "all".
3558
3559 *'foldtext'* *'fdt'*
3560'foldtext' 'fdt' string (default: "foldtext()")
3561 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 {not available when compiled without the |+folding|
3563 feature}
3564 An expression which is used to specify the text displayed for a closed
3565 fold. See |fold-foldtext|.
3566
Bram Moolenaar30b65812012-07-12 22:01:11 +02003567 The expression will be evaluated in the |sandbox| if set from a
3568 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003569 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003570
3571 It is not allowed to change text or jump to another window while
3572 evaluating 'foldtext' |textlock|.
3573
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003574 *'formatexpr'* *'fex'*
3575'formatexpr' 'fex' string (default "")
3576 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003577 {not available when compiled without the |+eval|
3578 feature}
3579 Expression which is evaluated to format a range of lines for the |gq|
3580 operator or automatic formatting (see 'formatoptions'). When this
3581 option is empty 'formatprg' is used.
3582
3583 The |v:lnum| variable holds the first line to be formatted.
3584 The |v:count| variable holds the number of lines to be formatted.
3585 The |v:char| variable holds the character that is going to be
3586 inserted if the expression is being evaluated due to
3587 automatic formatting. This can be empty. Don't insert
3588 it yet!
3589
3590 Example: >
3591 :set formatexpr=mylang#Format()
3592< This will invoke the mylang#Format() function in the
3593 autoload/mylang.vim file in 'runtimepath'. |autoload|
3594
3595 The expression is also evaluated when 'textwidth' is set and adding
3596 text beyond that limit. This happens under the same conditions as
3597 when internal formatting is used. Make sure the cursor is kept in the
3598 same spot relative to the text then! The |mode()| function will
3599 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003600
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003601 When the expression evaluates to non-zero Vim will fall back to using
3602 the internal format mechanism.
3603
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003604 If the expression starts with s: or |<SID>|, then it is replaced with
3605 the script ID (|local-function|). Example: >
3606 set formatexpr=s:MyFormatExpr()
3607 set formatexpr=<SID>SomeFormatExpr()
3608<
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003609 The expression will be evaluated in the |sandbox| when set from a
3610 modeline, see |sandbox-option|. That stops the option from working,
3611 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003612 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003613 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003614
Bram Moolenaar86b68352004-12-27 21:59:20 +00003615 *'formatlistpat'* *'flp'*
3616'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3617 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003618 A pattern that is used to recognize a list header. This is used for
3619 the "n" flag in 'formatoptions'.
3620 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003621 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003622 while still checking more characters. There must be a character
3623 following the pattern, when it matches the whole line it is handled
3624 like there is no match.
3625 The default recognizes a number, followed by an optional punctuation
3626 character and white space.
3627
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003628 *'formatoptions'* *'fo'*
3629'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3630 local to buffer
3631 This is a sequence of letters which describes how automatic
3632 formatting is to be done. See |fo-table|. When the 'paste' option is
3633 on, no formatting is done (like 'formatoptions' is empty). Commas can
3634 be inserted for readability.
3635 To avoid problems with flags that are added in the future, use the
3636 "+=" and "-=" feature of ":set" |add-option-flags|.
3637 NOTE: This option is set to the Vi default value when 'compatible' is
3638 set and to the Vim default value when 'compatible' is reset.
3639
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 *'formatprg'* *'fp'*
3641'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003642 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003644 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003646 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003647 If the 'formatexpr' option is not empty it will be used instead.
3648 Otherwise, if 'formatprg' option is an empty string, the internal
3649 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003650 Environment variables are expanded |:set_env|. See |option-backslash|
3651 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003652 This option cannot be set from a |modeline| or in the |sandbox|, for
3653 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654
Bram Moolenaard94464e2015-11-02 15:28:18 +01003655 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003656'fsync' 'fs' boolean (default on)
3657 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003658 When on, the library function fsync() will be called after writing a
3659 file. This will flush a file to disk, ensuring that it is safely
3660 written even on filesystems which do metadata-only journaling. This
3661 will force the harddrive to spin up on Linux systems running in laptop
3662 mode, so it may be undesirable in some situations. Be warned that
3663 turning this off increases the chances of data loss after a crash. On
3664 systems without an fsync() implementation, this variable is always
3665 off.
3666 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003667 'fsync' also applies to |writefile()| (unless a flag is used to
3668 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003669 This option cannot be set from a |modeline| or in the |sandbox|, for
3670 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003671
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3673'gdefault' 'gd' boolean (default off)
3674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 When on, the ":substitute" flag 'g' is default on. This means that
3676 all matches in a line are substituted instead of one. When a 'g' flag
3677 is given to a ":substitute" command, this will toggle the substitution
3678 of all or one match. See |complex-change|.
3679
3680 command 'gdefault' on 'gdefault' off ~
3681 :s/// subst. all subst. one
3682 :s///g subst. one subst. all
3683 :s///gg subst. all subst. one
3684
3685 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003686 DEPRECATED: Setting this option may break plugins that are not aware
3687 of this option. Also, many users get confused that adding the /g flag
3688 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003689 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690
3691 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003692'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 Format to recognize for the ":grep" command output.
3695 This is a scanf-like string that uses the same format as the
3696 'errorformat' option: see |errorformat|.
3697
3698 *'grepprg'* *'gp'*
3699'grepprg' 'gp' string (default "grep -n ",
3700 Unix: "grep -n $* /dev/null",
3701 Win32: "findstr /n" or "grep -n",
3702 VMS: "SEARCH/NUMBERS ")
3703 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003704 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 and '#' characters, which are expanded like when used in a command-
3706 line. The placeholder "$*" is allowed to specify where the arguments
3707 will be included. Environment variables are expanded |:set_env|. See
3708 |option-backslash| about including spaces and backslashes.
3709 When your "grep" accepts the "-H" argument, use this to make ":grep"
3710 also work well with a single file: >
3711 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003712< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003713 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3714 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003715 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 apply equally to 'grepprg'.
3717 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3718 otherwise it's "grep -n".
3719 This option cannot be set from a |modeline| or in the |sandbox|, for
3720 security reasons.
3721
3722 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3723'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3724 ve:ver35-Cursor,
3725 o:hor50-Cursor,
3726 i-ci:ver25-Cursor/lCursor,
3727 r-cr:hor20-Cursor/lCursor,
3728 sm:block-Cursor
3729 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003730 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 "n-v-c:block,o:hor50,i-ci:hor15,
3732 r-cr:hor30,sm:block")
3733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003735 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003737 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003738 height of the cursor can be changed. This can be done by specifying a
3739 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003740 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3741 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003743 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 mode-list and an argument-list:
3745 mode-list:argument-list,mode-list:argument-list,..
3746 The mode-list is a dash separated list of these modes:
3747 n Normal mode
3748 v Visual mode
3749 ve Visual mode with 'selection' "exclusive" (same as 'v',
3750 if not specified)
3751 o Operator-pending mode
3752 i Insert mode
3753 r Replace mode
3754 c Command-line Normal (append) mode
3755 ci Command-line Insert mode
3756 cr Command-line Replace mode
3757 sm showmatch in Insert mode
3758 a all modes
3759 The argument-list is a dash separated list of these arguments:
3760 hor{N} horizontal bar, {N} percent of the character height
3761 ver{N} vertical bar, {N} percent of the character width
3762 block block cursor, fills the whole character
3763 [only one of the above three should be present]
3764 blinkwait{N} *cursor-blinking*
3765 blinkon{N}
3766 blinkoff{N}
3767 blink times for cursor: blinkwait is the delay before
3768 the cursor starts blinking, blinkon is the time that
3769 the cursor is shown and blinkoff is the time that the
3770 cursor is not shown. The times are in msec. When one
3771 of the numbers is zero, there is no blinking. The
3772 default is: "blinkwait700-blinkon400-blinkoff250".
3773 These numbers are used for a missing entry. This
3774 means that blinking is enabled by default. To switch
3775 blinking off you can use "blinkon0". The cursor only
3776 blinks when Vim is waiting for input, not while
3777 executing a command.
3778 To make the cursor blink in an xterm, see
3779 |xterm-blink|.
3780 {group-name}
3781 a highlight group name, that sets the color and font
3782 for the cursor
3783 {group-name}/{group-name}
3784 Two highlight group names, the first is used when
3785 no language mappings are used, the other when they
3786 are. |language-mapping|
3787
3788 Examples of parts:
3789 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3790 block cursor with colors from the "nCursor"
3791 highlight group
3792 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3793 In Insert and Command-line Insert mode, use a
3794 30% vertical bar cursor with colors from the
3795 "iCursor" highlight group. Blink a bit
3796 faster.
3797
3798 The 'a' mode is different. It will set the given argument-list for
3799 all modes. It does not reset anything to defaults. This can be used
3800 to do a common setting for all modes. For example, to switch off
3801 blinking: "a:blinkon0"
3802
3803 Examples of cursor highlighting: >
3804 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3805 :highlight Cursor gui=NONE guifg=bg guibg=fg
3806<
3807 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003808 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809'guifont' 'gfn' string (default "")
3810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 {only available when compiled with GUI enabled}
3812 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003813 In its simplest form the value is just one font name.
3814 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815
3816 *'guifontset'* *'gfs'*
3817 *E250* *E252* *E234* *E597* *E598*
3818'guifontset' 'gfs' string (default "")
3819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 {only available when compiled with GUI enabled and
3821 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003822 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 When not empty, specifies two (or more) fonts to be used. The first
3824 one for normal English, the second one for your special language. See
3825 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003826
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3828'guifontwide' 'gfw' string (default "")
3829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 {only available when compiled with GUI enabled}
3831 When not empty, specifies a comma-separated list of fonts to be used
3832 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003833 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003834
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 *'guiheadroom'* *'ghr'*
3836'guiheadroom' 'ghr' number (default 50)
3837 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003838 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 The number of pixels subtracted from the screen height when fitting
3840 the GUI window on the screen. Set this before the GUI is started,
3841 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003842 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 lines will be left for window decorations and other items on the
3844 screen. Set it to a negative value to allow windows taller than the
3845 screen.
3846
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003847 *'guiligatures'* *'gli'* *E1243*
3848'guiligatures' 'gli' string (default "")
3849 global
3850 {only for GTK GUI}
3851 List of ASCII characters that, when combined together, can create more
3852 complex shapes. Each character must be a printable ASCII character
3853 with a value in the 32-127 range.
3854 Example: >
3855 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3856< Changing this option updates screen output immediately. Set it to an
3857 empty string to disable ligatures.
3858
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003860'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3861 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003862 "aegimrLtT" (GTK, Motif and Athena),
3863 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003866 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 sequence of letters which describes what components and options of the
3868 GUI should be used.
3869 To avoid problems with flags that are added in the future, use the
3870 "+=" and "-=" feature of ":set" |add-option-flags|.
3871
Bram Moolenaar13568252018-03-16 20:46:58 +01003872 Valid characters are as follows:
3873 *'go-!'*
3874 '!' External commands are executed in a terminal window. Without
3875 this flag the MS-Windows GUI will open a console window to
3876 execute the command. The Unix GUI will simulate a dumb
3877 terminal to list the command output.
3878 The terminal window will be positioned at the bottom, and grow
3879 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003880 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 'a' Autoselect: If present, then whenever VISUAL mode is started,
3882 or the Visual area extended, Vim tries to become the owner of
3883 the windowing system's global selection. This means that the
3884 Visually highlighted text is available for pasting into other
3885 applications as well as into Vim itself. When the Visual mode
3886 ends, possibly due to an operation on the text, or when an
3887 application wants to paste the selection, the highlighted text
3888 is automatically yanked into the "* selection register.
3889 Thus the selection is still available for pasting into other
3890 applications after the VISUAL mode has ended.
3891 If not present, then Vim won't become the owner of the
3892 windowing system's global selection unless explicitly told to
3893 by a yank or delete operation for the "* register.
3894 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003895 *'go-P'*
3896 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003897 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003898 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003899 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 applies to the modeless selection.
3901
3902 'guioptions' autoselect Visual autoselect modeless ~
3903 "" - -
3904 "a" yes yes
3905 "A" - yes
3906 "aA" yes yes
3907
Bram Moolenaar02467872007-05-06 13:22:01 +00003908 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 'c' Use console dialogs instead of popup dialogs for simple
3910 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003911 *'go-d'*
3912 'd' Use dark theme variant if available. Currently only works for
3913 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003914 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003915 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003916 'guitablabel' can be used to change the text in the labels.
3917 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003918 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003919 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003920 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 'f' Foreground: Don't use fork() to detach the GUI from the shell
3922 where it was started. Use this for programs that wait for the
3923 editor to finish (e.g., an e-mail program). Alternatively you
3924 can use "gvim -f" or ":gui -f" to start the GUI in the
3925 foreground. |gui-fork|
3926 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003927 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003928 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3930 corner of the window. It's black&white on non-GTK, because of
3931 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003932 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003934 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003935 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003937 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003939 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003940 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 'g' Grey menu items: Make menu items that are not active grey. If
3942 'g' is not included inactive menu items are not shown at all.
3943 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003944 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 't' Include tearoff menu items. Currently only works for Win32,
3946 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003947 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003948 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003949 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003950 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003952 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 'R' Right-hand scrollbar is present when there is a vertically
3954 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003955 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003957 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 'L' Left-hand scrollbar is present when there is a vertically
3959 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003960 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3962 the longest visible line, or on the cursor line if the 'h'
3963 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003964 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 'h' Limit horizontal scrollbar size to the length of the cursor
3966 line. Reduces computations. |gui-horiz-scroll|
3967
3968 And yes, you may even have scrollbars on the left AND the right if
3969 you really want to :-). See |gui-scrollbars| for more information.
3970
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003971 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 'v' Use a vertical button layout for dialogs. When not included,
3973 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003974 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003975 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 'p' Use Pointer callbacks for X11 GUI. This is required for some
3977 window managers. If the cursor is not blinking or hollow at
3978 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003979 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003981 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003982 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003983 *'go-k'*
3984 'k' Keep the GUI window size when adding/removing a scrollbar, or
3985 toolbar, tabline, etc. Instead, the behavior is similar to
3986 when the window is maximized and will adjust 'lines' and
3987 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003988 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003989 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003990
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 *'guipty'* *'noguipty'*
3992'guipty' boolean (default on)
3993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 {only available when compiled with GUI enabled}
3995 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3996 I/O to/from shell commands. See |gui-pty|.
3997
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003998 *'guitablabel'* *'gtl'*
3999'guitablabel' 'gtl' string (default empty)
4000 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004001 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004002 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004003 pages line. When empty and when the result is empty Vim will use a
4004 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004005
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004006 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004007 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004008 The expression will be evaluated in the |sandbox| when set from a
4009 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004010 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004011
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004012 Only used when the GUI tab pages line is displayed. 'e' must be
4013 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4014 used.
4015
Bram Moolenaar57657d82006-04-21 22:12:41 +00004016 *'guitabtooltip'* *'gtt'*
4017'guitabtooltip' 'gtt' string (default empty)
4018 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004019 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004020 When nonempty describes the text to use in a tooltip for the GUI tab
4021 pages line. When empty Vim will use a default tooltip.
4022 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004023 You can include a line break. Simplest method is to use |:let|: >
4024 :let &guitabtooltip = "line one\nline two"
4025<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004026
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004028'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 (others) "$VIMRUNTIME/doc/help.txt")
4030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 Name of the main help file. All distributed help files should be
4032 placed together in one directory. Additionally, all "doc" directories
4033 in 'runtimepath' will be used.
4034 Environment variables are expanded |:set_env|. For example:
4035 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004036 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 spaces and backslashes.
4038 This option cannot be set from a |modeline| or in the |sandbox|, for
4039 security reasons.
4040
4041 *'helpheight'* *'hh'*
4042'helpheight' 'hh' number (default 20)
4043 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 Minimal initial height of the help window when it is opened with the
4045 ":help" command. The initial height of the help window is half of the
4046 current window, or (when the 'ea' option is on) the same as other
4047 windows. When the height is less than 'helpheight', the height is
4048 set to 'helpheight'. Set to zero to disable.
4049
4050 *'helplang'* *'hlg'*
4051'helplang' 'hlg' string (default: messages language or empty)
4052 global
4053 {only available when compiled with the |+multi_lang|
4054 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 Comma separated list of languages. Vim will use the first language
4056 for which the desired help can be found. The English help will always
4057 be used as a last resort. You can add "en" to prefer English over
4058 another language, but that will only find tags that exist in that
4059 language and not in the English help.
4060 Example: >
4061 :set helplang=de,it
4062< This will first search German, then Italian and finally English help
4063 files.
4064 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4065 try to find the tag in the current language before using this option.
4066 See |help-translated|.
4067
4068 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4069'hidden' 'hid' boolean (default off)
4070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 When off a buffer is unloaded when it is |abandon|ed. When on a
4072 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4073 displayed in another window, it does not become hidden, of course.
4074 The commands that move through the buffer list sometimes make a buffer
4075 hidden although the 'hidden' option is off: When the buffer is
4076 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004077 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004078 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 This option is set for one command with ":hide {command}" |:hide|.
4080 WARNING: It's easy to forget that you have changes in hidden buffers.
4081 Think twice when using ":q!" or ":qa!".
4082
4083 *'highlight'* *'hl'*
4084'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004085 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4086 d:Directory,e:ErrorMsg,i:IncSearch,
4087 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004088 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004089 N:CursorLineNr,r:Question,s:StatusLine,
4090 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004091 v:Visual,V:VisualNOS,w:WarningMsg,
4092 W:WildMenu,f:Folded,F:FoldColumn,
4093 A:DiffAdd,C:DiffChange,D:DiffDelete,
4094 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004095 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004096 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004097 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4098 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004099 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004100 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 This option can be used to set highlighting mode for various
4103 occasions. It is a comma separated list of character pairs. The
4104 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004105 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004107 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4108 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 characters from 'showbreak'
4110 |hl-Directory| d directories in CTRL-D listing and other special
4111 things in listings
4112 |hl-ErrorMsg| e error messages
4113 h (obsolete, ignored)
4114 |hl-IncSearch| i 'incsearch' highlighting
4115 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4116 |hl-MoreMsg| m |more-prompt|
4117 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004118 |hl-LineNr| n line number for ":number" and ":#" commands, and
4119 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004120 |hl-LineNrAbove| a line number above the cursor for when the
4121 'relativenumber' option is set.
4122 |hl-LineNrBelow| b line number below the cursor for when the
4123 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004124 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4125 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 |hl-Question| r |hit-enter| prompt and yes/no questions
4127 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004128 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4130 |hl-VertSplit| c column used to separate vertically split windows
4131 |hl-Visual| v Visual mode
4132 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4133 Selection" Only X11 Gui's |gui-x11| and
4134 |xterm-clipboard|.
4135 |hl-WarningMsg| w warning messages
4136 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4137 |hl-Folded| f line used for closed folds
4138 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004139 |hl-DiffAdd| A added line in diff mode
4140 |hl-DiffChange| C changed line in diff mode
4141 |hl-DiffDelete| D deleted line in diff mode
4142 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004144 |hl-Conceal| - the placeholders used for concealed characters
4145 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004146 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004147 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004148 |hl-SpellRare| R rare word |spell|
4149 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004150 |hl-Pmenu| + popup menu normal line
4151 |hl-PmenuSel| = popup menu selected line
4152 |hl-PmenuSbar| x popup menu scrollbar
4153 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154
4155 The display modes are:
4156 r reverse (termcap entry "mr" and "me")
4157 i italic (termcap entry "ZH" and "ZR")
4158 b bold (termcap entry "md" and "me")
4159 s standout (termcap entry "so" and "se")
4160 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004161 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004162 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 n no highlighting
4164 - no highlighting
4165 : use a highlight group
4166 The default is used for occasions that are not included.
4167 If you want to change what the display modes do, see |dos-colors|
4168 for an example.
4169 When using the ':' display mode, this must be followed by the name of
4170 a highlight group. A highlight group can be used to define any type
4171 of highlighting, including using color. See |:highlight| on how to
4172 define one. The default uses a different group for each occasion.
4173 See |highlight-default| for the default highlight groups.
4174
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004176'history' 'hi' number (Vim default: 50, Vi default: 0,
4177 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004180 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004182 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 NOTE: This option is set to the Vi default value when 'compatible' is
4184 set and to the Vim default value when 'compatible' is reset.
4185
4186 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4187'hkmap' 'hk' 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, the keyboard is mapped for the Hebrew character set.
4192 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4193 toggle this option. See |rileft.txt|.
4194 NOTE: This option is reset when 'compatible' is set.
4195
4196 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4197'hkmapp' 'hkp' boolean (default off)
4198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 {only available when compiled with the |+rightleft|
4200 feature}
4201 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4202 This is useful if you have a non-Hebrew keyboard.
4203 See |rileft.txt|.
4204 NOTE: This option is reset when 'compatible' is set.
4205
Bram Moolenaar036986f2017-03-16 17:41:02 +01004206 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4207'hlsearch' 'hls' boolean (default off)
4208 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004209 {not available when compiled without the
4210 |+extra_search| feature}
4211 When there is a previous search pattern, highlight all its matches.
4212 The type of highlighting used can be set with the 'l' occasion in the
4213 'highlight' option. This uses the "Search" highlight group by
4214 default. Note that only the matching text is highlighted, any offsets
4215 are not applied.
4216 See also: 'incsearch' and |:match|.
4217 When you get bored looking at the highlighted matches, you can turn it
4218 off with |:nohlsearch|. This does not change the option value, as
4219 soon as you use a search command, the highlighting comes back.
4220 'redrawtime' specifies the maximum time spent on finding matches.
4221 When the search pattern can match an end-of-line, Vim will try to
4222 highlight all of the matched text. However, this depends on where the
4223 search starts. This will be the first line in the window or the first
4224 line below a closed fold. A match in a previous line which is not
4225 drawn may not continue in a newly drawn line.
4226 You can specify whether the highlight status is restored on startup
4227 with the 'h' flag in 'viminfo' |viminfo-h|.
4228 NOTE: This option is reset when 'compatible' is set.
4229
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 *'icon'* *'noicon'*
4231'icon' boolean (default off, on when title can be restored)
4232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 When on, the icon text of the window will be set to the value of
4234 'iconstring' (if it is not empty), or to the name of the file
4235 currently being edited. Only the last part of the name is used.
4236 Overridden by the 'iconstring' option.
4237 Only works if the terminal supports setting window icons (currently
4238 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4239 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4240 builtin termcap).
4241 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004242 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004244 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245
4246 *'iconstring'*
4247'iconstring' string (default "")
4248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 When this option is not empty, it will be used for the icon text of
4250 the window. This happens only when the 'icon' option is on.
4251 Only works if the terminal supports setting window icon text
4252 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004253 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 When Vim was compiled with HAVE_X11 defined, the original icon will be
4255 restored if possible |X11|.
4256 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004257 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004259 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 {not available when compiled without the |+statusline| feature}
4261
4262 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4263'ignorecase' 'ic' boolean (default off)
4264 global
4265 Ignore case in search patterns. Also used when searching in the tags
4266 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004267 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 Can be overruled by using "\c" or "\C" in the pattern, see
4269 |/ignorecase|.
4270
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004271 *'imactivatefunc'* *'imaf'*
4272'imactivatefunc' 'imaf' string (default "")
4273 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004274 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004275 activate or deactivate the Input Method. The value can be the name of
4276 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4277 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004278 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004279 The expression will be evaluated in the |sandbox| when set from a
4280 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004281
4282 Example: >
4283 function ImActivateFunc(active)
4284 if a:active
4285 ... do something
4286 else
4287 ... do something
4288 endif
4289 " return value is not used
4290 endfunction
4291 set imactivatefunc=ImActivateFunc
4292<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 *'imactivatekey'* *'imak'*
4294'imactivatekey' 'imak' string (default "")
4295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004297 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 Specifies the key that your Input Method in X-Windows uses for
4299 activation. When this is specified correctly, vim can fully control
4300 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4301 You can't use this option to change the activation key, the option
4302 tells Vim what the key is.
4303 Format:
4304 [MODIFIER_FLAG-]KEY_STRING
4305
4306 These characters can be used for MODIFIER_FLAG (case is ignored):
4307 S Shift key
4308 L Lock key
4309 C Control key
4310 1 Mod1 key
4311 2 Mod2 key
4312 3 Mod3 key
4313 4 Mod4 key
4314 5 Mod5 key
4315 Combinations are allowed, for example "S-C-space" or "SC-space" are
4316 both shift+ctrl+space.
4317 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4318
4319 Example: >
4320 :set imactivatekey=S-space
4321< "S-space" means shift+space. This is the activation key for kinput2 +
4322 canna (Japanese), and ami (Korean).
4323
4324 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4325'imcmdline' 'imc' boolean (default off)
4326 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 When set the Input Method is always on when starting to edit a command
4328 line, unless entering a search pattern (see 'imsearch' for that).
4329 Setting this option is useful when your input method allows entering
4330 English characters directly, e.g., when it's used to type accented
4331 characters with dead keys.
4332
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004333 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 When set the Input Method is never used. This is useful to disable
4337 the IM when it doesn't work properly.
4338 Currently this option is on by default for SGI/IRIX machines. This
4339 may change in later releases.
4340
4341 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004342'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 Specifies whether :lmap or an Input Method (IM) is to be used in
4345 Insert mode. Valid values:
4346 0 :lmap is off and IM is off
4347 1 :lmap is ON and IM is off
4348 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 To always reset the option to zero when leaving Insert mode with <Esc>
4350 this can be used: >
4351 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4352< This makes :lmap and IM turn off automatically when leaving Insert
4353 mode.
4354 Note that this option changes when using CTRL-^ in Insert mode
4355 |i_CTRL-^|.
4356 The value is set to 1 when setting 'keymap' to a valid keymap name.
4357 It is also used for the argument of commands like "r" and "f".
4358 The value 0 may not work correctly with Athena and Motif with some XIM
4359 methods. Use 'imdisable' to disable XIM then.
4360
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004361 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004362 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004363 |+multi_byte_ime| or |global-ime|.
4364
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004366'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 Specifies whether :lmap or an Input Method (IM) is to be used when
4369 entering a search pattern. Valid values:
4370 -1 the value of 'iminsert' is used, makes it look like
4371 'iminsert' is also used when typing a search pattern
4372 0 :lmap is off and IM is off
4373 1 :lmap is ON and IM is off
4374 2 :lmap is off and IM is ON
4375 Note that this option changes when using CTRL-^ in Command-line mode
4376 |c_CTRL-^|.
4377 The value is set to 1 when it is not -1 and setting the 'keymap'
4378 option to a valid keymap name.
4379 The value 0 may not work correctly with Athena and Motif with some XIM
4380 methods. Use 'imdisable' to disable XIM then.
4381
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004382 *'imstatusfunc'* *'imsf'*
4383'imstatusfunc' 'imsf' string (default "")
4384 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004385 This option specifies a function that is called to obtain the status
4386 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004387 The value can be the name of a function, a |lambda| or a |Funcref|.
4388 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004389 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004390
4391 Example: >
4392 function ImStatusFunc()
4393 let is_active = ...do something
4394 return is_active ? 1 : 0
4395 endfunction
4396 set imstatusfunc=ImStatusFunc
4397<
4398 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004399 The expression will be evaluated in the |sandbox| when set from a
4400 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004401
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004402 *'imstyle'* *'imst'*
4403'imstyle' 'imst' number (default 1)
4404 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004405 {only available when compiled with |+xim| and
4406 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004407 This option specifies the input style of Input Method:
4408 0 use on-the-spot style
4409 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004410 See: |xim-input-style|
4411
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004412 For a long time on-the-spot style had been used in the GTK version of
4413 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004414 |single-repeat|, etc. Therefore over-the-spot style becomes the
4415 default now. This should work fine for most people, however if you
4416 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004417 The expression will be evaluated in the |sandbox| when set from a
4418 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004419
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 *'include'* *'inc'*
4421'include' 'inc' string (default "^\s*#\s*include")
4422 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 {not available when compiled without the
4424 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004425 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 pattern, just like for the "/" command (See |pattern|). The default
4427 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004428 "]I", "[d", etc.
4429 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004430 comes after the matched pattern. But if "\zs" appears in the pattern
4431 then the text matched from "\zs" to the end, or until "\ze" if it
4432 appears, is used as the file name. Use this to include characters
4433 that are not in 'isfname', such as a space. You can then use
4434 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004435 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436
4437 *'includeexpr'* *'inex'*
4438'includeexpr' 'inex' string (default "")
4439 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004441 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004443 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 :set includeexpr=substitute(v:fname,'\\.','/','g')
4445< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004446
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004448 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 Also used for |<cfile>|.
4450
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004451 If the expression starts with s: or |<SID>|, then it is replaced with
4452 the script ID (|local-function|). Example: >
4453 set includeexpr=s:MyIncludeExpr(v:fname)
4454 set includeexpr=<SID>SomeIncludeExpr(v:fname)
4455<
Bram Moolenaar30b65812012-07-12 22:01:11 +02004456 The expression will be evaluated in the |sandbox| when set from a
4457 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004458 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004459
4460 It is not allowed to change text or jump to another window while
4461 evaluating 'includeexpr' |textlock|.
4462
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004464'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4465 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004468 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004469 While typing a search command, show where the pattern, as it was typed
4470 so far, matches. The matched string is highlighted. If the pattern
4471 is invalid or not found, nothing is shown. The screen will be updated
4472 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004473 Also applies to the pattern in commands: >
4474 :global
4475 :lvimgrep
4476 :lvimgrepadd
4477 :smagic
4478 :snomagic
4479 :sort
4480 :substitute
4481 :vglobal
4482 :vimgrep
4483 :vimgrepadd
4484< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004485 original position when no match is found and when pressing <Esc>. You
4486 still need to finish the search command with <Enter> to move the
4487 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004488 You can use the CTRL-G and CTRL-T keys to move to the next and
4489 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004490 When compiled with the |+reltime| feature Vim only searches for about
4491 half a second. With a complicated pattern and/or a lot of text the
4492 match may not be found. This is to avoid that Vim hangs while you
4493 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004494 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004495 When 'hlsearch' is on, all matched strings are highlighted too while
4496 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004497 If you don't want to turn 'hlsearch' on, but want to highlight all
4498 matches while searching, you can turn on and off 'hlsearch' with
4499 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004500 augroup vimrc-incsearch-highlight
4501 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004502 autocmd CmdlineEnter /,\? :set hlsearch
4503 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004504 augroup END
4505<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004506 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004507 to the command line. If 'ignorecase' and 'smartcase' are set and the
4508 command line has no uppercase characters, the added character is
4509 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004510 CTRL-R CTRL-W can be used to add the word at the end of the current
4511 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 NOTE: This option is reset when 'compatible' is set.
4513
4514 *'indentexpr'* *'inde'*
4515'indentexpr' 'inde' string (default "")
4516 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 {not available when compiled without the |+cindent|
4518 or |+eval| features}
4519 Expression which is evaluated to obtain the proper indent for a line.
4520 It is used when a new line is created, for the |=| operator and
4521 in Insert mode as specified with the 'indentkeys' option.
4522 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004523 'smartindent' indenting. When 'lisp' is set, this option is
4524 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 When 'paste' is set this option is not used for indenting.
4526 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004527 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 when the expression is evaluated (but it may be moved around).
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004529 If the expression starts with s: or |<SID>|, then it is replaced with
4530 the script ID (|local-function|). Example: >
4531 set indentexpr=s:MyIndentExpr()
4532 set indentexpr=<SID>SomeIndentExpr()
4533<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 The expression must return the number of spaces worth of indent. It
4535 can return "-1" to keep the current indent (this means 'autoindent' is
4536 used for the indent).
4537 Functions useful for computing the indent are |indent()|, |cindent()|
4538 and |lispindent()|.
4539 The evaluation of the expression must not have side effects! It must
4540 not change the text, jump to another window, etc. Afterwards the
4541 cursor position is always restored, thus the cursor may be moved.
4542 Normally this option would be set to call a function: >
4543 :set indentexpr=GetMyIndent()
4544< Error messages will be suppressed, unless the 'debug' option contains
4545 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004546 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004547 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548
Bram Moolenaar30b65812012-07-12 22:01:11 +02004549 The expression will be evaluated in the |sandbox| when set from a
4550 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004551 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004552
4553 It is not allowed to change text or jump to another window while
4554 evaluating 'indentexpr' |textlock|.
4555
4556
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004558'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 {not available when compiled without the |+cindent|
4561 feature}
4562 A list of keys that, when typed in Insert mode, cause reindenting of
4563 the current line. Only happens if 'indentexpr' isn't empty.
4564 The format is identical to 'cinkeys', see |indentkeys-format|.
4565 See |C-indenting| and |indent-expression|.
4566
4567 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4568'infercase' 'inf' boolean (default off)
4569 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004571 'ignorecase' is also on, the case of the match is adjusted depending
4572 on the typed text. If the typed text contains a lowercase letter
4573 where the match has an upper case letter, the completed part is made
4574 lowercase. If the typed text has no lowercase letters and the match
4575 has a lowercase letter where the typed text has an uppercase letter,
4576 and there is a letter before it, the completed part is made uppercase.
4577 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578
4579 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4580'insertmode' 'im' boolean (default off)
4581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 Makes Vim work in a way that Insert mode is the default mode. Useful
4583 if you want to use Vim as a modeless editor. Used for |evim|.
4584 These Insert mode commands will be useful:
4585 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004586 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 this is a mapping, it is executed as if 'insertmode' was off.
4588 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004590 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4591 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592
4593 These items change when 'insertmode' is set:
4594 - when starting to edit of a file, Vim goes to Insert mode.
4595 - <Esc> in Insert mode is a no-op and beeps.
4596 - <Esc> in Normal mode makes Vim go to Insert mode.
4597 - CTRL-L in Insert mode is a command, it is not inserted.
4598 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4599 However, when <Esc> is used inside a mapping, it behaves like
4600 'insertmode' was not set. This was done to be able to use the same
4601 mappings with 'insertmode' set or not set.
4602 When executing commands with |:normal| 'insertmode' is not used.
4603
4604 NOTE: This option is reset when 'compatible' is set.
4605
4606 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004607'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4609 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4610 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4611 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4612 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 The characters specified by this option are included in file names and
4615 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004616 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 Multi-byte characters 256 and above are always included, only the
4618 characters up to 255 are specified with this option.
4619 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004620 Think twice before adding white space to this option. Although a
4621 space may appear inside a file name, the effect will be that Vim
4622 doesn't know where a file name starts or ends when doing completion.
4623 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624
4625 Note that on systems using a backslash as path separator, Vim tries to
4626 do its best to make it work as you would expect. That is a bit
4627 tricky, since Vi originally used the backslash to escape special
4628 characters. Vim will not remove a backslash in front of a normal file
4629 name character on these systems, but it will on Unix and alikes. The
4630 '&' and '^' are not included by default, because these are special for
4631 cmd.exe.
4632
4633 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004634 Each part can be a single character number or a range. A range is two
4635 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 decimal number between 0 and 255 or the ASCII character itself (does
4637 not work for digits). Example:
4638 "_,-,128-140,#-43" (include '_' and '-' and the range
4639 128 to 140 and '#' to 43)
4640 If a part starts with '^', the following character number or range
4641 will be excluded from the option. The option is interpreted from left
4642 to right. Put the excluded character after the range where it is
4643 included. To include '^' itself use it as the last character of the
4644 option or the end of a range. Example:
4645 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4646 If the character is '@', all characters where isalpha() returns TRUE
4647 are included. Normally these are the characters a to z and A to Z,
4648 plus accented characters. To include '@' itself use "@-@". Examples:
4649 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004650 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 "a-z,A-Z,@-@" All letters plus the '@' character.
4652 A comma can be included by using it where a character number is
4653 expected. Example:
4654 "48-57,,,_" Digits, comma and underscore.
4655 A comma can be excluded by prepending a '^'. Example:
4656 " -~,^,,9" All characters from space to '~', excluding
4657 comma, plus <Tab>.
4658 See |option-backslash| about including spaces and backslashes.
4659
4660 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004661'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 "@,48-57,_,128-167,224-235"
4663 otherwise: "@,48-57,_,192-255")
4664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 The characters given by this option are included in identifiers.
4666 Identifiers are used in recognizing environment variables and after a
4667 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004668 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004669 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004671 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4673
4674 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004675'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 "@,48-57,_,128-167,224-235"
4677 otherwise: "@,48-57,_,192-255"
4678 Vi default: "@,48-57,_")
4679 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004681 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004682 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004683 characters above 255 check the "word" character class (any character
4684 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004685 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 For a help file it is set to all non-blank printable characters except
4687 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4688 command).
4689 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004690 This option also influences syntax highlighting, unless the syntax
4691 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 NOTE: This option is set to the Vi default value when 'compatible' is
4693 set and to the Vim default value when 'compatible' is reset.
4694
4695 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004696'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 "@,~-255"; otherwise: "@,161-255")
4698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 The characters given by this option are displayed directly on the
4700 screen. It is also used for "\p" in a |pattern|. The characters from
4701 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4702 even when they are not included in 'isprint' or excluded. See
4703 'isfname' for a description of the format of this option.
4704
4705 Non-printable characters are displayed with two characters:
4706 0 - 31 "^@" - "^_"
4707 32 - 126 always single characters
4708 127 "^?"
4709 128 - 159 "~@" - "~_"
4710 160 - 254 "| " - "|~"
4711 255 "~?"
4712 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4713 displayed as <xx>, with the hexadecimal value of the byte.
4714 When 'display' contains "uhex" all unprintable characters are
4715 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004716 The SpecialKey highlighting will be used for unprintable characters.
4717 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718
4719 Multi-byte characters 256 and above are always included, only the
4720 characters up to 255 are specified with this option. When a character
4721 is printable but it is not available in the current font, a
4722 replacement character will be shown.
4723 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4724 There is no option to specify these characters.
4725
4726 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4727'joinspaces' 'js' boolean (default on)
4728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 Insert two spaces after a '.', '?' and '!' with a join command.
4730 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4731 Otherwise only one space is inserted.
4732 NOTE: This option is set when 'compatible' is set.
4733
4734 *'key'*
4735'key' string (default "")
4736 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004737 {only available when compiled with the |+cryptv|
4738 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004740 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 Careful: Do not set the key value by hand, someone might see the typed
4742 key. Use the |:X| command. But you can make 'key' empty: >
4743 :set key=
4744< It is not possible to get the value of this option with ":set key" or
4745 "echo &key". This is to avoid showing it to someone who shouldn't
4746 know. It also means you cannot see it yourself once you have set it,
4747 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004748 You can use "&key" in an expression to detect whether encryption is
4749 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750
4751 *'keymap'* *'kmp'* *E544*
4752'keymap' 'kmp' string (default "")
4753 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 {only available when compiled with the |+keymap|
4755 feature}
4756 Name of a keyboard mapping. See |mbyte-keymap|.
4757 Setting this option to a valid keymap name has the side effect of
4758 setting 'iminsert' to one, so that the keymap becomes effective.
4759 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004760 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761
4762 *'keymodel'* *'km'*
4763'keymodel' 'km' string (default "")
4764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 List of comma separated words, which enable special things that keys
4766 can do. These values can be used:
4767 startsel Using a shifted special key starts selection (either
4768 Select mode or Visual mode, depending on "key" being
4769 present in 'selectmode').
4770 stopsel Using a not-shifted special key stops selection.
4771 Special keys in this context are the cursor keys, <End>, <Home>,
4772 <PageUp> and <PageDown>.
4773 The 'keymodel' option is set by the |:behave| command.
4774
4775 *'keywordprg'* *'kp'*
4776'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004777 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 Program to use for the |K| command. Environment variables are
4780 expanded |:set_env|. ":help" may be used to access the Vim internal
4781 help. (Note that previously setting the global option to the empty
4782 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004783 When the first character is ":", the command is invoked as a Vim
4784 Ex command prefixed with [count].
4785 When "man", "man -s" or an Ex command is used, Vim will automatically
4786 translate a count for the "K" command and pass it as the first
4787 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 See |option-backslash| about including spaces and backslashes.
4789 Example: >
4790 :set keywordprg=man\ -s
4791< This option cannot be set from a |modeline| or in the |sandbox|, for
4792 security reasons.
4793
4794 *'langmap'* *'lmap'* *E357* *E358*
4795'langmap' 'lmap' string (default "")
4796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 {only available when compiled with the |+langmap|
4798 feature}
4799 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004800 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004801 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 care of translating these special characters to the original meaning
4803 of the key. This means you don't have to change the keyboard mode to
4804 be able to execute Normal mode commands.
4805 This is the opposite of the 'keymap' option, where characters are
4806 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004807 Also consider setting 'langremap' to off, to prevent 'langmap' from
4808 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004809 This option cannot be set from a |modeline| or in the |sandbox|, for
4810 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004812 Example (for Greek, in UTF-8): *greek* >
4813 :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 +00004814< Example (exchanges meaning of z and y for commands): >
4815 :set langmap=zy,yz,ZY,YZ
4816<
4817 The 'langmap' option is a list of parts, separated with commas. Each
4818 part can be in one of two forms:
4819 1. A list of pairs. Each pair is a "from" character immediately
4820 followed by the "to" character. Examples: "aA", "aAbBcC".
4821 2. A list of "from" characters, a semi-colon and a list of "to"
4822 characters. Example: "abc;ABC"
4823 Example: "aA,fgh;FGH,cCdDeE"
4824 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004825 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826
4827 This will allow you to activate vim actions without having to switch
4828 back and forth between the languages. Your language characters will
4829 be understood as normal vim English characters (according to the
4830 langmap mappings) in the following cases:
4831 o Normal/Visual mode (commands, buffer/register names, user mappings)
4832 o Insert/Replace Mode: Register names after CTRL-R
4833 o Insert/Replace Mode: Mappings
4834 Characters entered in Command-line mode will NOT be affected by
4835 this option. Note that this option can be changed at any time
4836 allowing to switch between mappings for different languages/encodings.
4837 Use a mapping to avoid having to type it each time!
4838
4839 *'langmenu'* *'lm'*
4840'langmenu' 'lm' string (default "")
4841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 {only available when compiled with the |+menu| and
4843 |+multi_lang| features}
4844 Language to use for menu translation. Tells which file is loaded
4845 from the "lang" directory in 'runtimepath': >
4846 "lang/menu_" . &langmenu . ".vim"
4847< (without the spaces). For example, to always use the Dutch menus, no
4848 matter what $LANG is set to: >
4849 :set langmenu=nl_NL.ISO_8859-1
4850< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004851 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 If your $LANG is set to a non-English language but you do want to use
4853 the English menus: >
4854 :set langmenu=none
4855< This option must be set before loading menus, switching on filetype
4856 detection or syntax highlighting. Once the menus are defined setting
4857 this option has no effect. But you could do this: >
4858 :source $VIMRUNTIME/delmenu.vim
4859 :set langmenu=de_DE.ISO_8859-1
4860 :source $VIMRUNTIME/menu.vim
4861< Warning: This deletes all menus that you defined yourself!
4862
Bram Moolenaard94464e2015-11-02 15:28:18 +01004863 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004864'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004865 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004866 {only available when compiled with the |+langmap|
4867 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004868 This is just like 'langremap' but with the value inverted. It only
4869 exists for backwards compatibility. When setting 'langremap' then
4870 'langnoremap' is set to the inverted value, and the other way around.
4871
4872 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004873'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004874 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004875 {only available when compiled with the |+langmap|
4876 feature}
4877 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004878 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004879 'langmap' disables some of your mappings, try resetting this option.
4880 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004881 that works for you to avoid mappings to break.
4882
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 *'laststatus'* *'ls'*
4884'laststatus' 'ls' number (default 1)
4885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 The value of this option influences when the last window will have a
4887 status line:
4888 0: never
4889 1: only if there are at least two windows
4890 2: always
4891 The screen looks nicer with a status line if you have several
4892 windows, but it takes another screen line. |status-line|
4893
4894 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4895'lazyredraw' 'lz' boolean (default off)
4896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 When this option is set, the screen will not be redrawn while
4898 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004899 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 update use |:redraw|.
4901
4902 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4903'linebreak' 'lbr' boolean (default off)
4904 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004905 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004907 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 than at the last character that fits on the screen. Unlike
4909 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004910 it only affects the way the file is displayed, not its contents.
4911 If 'breakindent' is set, line is visually indented. Then, the value
4912 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004913 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 Note that <Tab> characters after an <EOL> are mostly not displayed
4915 with the right amount of white space.
4916
4917 *'lines'* *E593*
4918'lines' number (default 24 or terminal height)
4919 global
4920 Number of lines of the Vim window.
4921 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004922 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 When Vim is running in the GUI or in a resizable window, setting this
4924 option will cause the window size to be changed. When you only want
4925 to use the size for the GUI, put the command in your |gvimrc| file.
4926 Vim limits the number of lines to what fits on the screen. You can
4927 use this command to get the tallest window possible: >
4928 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004929< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004930 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 When you set this option and Vim is unable to change the physical
4932 number of lines of the display, the display may be messed up.
4933
4934 *'linespace'* *'lsp'*
4935'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 {only in the GUI}
4938 Number of pixel lines inserted between characters. Useful if the font
4939 uses the full character cell height, making lines touch each other.
4940 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004941 With some fonts there can be too much room between lines (to have
4942 space for ascents and descents). Then it makes sense to set
4943 'linespace' to a negative value. This may cause display problems
4944 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945
4946 *'lisp'* *'nolisp'*
4947'lisp' boolean (default off)
4948 local to buffer
4949 {not available when compiled without the |+lispindent|
4950 feature}
4951 Lisp mode: When <Enter> is typed in insert mode set the indent for
4952 the next line to Lisp standards (well, sort of). Also happens with
4953 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4954 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4955 better. Also see 'lispwords'.
4956 The '-' character is included in keyword characters. Redefines the
4957 "=" operator to use this same indentation algorithm rather than
4958 calling an external program if 'equalprg' is empty.
4959 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960
4961 *'lispwords'* *'lw'*
4962'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004963 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 {not available when compiled without the |+lispindent|
4965 feature}
4966 Comma separated list of words that influence the Lisp indenting.
4967 |'lisp'|
4968
4969 *'list'* *'nolist'*
4970'list' boolean (default off)
4971 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004972 List mode: By default show tabs as CTRL-I is displayed, display $
4973 after end of line. Useful to see the difference between tabs and
4974 spaces and for trailing blanks. Further changed by the 'listchars'
4975 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004976
4977 The cursor is displayed at the start of the space a Tab character
4978 occupies, not at the end as usual in Normal mode. To get this cursor
4979 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004980 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004981<
4982 Note that list mode will also affect formatting (set with 'textwidth'
4983 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 changing the way tabs are displayed.
4985
4986 *'listchars'* *'lcs'*
4987'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004988 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004989 Strings to use in 'list' mode and for the |:list| command. It is a
4990 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004991 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 eol:c Character to show at the end of each line. When
4993 omitted, there is no extra character at the end of the
4994 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004995 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004996 tab:xy[z] Two or three characters to be used to show a tab.
4997 The third character is optional.
4998
4999 tab:xy The 'x' is always used, then 'y' as many times as will
5000 fit. Thus "tab:>-" displays:
5001 >
5002 >-
5003 >--
5004 etc.
5005
5006 tab:xyz The 'z' is always used, then 'x' is prepended, and
5007 then 'y' is used as many times as will fit. Thus
5008 "tab:<->" displays:
5009 >
5010 <>
5011 <->
5012 <-->
5013 etc.
5014
5015 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005016 *lcs-space*
5017 space:c Character to show for a space. When omitted, spaces
5018 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005019 *lcs-multispace*
5020 multispace:c...
5021 One or more characters to use cyclically to show for
5022 multiple consecutive spaces. Overrides the "space"
5023 setting, except for single spaces. When omitted, the
5024 "space" setting is used. For example,
5025 `:set listchars=multispace:---+` shows ten consecutive
5026 spaces as:
5027 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005028 *lcs-lead*
5029 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005030 leading spaces are blank. Overrides the "space" and
5031 "multispace" settings for leading spaces. You can
5032 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005033 :set listchars+=tab:>-,lead:.
5034< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005035 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005036 trailing spaces are blank. Overrides the "space" and
5037 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005038 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 extends:c Character to show in the last column, when 'wrap' is
5040 off and the line continues beyond the right of the
5041 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005042 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005043 precedes:c Character to show in the first visible column of the
5044 physical line, when there is text preceding the
5045 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005046 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005047 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005048 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005049 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005050 nbsp:c Character to show for a non-breakable space character
5051 (0xA0 (160 decimal) and U+202F). Left blank when
5052 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005054 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005056 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005058 Each character can be specified as hex: >
5059 set listchars=eol:\\x24
5060 set listchars=eol:\\u21b5
5061 set listchars=eol:\\U000021b5
5062< Note that a double backslash is used. The number of hex characters
5063 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5064
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 Examples: >
5066 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005067 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 :set lcs=extends:>,precedes:<
5069< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005070 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5071 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005072 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073
5074 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5075'loadplugins' 'lpl' boolean (default on)
5076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 When on the plugin scripts are loaded when starting up |load-plugins|.
5078 This option can be reset in your |vimrc| file to disable the loading
5079 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005080 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5081 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082
Bram Moolenaard94464e2015-11-02 15:28:18 +01005083 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005084'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005085 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005086 {only available when compiled with the |+lua/dyn|
5087 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005088 Specifies the name of the Lua shared library. The default is
5089 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005090 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005091 This option cannot be set from a |modeline| or in the |sandbox|, for
5092 security reasons.
5093
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005094 *'macatsui'* *'nomacatsui'*
5095'macatsui' boolean (default on)
5096 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005097 {not supported}
5098 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005099
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 *'magic'* *'nomagic'*
5101'magic' boolean (default on)
5102 global
5103 Changes the special characters that can be used in search patterns.
5104 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005105 WARNING: Switching this option off most likely breaks plugins! That
5106 is because many patterns assume it's on and will fail when it's off.
5107 Only switch it off when working with old Vi scripts. In any other
5108 situation write patterns that work when 'magic' is on. Include "\M"
5109 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005110 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5111 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112
5113 *'makeef'* *'mef'*
5114'makeef' 'mef' string (default: "")
5115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 {not available when compiled without the |+quickfix|
5117 feature}
5118 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5119 and the |:grep| command.
5120 When it is empty, an internally generated temp file will be used.
5121 When "##" is included, it is replaced by a number to make the name
5122 unique. This makes sure that the ":make" command doesn't overwrite an
5123 existing file.
5124 NOT used for the ":cf" command. See 'errorfile' for that.
5125 Environment variables are expanded |:set_env|.
5126 See |option-backslash| about including spaces and backslashes.
5127 This option cannot be set from a |modeline| or in the |sandbox|, for
5128 security reasons.
5129
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005130 *'makeencoding'* *'menc'*
5131'makeencoding' 'menc' string (default "")
5132 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005133 Encoding used for reading the output of external commands. When empty,
5134 encoding is not converted.
5135 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5136 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5137 and `:laddfile`.
5138
5139 This would be mostly useful when you use MS-Windows and set 'encoding'
5140 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5141 'makeencoding' to "char" has the same effect as setting to the system
5142 locale encoding. Example: >
5143 :set encoding=utf-8
5144 :set makeencoding=char " system locale is used
5145<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 *'makeprg'* *'mp'*
5147'makeprg' 'mp' string (default "make", VMS: "MMS")
5148 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005149 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005150 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5151 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005152 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005153 Environment variables are expanded |:set_env|. See |option-backslash|
5154 about including spaces and backslashes.
5155 Note that a '|' must be escaped twice: once for ":set" and once for
5156 the interpretation of a command. When you use a filter called
5157 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 :set makeprg=gmake\ \\\|\ myfilter
5159< The placeholder "$*" can be given (even multiple times) to specify
5160 where the arguments will be included, for example: >
5161 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5162< This option cannot be set from a |modeline| or in the |sandbox|, for
5163 security reasons.
5164
5165 *'matchpairs'* *'mps'*
5166'matchpairs' 'mps' string (default "(:),{:},[:]")
5167 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005169 other.
5170 Only character pairs are allowed that are different, thus you cannot
5171 jump between two double quotes.
5172 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005173 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005174 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 :set mps+=<:>
5176
5177< A more exotic example, to jump between the '=' and ';' in an
5178 assignment, useful for languages like C and Java: >
5179 :au FileType c,cpp,java set mps+==:;
5180
5181< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005182 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183
5184 *'matchtime'* *'mat'*
5185'matchtime' 'mat' number (default 5)
5186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 Tenths of a second to show the matching paren, when 'showmatch' is
5188 set. Note that this is not in milliseconds, like other options that
5189 set a time. This is to be compatible with Nvi.
5190
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005191 *'maxcombine'* *'mco'*
5192'maxcombine' 'mco' number (default 2)
5193 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005194 The maximum number of combining characters supported for displaying.
5195 Only used when 'encoding' is "utf-8".
5196 The default is OK for most languages. Hebrew may require 4.
5197 Maximum value is 6.
5198 Even when this option is set to 2 you can still edit text with more
5199 combining characters, you just can't see them. Use |g8| or |ga|.
5200 See |mbyte-combining|.
5201
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 *'maxfuncdepth'* *'mfd'*
5203'maxfuncdepth' 'mfd' number (default 100)
5204 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005205 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005206 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 Maximum depth of function calls for user functions. This normally
5208 catches endless recursion. When using a recursive function with
5209 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5210 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005211 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005212 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 See also |:function|.
5214
5215 *'maxmapdepth'* *'mmd'* *E223*
5216'maxmapdepth' 'mmd' number (default 1000)
5217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 Maximum number of times a mapping is done without resulting in a
5219 character to be used. This normally catches endless mappings, like
5220 ":map x y" with ":map y x". It still does not catch ":map g wg",
5221 because the 'w' is used before the next mapping is done. See also
5222 |key-mapping|.
5223
5224 *'maxmem'* *'mm'*
5225'maxmem' 'mm' number (default between 256 to 5120 (system
5226 dependent) or half the amount of memory
5227 available)
5228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5230 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005231 other memory to be freed.
5232 The maximum usable value is about 2000000. Use this to work without a
5233 limit.
5234 The value is ignored when 'swapfile' is off.
5235 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005237 *'maxmempattern'* *'mmp'*
5238'maxmempattern' 'mmp' number (default 1000)
5239 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005240 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005241 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005242 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005243 When Vim runs into the limit it gives an error message and mostly
5244 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005245 Running into the limit often means that the pattern is very
5246 inefficient or too complex. This may already happen with the pattern
5247 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005248 Might also happen on redraw, when syntax rules try to match a complex
5249 text structure.
5250 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5251 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005252
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 *'maxmemtot'* *'mmt'*
5254'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5255 dependent) or half the amount of memory
5256 available)
5257 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005258 Maximum amount of memory in Kbyte to use for all buffers together.
5259 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005260 without a limit.
5261 On 64 bit machines higher values might work. But hey, do you really
5262 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005263 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005264 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005265 Buffers with 'swapfile' off still count to the total amount of memory
5266 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005267 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268
5269 *'menuitems'* *'mis'*
5270'menuitems' 'mis' number (default 25)
5271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 {not available when compiled without the |+menu|
5273 feature}
5274 Maximum number of items to use in a menu. Used for menus that are
5275 generated from a list of items, e.g., the Buffers menu. Changing this
5276 option has no direct effect, the menu must be refreshed first.
5277
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005278 *'mkspellmem'* *'msm'*
5279'mkspellmem' 'msm' string (default "460000,2000,500")
5280 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005281 {not available when compiled without the |+syntax|
5282 feature}
5283 Parameters for |:mkspell|. This tunes when to start compressing the
5284 word tree. Compression can be slow when there are many words, but
5285 it's needed to avoid running out of memory. The amount of memory used
5286 per word depends very much on how similar the words are, that's why
5287 this tuning is complicated.
5288
5289 There are three numbers, separated by commas:
5290 {start},{inc},{added}
5291
5292 For most languages the uncompressed word tree fits in memory. {start}
5293 gives the amount of memory in Kbyte that can be used before any
5294 compression is done. It should be a bit smaller than the amount of
5295 memory that is available to Vim.
5296
5297 When going over the {start} limit the {inc} number specifies the
5298 amount of memory in Kbyte that can be allocated before another
5299 compression is done. A low number means compression is done after
5300 less words are added, which is slow. A high number means more memory
5301 will be allocated.
5302
5303 After doing compression, {added} times 1024 words can be added before
5304 the {inc} limit is ignored and compression is done when any extra
5305 amount of memory is needed. A low number means there is a smaller
5306 chance of hitting the {inc} limit, less memory is used but it's
5307 slower.
5308
5309 The languages for which these numbers are important are Italian and
5310 Hungarian. The default works for when you have about 512 Mbyte. If
5311 you have 1 Gbyte you could use: >
5312 :set mkspellmem=900000,3000,800
5313< If you have less than 512 Mbyte |:mkspell| may fail for some
5314 languages, no matter what you set 'mkspellmem' to.
5315
Bram Moolenaar07607392019-05-26 19:20:43 +02005316 This option cannot be set from a |modeline| or in the |sandbox|.
5317
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005319'modeline' 'ml' boolean (Vim default: on (off for root),
5320 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005322 If 'modeline' is on 'modelines' gives the number of lines that is
5323 checked for set commands. If 'modeline' is off or 'modelines' is zero
5324 no lines are checked. See |modeline|.
5325
5326 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5327'modelineexpr' 'mle' boolean (default: off)
5328 global
5329 When on allow some options that are an expression to be set in the
5330 modeline. Check the option for whether it is affected by
5331 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005332 This option cannot be set from a |modeline| or in the |sandbox|, for
5333 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005334
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 *'modelines'* *'mls'*
5336'modelines' 'mls' number (default 5)
5337 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 If 'modeline' is on 'modelines' gives the number of lines that is
5339 checked for set commands. If 'modeline' is off or 'modelines' is zero
5340 no lines are checked. See |modeline|.
5341 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5342 set and to the Vim default value when 'compatible' is reset.
5343
5344 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005345 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346'modifiable' 'ma' boolean (default on)
5347 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348 When off the buffer contents cannot be changed. The 'fileformat' and
5349 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005350 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351
5352 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5353'modified' 'mod' boolean (default off)
5354 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 When on, the buffer is considered to be modified. This option is set
5356 when:
5357 1. A change was made to the text since it was last written. Using the
5358 |undo| command to go back to the original text will reset the
5359 option. But undoing changes that were made before writing the
5360 buffer will set the option again, since the text is different from
5361 when it was written.
5362 2. 'fileformat' or 'fileencoding' is different from its original
5363 value. The original value is set when the buffer is read or
5364 written. A ":set nomodified" command also resets the original
5365 values to the current values and the 'modified' option will be
5366 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005367 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005368 This option is not set when a change is made to the buffer as the
5369 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5370 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5371 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5373 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005374 Note that the text may actually be the same, e.g. 'modified' is set
5375 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376
5377 *'more'* *'nomore'*
5378'more' boolean (Vim default: on, Vi default: off)
5379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 When on, listings pause when the whole screen is filled. You will get
5381 the |more-prompt|. When this option is off there are no pauses, the
5382 listing continues until finished.
5383 NOTE: This option is set to the Vi default value when 'compatible' is
5384 set and to the Vim default value when 'compatible' is reset.
5385
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005386 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005387'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005388 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005390 Enable the use of the mouse. Works for most terminals (xterm, Win32
5391 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5392 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5393 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005394 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 v Visual mode
5396 i Insert mode
5397 c Command-line mode
5398 h all previous modes when editing a help file
5399 a all previous modes
5400 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005401 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005403< If your terminal can't overrule the mouse events going to the
5404 application, use: >
5405 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005406< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005407 back to Vim using the mouse events.
5408 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5409 "xterm".
5410
5411 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 modeless selection. This doesn't move the text cursor.
5413
5414 See |mouse-using|. Also see |'clipboard'|.
5415
5416 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005417 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 the mouse buttons can still be used by keeping the shift key pressed.
5419 Also see the 'clipboard' option.
5420
5421 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5422'mousefocus' 'mousef' boolean (default off)
5423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 {only works in the GUI}
5425 The window that the mouse pointer is on is automatically activated.
5426 When changing the window layout or window focus in another way, the
5427 mouse pointer is moved to the window with keyboard focus. Off is the
5428 default because it makes using the pull down menus a little goofy, as
5429 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005430 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005431 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432
5433 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5434'mousehide' 'mh' boolean (default on)
5435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 {only works in the GUI}
5437 When on, the mouse pointer is hidden when characters are typed.
5438 The mouse pointer is restored when the mouse is moved.
5439
5440 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005441'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 Sets the model to use for the mouse. The name mostly specifies what
5444 the right mouse button is used for:
5445 extend Right mouse button extends a selection. This works
5446 like in an xterm.
5447 popup Right mouse button pops up a menu. The shifted left
5448 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005449 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450 popup_setpos Like "popup", but the cursor will be moved to the
5451 position where the mouse was clicked, and thus the
5452 selected operation will act upon the clicked object.
5453 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005454 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 course, that right clicking outside a selection will
5456 end Visual mode.
5457 Overview of what button does what for each model:
5458 mouse extend popup(_setpos) ~
5459 left click place cursor place cursor
5460 left drag start selection start selection
5461 shift-left search word extend selection
5462 right click extend selection popup menu (place cursor)
5463 right drag extend selection -
5464 middle click paste paste
5465
5466 In the "popup" model the right mouse button produces a pop-up menu.
5467 You need to define this first, see |popup-menu|.
5468
5469 Note that you can further refine the meaning of buttons with mappings.
5470 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5471 selection (because that's handled in the GUI code directly).
5472
5473 The 'mousemodel' option is set by the |:behave| command.
5474
5475 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005476'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5477 vs:leftright,vd:lrsizing,m:no,
5478 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 {only available when compiled with the |+mouseshape|
5481 feature}
5482 This option tells Vim what the mouse pointer should look like in
5483 different modes. The option is a comma separated list of parts, much
5484 like used for 'guicursor'. Each part consist of a mode/location-list
5485 and an argument-list:
5486 mode-list:shape,mode-list:shape,..
5487 The mode-list is a dash separated list of these modes/locations:
5488 In a normal window: ~
5489 n Normal mode
5490 v Visual mode
5491 ve Visual mode with 'selection' "exclusive" (same as 'v',
5492 if not specified)
5493 o Operator-pending mode
5494 i Insert mode
5495 r Replace mode
5496
5497 Others: ~
5498 c appending to the command-line
5499 ci inserting in the command-line
5500 cr replacing in the command-line
5501 m at the 'Hit ENTER' or 'More' prompts
5502 ml idem, but cursor in the last line
5503 e any mode, pointer below last window
5504 s any mode, pointer on a status line
5505 sd any mode, while dragging a status line
5506 vs any mode, pointer on a vertical separator line
5507 vd any mode, while dragging a vertical separator line
5508 a everywhere
5509
5510 The shape is one of the following:
5511 avail name looks like ~
5512 w x arrow Normal mouse pointer
5513 w x blank no pointer at all (use with care!)
5514 w x beam I-beam
5515 w x updown up-down sizing arrows
5516 w x leftright left-right sizing arrows
5517 w x busy The system's usual busy pointer
5518 w x no The system's usual 'no input' pointer
5519 x udsizing indicates up-down resizing
5520 x lrsizing indicates left-right resizing
5521 x crosshair like a big thin +
5522 x hand1 black hand
5523 x hand2 white hand
5524 x pencil what you write with
5525 x question big ?
5526 x rightup-arrow arrow pointing right-up
5527 w x up-arrow arrow pointing up
5528 x <number> any X11 pointer number (see X11/cursorfont.h)
5529
5530 The "avail" column contains a 'w' if the shape is available for Win32,
5531 x for X11.
5532 Any modes not specified or shapes not available use the normal mouse
5533 pointer.
5534
5535 Example: >
5536 :set mouseshape=s:udsizing,m:no
5537< will make the mouse turn to a sizing arrow over the status lines and
5538 indicate no input when the hit-enter prompt is displayed (since
5539 clicking the mouse has no effect in this state.)
5540
5541 *'mousetime'* *'mouset'*
5542'mousetime' 'mouset' number (default 500)
5543 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005544 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 time in msec between two mouse clicks for the second click to be
5546 recognized as a multi click.
5547
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005548 *'mzschemedll'*
5549'mzschemedll' string (default depends on the build)
5550 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005551 {only available when compiled with the |+mzscheme/dyn|
5552 feature}
5553 Specifies the name of the MzScheme shared library. The default is
5554 DYNAMIC_MZSCH_DLL which was specified at compile time.
5555 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005556 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005557 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005558 This option cannot be set from a |modeline| or in the |sandbox|, for
5559 security reasons.
5560
5561 *'mzschemegcdll'*
5562'mzschemegcdll' string (default depends on the build)
5563 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005564 {only available when compiled with the |+mzscheme/dyn|
5565 feature}
5566 Specifies the name of the MzScheme GC shared library. The default is
5567 DYNAMIC_MZGC_DLL which was specified at compile time.
5568 The value can be equal to 'mzschemedll' if it includes the GC code.
5569 Environment variables are expanded |:set_env|.
5570 This option cannot be set from a |modeline| or in the |sandbox|, for
5571 security reasons.
5572
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005573 *'mzquantum'* *'mzq'*
5574'mzquantum' 'mzq' number (default 100)
5575 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005576 {not available when compiled without the |+mzscheme|
5577 feature}
5578 The number of milliseconds between polls for MzScheme threads.
5579 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005580 NOTE: This option is set to the Vim default value when 'compatible'
5581 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005582
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005584'nrformats' 'nf' string (default "bin,octal,hex",
5585 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 This defines what bases Vim will consider for numbers when using the
5588 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5589 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005590 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005592 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005593 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005595 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 considered to be hexadecimal. Example: Using CTRL-X on
5597 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005598 bin If included, numbers starting with "0b" or "0B" will be
5599 considered to be binary. Example: Using CTRL-X on
5600 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005601 unsigned If included, numbers are recognized as unsigned. Thus a
5602 leading dash or negative sign won't be considered as part of
5603 the number. Examples:
5604 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5605 (without "unsigned" it would become "9-2021").
5606 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5607 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005608 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5609 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 Numbers which simply begin with a digit in the range 1-9 are always
5611 considered decimal. This also happens for numbers that are not
5612 recognized as octal or hex.
5613
5614 *'number'* *'nu'* *'nonumber'* *'nonu'*
5615'number' 'nu' boolean (default off)
5616 local to window
5617 Print the line number in front of each line. When the 'n' option is
5618 excluded from 'cpoptions' a wrapped line will not use the column of
5619 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005620 The 'numberwidth' option can be used to set the room used for the line
5621 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 When a long, wrapped line doesn't start with the first character, '-'
5623 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005624 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5625 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005626 *number_relativenumber*
5627 The 'relativenumber' option changes the displayed number to be
5628 relative to the cursor. Together with 'number' there are these
5629 four combinations (cursor in line 3):
5630
Bram Moolenaar3848e002016-03-19 18:42:29 +01005631 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005632 'nornu' 'nornu' 'rnu' 'rnu'
5633
5634 |apple | 1 apple | 2 apple | 2 apple
5635 |pear | 2 pear | 1 pear | 1 pear
5636 |nobody | 3 nobody | 0 nobody |3 nobody
5637 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005639 *'numberwidth'* *'nuw'*
5640'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5641 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005642 {only available when compiled with the |+linebreak|
5643 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005644 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005645 when the 'number' or 'relativenumber' option is set or printing lines
5646 with a line number. Since one space is always between the number and
5647 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005648 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005649 fit the highest line number in the buffer respectively the number of
5650 rows in the window, depending on whether 'number' or 'relativenumber'
5651 is set. Thus with the Vim default of 4 there is room for a line number
5652 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005653 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005654 NOTE: This option is set to the Vi default value when 'compatible' is
5655 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005656
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005657 *'omnifunc'* *'ofu'*
5658'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005659 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005660 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005661 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005662 This option specifies a function to be used for Insert mode omni
5663 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005664 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005665 invoked and what it should return. The value can be the name of a
5666 function, a |lambda| or a |Funcref|. See |option-value-function| for
5667 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005668 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005669 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005670 This option cannot be set from a |modeline| or in the |sandbox|, for
5671 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005672
5673
Bram Moolenaar02467872007-05-06 13:22:01 +00005674 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005675'opendevice' 'odev' boolean (default off)
5676 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005677 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005678 Enable reading and writing from devices. This may get Vim stuck on a
5679 device that can be opened but doesn't actually do the I/O. Therefore
5680 it is off by default.
5681 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5682 result in editing a device.
5683
5684
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005685 *'operatorfunc'* *'opfunc'*
5686'operatorfunc' 'opfunc' string (default: empty)
5687 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005688 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005689 See |:map-operator| for more info and an example. The value can be
5690 the name of a function, a |lambda| or a |Funcref|. See
5691 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005692
5693 This option cannot be set from a |modeline| or in the |sandbox|, for
5694 security reasons.
5695
5696
Bram Moolenaar251e1912011-06-19 05:09:16 +02005697 *'osfiletype'* *'oft'*
5698'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005700 This option was supported on RISC OS, which has been removed.
5701
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005703 *'packpath'* *'pp'*
5704'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005705 Directories used to find packages. See |packages|.
5706
5707
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005709'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 global
5711 Specifies the nroff macros that separate paragraphs. These are pairs
5712 of two letters (see |object-motions|).
5713
5714 *'paste'* *'nopaste'*
5715'paste' boolean (default off)
5716 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005717 Put Vim in Paste mode. This is useful if you want to cut or copy
5718 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719 unexpected effects.
5720 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005721 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 knows about pasting and will mostly do the right thing without 'paste'
5723 being set. The same is true for a terminal where Vim handles the
5724 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005725 This option is reset when starting the GUI. Thus if you set it in
5726 your .vimrc it will work in a terminal, but not in the GUI. Setting
5727 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5728 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 When the 'paste' option is switched on (also when it was already on):
5730 - mapping in Insert mode and Command-line mode is disabled
5731 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005733 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005734 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 - 'revins' is reset
5736 - 'ruler' is reset
5737 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005738 - 'smarttab' is reset
5739 - 'softtabstop' is set to 0
5740 - 'textwidth' is set to 0
5741 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005742 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005745 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005746 - 'indentexpr'
5747 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005748 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 NOTE: When you start editing another file while the 'paste' option is
5750 on, settings from the modelines or autocommands may change the
5751 settings again, causing trouble when pasting text. You might want to
5752 set the 'paste' option again.
5753 When the 'paste' option is reset the mentioned options are restored to
5754 the value before the moment 'paste' was switched from off to on.
5755 Resetting 'paste' before ever setting it does not have any effect.
5756 Since mapping doesn't work while 'paste' is active, you need to use
5757 the 'pastetoggle' option to toggle the 'paste' option with some key.
5758
5759 *'pastetoggle'* *'pt'*
5760'pastetoggle' 'pt' string (default "")
5761 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 When non-empty, specifies the key sequence that toggles the 'paste'
5763 option. This is like specifying a mapping: >
5764 :map {keys} :set invpaste<CR>
5765< Where {keys} is the value of 'pastetoggle'.
5766 The difference is that it will work even when 'paste' is set.
5767 'pastetoggle' works in Insert mode and Normal mode, but not in
5768 Command-line mode.
5769 Mappings are checked first, thus overrule 'pastetoggle'. However,
5770 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5771 this: >
5772 :map <F10> :set paste<CR>
5773 :map <F11> :set nopaste<CR>
5774 :imap <F10> <C-O>:set paste<CR>
5775 :imap <F11> <nop>
5776 :set pastetoggle=<F11>
5777< This will make <F10> start paste mode and <F11> stop paste mode.
5778 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5779 mode everything is inserted literally, except the 'pastetoggle' key
5780 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005781 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782
5783 *'pex'* *'patchexpr'*
5784'patchexpr' 'pex' string (default "")
5785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 {not available when compiled without the |+diff|
5787 feature}
5788 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005789 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790
Bram Moolenaardbc28022014-07-26 13:40:44 +02005791 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792'patchmode' 'pm' string (default "")
5793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 When non-empty the oldest version of a file is kept. This can be used
5795 to keep the original version of a file if you are changing files in a
5796 source distribution. Only the first time that a file is written a
5797 copy of the original file will be kept. The name of the copy is the
5798 name of the original file with the string in the 'patchmode' option
5799 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005800 ".orig" or ".org". 'backupdir' must not be empty for this to work
5801 (Detail: The backup file is renamed to the patchmode file after the
5802 new file has been successfully written, that's why it must be possible
5803 to write a backup file). If there was no file to be backed up, an
5804 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 When the 'backupskip' pattern matches, a patchmode file is not made.
5806 Using 'patchmode' for compressed files appends the extension at the
5807 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5808 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005809 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005811 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 other systems: ".,,")
5814 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005816 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5817 provided that the file being searched for has a relative path (not
5818 starting with "/", "./" or "../"). The directories in the 'path'
5819 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 - Use commas to separate directory names: >
5821 :set path=.,/usr/local/include,/usr/include
5822< - Spaces can also be used to separate directory names (for backwards
5823 compatibility with version 3.0). To have a space in a directory
5824 name, precede it with an extra backslash, and escape the space: >
5825 :set path=.,/dir/with\\\ space
5826< - To include a comma in a directory name precede it with an extra
5827 backslash: >
5828 :set path=.,/dir/with\\,comma
5829< - To search relative to the directory of the current file, use: >
5830 :set path=.
5831< - To search in the current directory use an empty string between two
5832 commas: >
5833 :set path=,,
5834< - A directory name may end in a ':' or '/'.
5835 - Environment variables are expanded |:set_env|.
5836 - When using |netrw.vim| URLs can be used. For example, adding
5837 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005838 - Search upwards and downwards in a directory tree using "*", "**" and
5839 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840 {not available when compiled without the |+path_extra| feature}
5841 - Careful with '\' characters, type two to get one in the option: >
5842 :set path=.,c:\\include
5843< Or just use '/' instead: >
5844 :set path=.,c:/include
5845< Don't forget "." or files won't even be found in the same directory as
5846 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005847 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 it is something like 256 or 1024 characters.
5849 You can check if all the include files are found, using the value of
5850 'path', see |:checkpath|.
5851 The use of |:set+=| and |:set-=| is preferred when adding or removing
5852 directories from the list. This avoids problems when a future version
5853 uses another default. To remove the current directory use: >
5854 :set path-=
5855< To add the current directory use: >
5856 :set path+=
5857< To use an environment variable, you probably need to replace the
5858 separator. Here is an example to append $INCL, in which directory
5859 names are separated with a semi-colon: >
5860 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5861< Replace the ';' with a ':' or whatever separator is used. Note that
5862 this doesn't work when $INCL contains a comma or white space.
5863
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005864 *'perldll'*
5865'perldll' string (default depends on the build)
5866 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005867 {only available when compiled with the |+perl/dyn|
5868 feature}
5869 Specifies the name of the Perl shared library. The default is
5870 DYNAMIC_PERL_DLL, which was specified at compile time.
5871 Environment variables are expanded |:set_env|.
5872 This option cannot be set from a |modeline| or in the |sandbox|, for
5873 security reasons.
5874
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5876'preserveindent' 'pi' boolean (default off)
5877 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 When changing the indent of the current line, preserve as much of the
5879 indent structure as possible. Normally the indent is replaced by a
5880 series of tabs followed by spaces as required (unless |'expandtab'| is
5881 enabled, in which case only spaces are used). Enabling this option
5882 means the indent will preserve as many existing characters as possible
5883 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005884 'expandtab' does not apply to the preserved white space, a Tab remains
5885 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 NOTE: When using ">>" multiple times the resulting indent is a mix of
5887 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005888 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 Also see 'copyindent'.
5890 Use |:retab| to clean up white space.
5891
5892 *'previewheight'* *'pvh'*
5893'previewheight' 'pvh' number (default 12)
5894 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005895 {not available when compiled without the |+quickfix|
5896 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005898 commands. Used for |CTRL-W_}| when no count is given. Not used when
5899 'previewpopup' is set.
5900
5901 *'previewpopup'* *'pvp'*
5902'previewpopup' 'pvp' string (default empty)
5903 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005904 {not available when compiled without the |+textprop|
5905 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005906 When not empty a popup window is used for commands that would open a
5907 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005908 Not used for the insert completion info, add "popup" to
5909 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910
5911 *'previewwindow'* *'nopreviewwindow'*
5912 *'pvw'* *'nopvw'* *E590*
5913'previewwindow' 'pvw' boolean (default off)
5914 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005915 {not available when compiled without the |+quickfix|
5916 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005917 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 set. It's normally not set directly, but by using one of the commands
5919 |:ptag|, |:pedit|, etc.
5920
5921 *'printdevice'* *'pdev'*
5922'printdevice' 'pdev' string (default empty)
5923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924 {only available when compiled with the |+printer|
5925 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005926 The name of the printer to be used for |:hardcopy|.
5927 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005928 This option cannot be set from a |modeline| or in the |sandbox|, for
5929 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930
Bram Moolenaar8299df92004-07-10 09:47:34 +00005931 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005932'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 {only available when compiled with the |+printer|
5935 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005936 Sets the character encoding used when printing.
5937 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938
5939 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005940'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 {only available when compiled with the |+printer|
5943 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005944 Expression used to print the PostScript produced with |:hardcopy|.
5945 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005946 This option cannot be set from a |modeline| or in the |sandbox|, for
5947 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948
Bram Moolenaar8299df92004-07-10 09:47:34 +00005949 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950'printfont' 'pfn' string (default "courier")
5951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 {only available when compiled with the |+printer|
5953 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005954 The name of the font that will be used for |:hardcopy|.
5955 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005956
5957 *'printheader'* *'pheader'*
5958'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5959 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960 {only available when compiled with the |+printer|
5961 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005962 The format of the header produced in |:hardcopy| output.
5963 See |pheader-option|.
5964
5965 *'printmbcharset'* *'pmbcs'*
5966'printmbcharset' 'pmbcs' string (default "")
5967 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005968 {only available when compiled with the |+printer|
5969 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005970 The CJK character set to be used for CJK output from |:hardcopy|.
5971 See |pmbcs-option|.
5972
5973 *'printmbfont'* *'pmbfn'*
5974'printmbfont' 'pmbfn' string (default "")
5975 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005976 {only available when compiled with the |+printer|
5977 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005978 List of font names to be used for CJK output from |:hardcopy|.
5979 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980
5981 *'printoptions'* *'popt'*
5982'printoptions' 'popt' string (default "")
5983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005985 List of items that control the format of the output of |:hardcopy|.
5986 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005988 *'prompt'* *'noprompt'*
5989'prompt' boolean (default on)
5990 global
5991 When on a ":" prompt is used in Ex mode.
5992
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005993 *'pumheight'* *'ph'*
5994'pumheight' 'ph' number (default 0)
5995 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005996 Determines the maximum number of items to show in the popup menu for
5997 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005998 |ins-completion-menu|.
5999
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006000 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006001'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006002 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006003 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006004 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006005
Bram Moolenaard94464e2015-11-02 15:28:18 +01006006 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006007'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006008 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006009 {only available when compiled with the |+python/dyn|
6010 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006011 Specifies the name of the Python 2.x shared library. The default is
6012 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006013 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006014 This option cannot be set from a |modeline| or in the |sandbox|, for
6015 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006016
Bram Moolenaar94073162018-01-31 21:49:05 +01006017 *'pythonhome'*
6018'pythonhome' string (default "")
6019 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006020 {only available when compiled with the |+python/dyn|
6021 feature}
6022 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6023 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6024 which was specified at compile time, will be used for the Python 2.x
6025 home directory.
6026 Environment variables are expanded |:set_env|.
6027 This option cannot be set from a |modeline| or in the |sandbox|, for
6028 security reasons.
6029
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006030 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006031'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006032 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006033 {only available when compiled with the |+python3/dyn|
6034 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006035 Specifies the name of the Python 3 shared library. The default is
6036 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006037 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006038 This option cannot be set from a |modeline| or in the |sandbox|, for
6039 security reasons.
6040
Bram Moolenaar94073162018-01-31 21:49:05 +01006041 *'pythonthreehome'*
6042'pythonthreehome' string (default "")
6043 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006044 {only available when compiled with the |+python3/dyn|
6045 feature}
6046 Specifies the name of the Python 3 home directory. When
6047 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6048 PYTHON3_HOME, which was specified at compile time, will be used for
6049 the Python 3 home directory.
6050 Environment variables are expanded |:set_env|.
6051 This option cannot be set from a |modeline| or in the |sandbox|, for
6052 security reasons.
6053
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006054 *'pyxversion'* *'pyx'*
6055'pyxversion' 'pyx' number (default depends on the build)
6056 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006057 {only available when compiled with the |+python| or
6058 the |+python3| feature}
6059 Specifies the python version used for pyx* functions and commands
6060 |python_x|. The default value is as follows:
6061
6062 Compiled with Default ~
6063 |+python| and |+python3| 0
6064 only |+python| 2
6065 only |+python3| 3
6066
6067 Available values are 0, 2 and 3.
6068 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6069 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6070 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6071 to 2 if Python 2 is available.
6072 See also: |has-pythonx|
6073
6074 If Vim is compiled with only |+python| or |+python3| setting
6075 'pyxversion' has no effect. The pyx* functions and commands are
6076 always the same as the compiled version.
6077
6078 This option cannot be set from a |modeline| or in the |sandbox|, for
6079 security reasons.
6080
Bram Moolenaar858ba062020-05-31 23:11:59 +02006081 *'quickfixtextfunc'* *'qftf'*
6082'quickfixtextfunc' 'qftf' string (default "")
6083 global
6084 {only available when compiled with the |+quickfix|
6085 feature}
6086 This option specifies a function to be used to get the text to display
6087 in the quickfix and location list windows. This can be used to
6088 customize the information displayed in the quickfix or location window
6089 for each entry in the corresponding quickfix or location list. See
6090 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006091 function and an example. The value can be the name of a function, a
6092 |lambda| or a |Funcref|. See |option-value-function| for more
6093 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006094
6095 This option cannot be set from a |modeline| or in the |sandbox|, for
6096 security reasons.
6097
Bram Moolenaar677ee682005-01-27 14:41:15 +00006098 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006099'quoteescape' 'qe' string (default "\")
6100 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006101 The characters that are used to escape quotes in a string. Used for
6102 objects like a', a" and a` |a'|.
6103 When one of the characters in this option is found inside a string,
6104 the following character will be skipped. The default value makes the
6105 text "foo\"bar\\" considered to be one string.
6106
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6108'readonly' 'ro' boolean (default off)
6109 local to buffer
6110 If on, writes fail unless you use a '!'. Protects you from
6111 accidentally overwriting a file. Default on when Vim is started
6112 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006113 When using ":w!" the 'readonly' option is reset for the current
6114 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006115 When using the ":view" command the 'readonly' option is set for the
6116 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006117 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006119 *'redrawtime'* *'rdt'*
6120'redrawtime' 'rdt' number (default 2000)
6121 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006122 {only available when compiled with the |+reltime|
6123 feature}
6124 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006125 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006126 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006127 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006128 matches will be highlighted.
6129 For syntax highlighting the time applies per window. When over the
6130 limit syntax highlighting is disabled until |CTRL-L| is used.
6131 This is used to avoid that Vim hangs when using a very complicated
6132 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006133
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006134 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006135'regexpengine' 're' number (default 0)
6136 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006137 This selects the default regexp engine. |two-engines|
6138 The possible values are:
6139 0 automatic selection
6140 1 old engine
6141 2 NFA engine
6142 Note that when using the NFA engine and the pattern contains something
6143 that is not supported the pattern will not match. This is only useful
6144 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006145 Using automatic selection enables Vim to switch the engine, if the
6146 default engine becomes too costly. E.g., when the NFA engine uses too
6147 many states. This should prevent Vim from hanging on a combination of
6148 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006149
Bram Moolenaar64486672010-05-16 15:46:46 +02006150 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6151'relativenumber' 'rnu' boolean (default off)
6152 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006153 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006154 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006155 precede some vertical motion commands (e.g. j k + -) with, without
6156 having to calculate it yourself. Especially useful in combination with
6157 other commands (e.g. y d c < > gq gw =).
6158 When the 'n' option is excluded from 'cpoptions' a wrapped
6159 line will not use the column of line numbers (this is the default when
6160 'compatible' isn't set).
6161 The 'numberwidth' option can be used to set the room used for the line
6162 number.
6163 When a long, wrapped line doesn't start with the first character, '-'
6164 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006165 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6166 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006167
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006168 The number in front of the cursor line also depends on the value of
6169 'number', see |number_relativenumber| for all combinations of the two
6170 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006171
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 *'remap'* *'noremap'*
6173'remap' boolean (default on)
6174 global
6175 Allows for mappings to work recursively. If you do not want this for
6176 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006177 NOTE: To avoid portability problems with Vim scripts, always keep
6178 this option at the default "on". Only switch it off when working with
6179 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006181 *'renderoptions'* *'rop'*
6182'renderoptions' 'rop' string (default: empty)
6183 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006184 {only available when compiled with GUI and DIRECTX on
6185 MS-Windows}
6186 Select a text renderer and set its options. The options depend on the
6187 renderer.
6188
6189 Syntax: >
6190 set rop=type:{renderer}(,{name}:{value})*
6191<
6192 Currently, only one optional renderer is available.
6193
6194 render behavior ~
6195 directx Vim will draw text using DirectX (DirectWrite). It makes
6196 drawn glyphs more beautiful than default GDI.
6197 It requires 'encoding' is "utf-8", and only works on
6198 MS-Windows Vista or newer version.
6199
6200 Options:
6201 name meaning type value ~
6202 gamma gamma float 1.0 - 2.2 (maybe)
6203 contrast enhancedContrast float (unknown)
6204 level clearTypeLevel float (unknown)
6205 geom pixelGeometry int 0 - 2 (see below)
6206 renmode renderingMode int 0 - 6 (see below)
6207 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006208 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006209
Bram Moolenaar92467d32017-12-05 13:22:16 +01006210 See this URL for detail (except for scrlines):
6211 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006212
6213 For geom: structure of a device pixel.
6214 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6215 1 - DWRITE_PIXEL_GEOMETRY_RGB
6216 2 - DWRITE_PIXEL_GEOMETRY_BGR
6217
6218 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006219 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006220
6221 For renmode: method of rendering glyphs.
6222 0 - DWRITE_RENDERING_MODE_DEFAULT
6223 1 - DWRITE_RENDERING_MODE_ALIASED
6224 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6225 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6226 4 - DWRITE_RENDERING_MODE_NATURAL
6227 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6228 6 - DWRITE_RENDERING_MODE_OUTLINE
6229
6230 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006231 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006232
6233 For taamode: antialiasing mode used for drawing text.
6234 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6235 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6236 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6237 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6238
6239 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006240 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6241
Bram Moolenaara338adc2018-01-31 20:51:47 +01006242 For scrlines:
6243 This was used for optimizing scrolling behavior, however this
6244 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006245
6246 Example: >
6247 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006248 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006249 set rop=type:directx
6250<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006251 If select a raster font (Courier, Terminal or FixedSys which
6252 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006253 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006254
6255 NOTE: It is known that some fonts and options combination
6256 causes trouble on drawing glyphs.
6257
Bram Moolenaar92467d32017-12-05 13:22:16 +01006258 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006259 special made fonts (True-Type fonts which includes only
6260 bitmap glyphs).
6261 - 'taamode:3' will not work with some vector fonts.
6262
6263 NOTE: With this option, you can display colored emoji
6264 (emoticon) in Windows 8.1 or later. To display colored emoji,
6265 there are some conditions which you should notice.
6266
6267 - If your font includes non-colored emoji already, it will
6268 be used.
6269 - If your font doesn't have emoji, the system chooses an
6270 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6271 will be used.
6272 - When this alternative font didn't have fixed width glyph,
6273 emoji might be rendered beyond the bounding box of drawing
6274 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006275
6276 Other render types are currently not supported.
6277
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 *'report'*
6279'report' number (default 2)
6280 global
6281 Threshold for reporting number of lines changed. When the number of
6282 changed lines is more than 'report' a message will be given for most
6283 ":" commands. If you want it always, set 'report' to 0.
6284 For the ":substitute" command the number of substitutions is used
6285 instead of the number of lines.
6286
6287 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6288'restorescreen' 'rs' boolean (default on)
6289 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006290 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 When set, the screen contents is restored when exiting Vim. This also
6292 happens when executing external commands.
6293
6294 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6295 options in your .vimrc. To disable restoring:
6296 set t_ti= t_te=
6297 To enable restoring (for an xterm):
6298 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6299 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6300
6301 *'revins'* *'ri'* *'norevins'* *'nori'*
6302'revins' 'ri' boolean (default off)
6303 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 {only available when compiled with the |+rightleft|
6305 feature}
6306 Inserting characters in Insert mode will work backwards. See "typing
6307 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6308 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006309 NOTE: This option is reset when 'compatible' is set.
6310 This option is reset when 'paste' is set and restored when 'paste' is
6311 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312
6313 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6314'rightleft' 'rl' boolean (default off)
6315 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 {only available when compiled with the |+rightleft|
6317 feature}
6318 When on, display orientation becomes right-to-left, i.e., characters
6319 that are stored in the file appear from the right to the left.
6320 Using this option, it is possible to edit files for languages that
6321 are written from the right to the left such as Hebrew and Arabic.
6322 This option is per window, so it is possible to edit mixed files
6323 simultaneously, or to view the same file in both ways (this is
6324 useful whenever you have a mixed text file with both right-to-left
6325 and left-to-right strings so that both sets are displayed properly
6326 in different windows). Also see |rileft.txt|.
6327
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006328 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329'rightleftcmd' 'rlc' string (default "search")
6330 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 {only available when compiled with the |+rightleft|
6332 feature}
6333 Each word in this option enables the command line editing to work in
6334 right-to-left mode for a group of commands:
6335
6336 search "/" and "?" commands
6337
6338 This is useful for languages such as Hebrew, Arabic and Farsi.
6339 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6340
Bram Moolenaard94464e2015-11-02 15:28:18 +01006341 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006342'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006343 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006344 {only available when compiled with the |+ruby/dyn|
6345 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006346 Specifies the name of the Ruby shared library. The default is
6347 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006348 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006349 This option cannot be set from a |modeline| or in the |sandbox|, for
6350 security reasons.
6351
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006353'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 {not available when compiled without the
6356 |+cmdline_info| feature}
6357 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006358 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 text in the file is shown on the far right:
6360 Top first line is visible
6361 Bot last line is visible
6362 All first and last line are visible
6363 45% relative position in the file
6364 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006365 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006367 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368 this option takes precedence over 'ruler' and 'rulerformat'
6369 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006370 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 the text column (byte number) and the screen column are shown,
6372 separated with a dash.
6373 For an empty line "0-1" is shown.
6374 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006375 This option is reset when 'paste' is set and restored when 'paste' is
6376 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 If you don't want to see the ruler all the time but want to know where
6378 you are, use "g CTRL-G" |g_CTRL-G|.
6379 NOTE: This option is reset when 'compatible' is set.
6380
6381 *'rulerformat'* *'ruf'*
6382'rulerformat' 'ruf' string (default empty)
6383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 {not available when compiled without the |+statusline|
6385 feature}
6386 When this option is not empty, it determines the content of the ruler
6387 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006388 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006389 This option cannot be set in a modeline when 'modelineexpr' is off.
6390
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 The default ruler width is 17 characters. To make the ruler 15
6392 characters wide, put "%15(" at the start and "%)" at the end.
6393 Example: >
6394 :set rulerformat=%15(%c%V\ %p%%%)
6395<
6396 *'runtimepath'* *'rtp'* *vimfiles*
6397'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006398 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 $VIM/vimfiles,
6400 $VIMRUNTIME,
6401 $VIM/vimfiles/after,
6402 $HOME/.vim/after"
6403 Amiga: "home:vimfiles,
6404 $VIM/vimfiles,
6405 $VIMRUNTIME,
6406 $VIM/vimfiles/after,
6407 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006408 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 $VIM/vimfiles,
6410 $VIMRUNTIME,
6411 $VIM/vimfiles/after,
6412 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006413 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 $VIMRUNTIME,
6415 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006416 Haiku: "$BE_USER_SETTINGS/vim,
6417 $VIM/vimfiles,
6418 $VIMRUNTIME,
6419 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006420 $BE_USER_SETTINGS/vim/after"
6421 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 $VIM/vimfiles,
6423 $VIMRUNTIME,
6424 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006425 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 This is a list of directories which will be searched for runtime
6428 files:
6429 filetype.vim filetypes by file name |new-filetype|
6430 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006431 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 colors/ color scheme files |:colorscheme|
6433 compiler/ compiler files |:compiler|
6434 doc/ documentation |write-local-help|
6435 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006436 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 indent/ indent scripts |indent-expression|
6438 keymap/ key mapping files |mbyte-keymap|
6439 lang/ menu translations |:menutrans|
6440 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006441 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 plugin/ plugin scripts |write-plugin|
6443 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006444 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 syntax/ syntax files |mysyntaxfile|
6446 tutor/ files for vimtutor |tutor|
6447
6448 And any other file searched for with the |:runtime| command.
6449
6450 The defaults for most systems are setup to search five locations:
6451 1. In your home directory, for your personal preferences.
6452 2. In a system-wide Vim directory, for preferences from the system
6453 administrator.
6454 3. In $VIMRUNTIME, for files distributed with Vim.
6455 *after-directory*
6456 4. In the "after" directory in the system-wide Vim directory. This is
6457 for the system administrator to overrule or add to the distributed
6458 defaults (rarely needed)
6459 5. In the "after" directory in your home directory. This is for
6460 personal preferences to overrule or add to the distributed defaults
6461 or system-wide settings (rarely needed).
6462
Bram Moolenaard0796902016-09-16 20:02:31 +02006463 More entries are added when using |packages|. If it gets very long
6464 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6465 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006466
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6468 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006469 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 wildcards.
6471 See |:runtime|.
6472 Example: >
6473 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6474< This will use the directory "~/vimruntime" first (containing your
6475 personal Vim runtime files), then "/mygroup/vim" (shared between a
6476 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6477 files).
6478 You probably should always include $VIMRUNTIME somewhere, to use the
6479 distributed runtime files. You can put a directory before $VIMRUNTIME
6480 to find files which replace a distributed runtime files. You can put
6481 a directory after $VIMRUNTIME to find files which add to distributed
6482 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006483 When Vim is started with |--clean| the home directory entries are not
6484 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 This option cannot be set from a |modeline| or in the |sandbox|, for
6486 security reasons.
6487
6488 *'scroll'* *'scr'*
6489'scroll' 'scr' number (default: half the window height)
6490 local to window
6491 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6492 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006493 changes. This may happen when enabling the |status-line| or
6494 'tabline' option after setting the 'scroll' option.
6495 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006496 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006497 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498
6499 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6500'scrollbind' 'scb' boolean (default off)
6501 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 See also |scroll-binding|. When this option is set, the current
6503 window scrolls as other scrollbind windows (windows that also have
6504 this option set) scroll. This option is useful for viewing the
6505 differences between two versions of a file, see 'diff'.
6506 See |'scrollopt'| for options that determine how this option should be
6507 interpreted.
6508 This option is mostly reset when splitting a window to edit another
6509 file. This means that ":split | edit file" results in two windows
6510 with scroll-binding, but ":split file" does not.
6511
Bram Moolenaarae20f342019-11-05 21:09:23 +01006512 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6513'scrollfocus' 'scf' boolean (default off)
6514 global
6515 {only for MS-Windows GUI}
6516 When using the scroll wheel and this option is set, the window under
6517 the mouse pointer is scrolled. With this option off the current
6518 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006519 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006520
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 *'scrolljump'* *'sj'*
6522'scrolljump' 'sj' number (default 1)
6523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 Minimal number of lines to scroll when the cursor gets off the
6525 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6526 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006527 When set to a negative number from -1 to -100 this is used as the
6528 percentage of the window height. Thus -50 scrolls half the window
6529 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 NOTE: This option is set to 1 when 'compatible' is set.
6531
6532 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006533'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006534 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 Minimal number of screen lines to keep above and below the cursor.
6536 This will make some context visible around where you are working. If
6537 you set it to a very large value (999) the cursor line will always be
6538 in the middle of the window (except at the start or end of the file or
6539 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006540 After using the local value, go back the global value with one of
6541 these two: >
6542 setlocal scrolloff<
6543 setlocal scrolloff=-1
6544< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 NOTE: This option is set to 0 when 'compatible' is set.
6546
6547 *'scrollopt'* *'sbo'*
6548'scrollopt' 'sbo' string (default "ver,jump")
6549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006551 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6552 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 The following words are available:
6554 ver Bind vertical scrolling for 'scrollbind' windows
6555 hor Bind horizontal scrolling for 'scrollbind' windows
6556 jump Applies to the offset between two windows for vertical
6557 scrolling. This offset is the difference in the first
6558 displayed line of the bound windows. When moving
6559 around in a window, another 'scrollbind' window may
6560 reach a position before the start or after the end of
6561 the buffer. The offset is not changed though, when
6562 moving back the 'scrollbind' window will try to scroll
6563 to the desired position when possible.
6564 When now making that window the current one, two
6565 things can be done with the relative offset:
6566 1. When "jump" is not included, the relative offset is
6567 adjusted for the scroll position in the new current
6568 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006569 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 2. When "jump" is included, the other windows are
6571 scrolled to keep the same relative offset. When
6572 going back to the other window, it still uses the
6573 same relative offset.
6574 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006575 When 'diff' mode is active there always is vertical scroll binding,
6576 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577
6578 *'sections'* *'sect'*
6579'sections' 'sect' string (default "SHNHH HUnhsh")
6580 global
6581 Specifies the nroff macros that separate sections. These are pairs of
6582 two letters (See |object-motions|). The default makes a section start
6583 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6584
6585 *'secure'* *'nosecure'* *E523*
6586'secure' boolean (default off)
6587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 When on, ":autocmd", shell and write commands are not allowed in
6589 ".vimrc" and ".exrc" in the current directory and map commands are
6590 displayed. Switch it off only if you know that you will not run into
6591 problems, or when the 'exrc' option is off. On Unix this option is
6592 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006593 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 'secure' at the end of your ~/.vimrc then.
6595 This option cannot be set from a |modeline| or in the |sandbox|, for
6596 security reasons.
6597
6598 *'selection'* *'sel'*
6599'selection' 'sel' string (default "inclusive")
6600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 This option defines the behavior of the selection. It is only used
6602 in Visual and Select mode.
6603 Possible values:
6604 value past line inclusive ~
6605 old no yes
6606 inclusive yes yes
6607 exclusive yes no
6608 "past line" means that the cursor is allowed to be positioned one
6609 character past the line.
6610 "inclusive" means that the last character of the selection is included
6611 in an operation. For example, when "x" is used to delete the
6612 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006613 When "old" is used and 'virtualedit' allows the cursor to move past
6614 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 Note that when "exclusive" is used and selecting from the end
6616 backwards, you cannot include the last character of a line, when
6617 starting in Normal mode and 'virtualedit' empty.
6618
6619 The 'selection' option is set by the |:behave| command.
6620
6621 *'selectmode'* *'slm'*
6622'selectmode' 'slm' string (default "")
6623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 This is a comma separated list of words, which specifies when to start
6625 Select mode instead of Visual mode, when a selection is started.
6626 Possible values:
6627 mouse when using the mouse
6628 key when using shifted special keys
6629 cmd when using "v", "V" or CTRL-V
6630 See |Select-mode|.
6631 The 'selectmode' option is set by the |:behave| command.
6632
6633 *'sessionoptions'* *'ssop'*
6634'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006635 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006637 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 feature}
6639 Changes the effect of the |:mksession| command. It is a comma
6640 separated list of words. Each word enables saving and restoring
6641 something:
6642 word save and restore ~
6643 blank empty windows
6644 buffers hidden and unloaded buffers, not just those in windows
6645 curdir the current directory
6646 folds manually created folds, opened/closed folds and local
6647 fold options
6648 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006649 and contain at least one lowercase letter. Only
6650 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 help the help window
6652 localoptions options and mappings local to a window or buffer (not
6653 global values for local options)
6654 options all options and mappings (also global values for local
6655 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006656 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 resize size of the Vim window: 'lines' and 'columns'
6658 sesdir the directory in which the session file is located
6659 will become the current directory (useful with
6660 projects accessed over a network from different
6661 systems)
6662 slash backslashes in file names replaced with forward
6663 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006664 tabpages all tab pages; without this only the current tab page
6665 is restored, so that you can make a session for each
6666 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006667 terminal include terminal windows where the command can be
6668 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 unix with Unix end-of-line format (single <NL>), even when
6670 on Windows or DOS
6671 winpos position of the whole Vim window
6672 winsize window sizes
6673
6674 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006675 When neither "curdir" nor "sesdir" is included, file names are stored
6676 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 "slash" and "unix" are useful on Windows when sharing session files
6678 with Unix. The Unix version of Vim cannot source dos format scripts,
6679 but the Windows version of Vim can source unix format scripts.
6680
6681 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006682'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 global
6684 Name of the shell to use for ! and :! commands. When changing the
6685 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6686 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006687 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 See |option-backslash| about including spaces and backslashes.
6689 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006690
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006691 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006692 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6694< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006695 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006697 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006699 Example with escaped space (Vim will do this when initializing the
6700 option from $SHELL): >
6701 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006702< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006703 backslashes are consumed by `:set`.
6704
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 Under MS-Windows, when the executable ends in ".com" it must be
6706 included. Thus setting the shell to "command.com" or "4dos.com"
6707 works, but "command" and "4dos" do not work for all commands (e.g.,
6708 filtering).
6709 For unknown reasons, when using "4dos.com" the current directory is
6710 changed to "C:\". To avoid this set 'shell' like this: >
6711 :set shell=command.com\ /c\ 4dos
6712< This option cannot be set from a |modeline| or in the |sandbox|, for
6713 security reasons.
6714
6715 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006716'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006717 Win32, when 'shell' contains "powershell":
6718 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006719 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006722 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6723 For MS-Windows, the default is set according to the value of 'shell',
6724 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006725 On Unix it can have more than one flag. Each white space separated
6726 part is passed as an argument to the shell command.
6727 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006728 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 This option cannot be set from a |modeline| or in the |sandbox|, for
6730 security reasons.
6731
6732 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006733'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6734 "2>&1| tee", or
6735 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 {not available when compiled without the |+quickfix|
6738 feature}
6739 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006740 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 including spaces and backslashes.
6742 The name of the temporary file can be represented by "%s" if necessary
6743 (the file name is appended automatically if no %s appears in the value
6744 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006745 For the Amiga the default is ">". For MS-Windows using powershell the
6746 default is "2>&1 | Out-File -Encoding default", otherwise the default
6747 is ">%s 2>&1". The output is directly saved in a file and not echoed
6748 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006749 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 in a file and echoed to the screen. If the 'shell' option is "csh" or
6751 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006752 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006753 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6754 means that stderr is also included. Before using the 'shell' option a
6755 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006756 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6757 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 The initialization of this option is done after reading the ".vimrc"
6759 and the other initializations, so that when the 'shell' option is set
6760 there, the 'shellpipe' option changes automatically, unless it was
6761 explicitly set before.
6762 When 'shellpipe' is set to an empty string, no redirection of the
6763 ":make" output will be done. This is useful if you use a 'makeprg'
6764 that writes to 'makeef' by itself. If you want no piping, but do
6765 want to include the 'makeef', set 'shellpipe' to a single space.
6766 Don't forget to precede the space with a backslash: ":set sp=\ ".
6767 In the future pipes may be used for filtering and this option will
6768 become obsolete (at least for Unix).
6769 This option cannot be set from a |modeline| or in the |sandbox|, for
6770 security reasons.
6771
6772 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006773'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006775 Quoting character(s), put around the command passed to the shell, for
6776 the "!" and ":!" commands. The redirection is kept outside of the
6777 quoting. See 'shellxquote' to include the redirection. It's
6778 probably not useful to set both options.
6779 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006780 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006781 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 This option cannot be set from a |modeline| or in the |sandbox|, for
6783 security reasons.
6784
6785 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006786'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6787 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 String to be used to put the output of a filter command in a temporary
6790 file. See also |:!|. See |option-backslash| about including spaces
6791 and backslashes.
6792 The name of the temporary file can be represented by "%s" if necessary
6793 (the file name is appended automatically if no %s appears in the value
6794 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006795 The default is ">". For Unix, if the 'shell' option is "csh" or
6796 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006797 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006798 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6799 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006800 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6801 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006802 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6803 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 The initialization of this option is done after reading the ".vimrc"
6805 and the other initializations, so that when the 'shell' option is set
6806 there, the 'shellredir' option changes automatically unless it was
6807 explicitly set before.
6808 In the future pipes may be used for filtering and this option will
6809 become obsolete (at least for Unix).
6810 This option cannot be set from a |modeline| or in the |sandbox|, for
6811 security reasons.
6812
6813 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6814'shellslash' 'ssl' boolean (default off)
6815 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006816 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006818 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006819 powershell.exe. Backward slashes can still be typed, but they are
6820 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 Note that setting or resetting this option has no effect for some
6822 existing file names, thus this option needs to be set before opening
6823 any file for best results. This might change in the future.
6824 'shellslash' only works when a backslash can be used as a path
6825 separator. To test if this is so use: >
6826 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006827< Also see 'completeslash'.
6828
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006829 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6830'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6831 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006832 When on, use temp files for shell commands. When off use a pipe.
6833 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006834 Currently a pipe is only supported on Unix and MS-Windows 2K and
6835 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006836 :if has("filterpipe")
6837< The advantage of using a pipe is that nobody can read the temp file
6838 and the 'shell' command does not need to support redirection.
6839 The advantage of using a temp file is that the file type and encoding
6840 can be detected.
6841 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6842 |FilterWritePost| autocommands event are not triggered when
6843 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006844 The `system()` function does not respect this option and always uses
6845 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006846 NOTE: This option is set to the Vim default value when 'compatible'
6847 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006848
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 *'shelltype'* *'st'*
6850'shelltype' 'st' number (default 0)
6851 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006852 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 On the Amiga this option influences the way how the commands work
6854 which use a shell.
6855 0 and 1: always use the shell
6856 2 and 3: use the shell only to filter lines
6857 4 and 5: use shell only for ':sh' command
6858 When not using the shell, the command is executed directly.
6859
6860 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6861 1 and 3: use "shell cmd" to start external commands
6862
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006863 *'shellxescape'* *'sxe'*
6864'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006865 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006866 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006867 When 'shellxquote' is set to "(" then the characters listed in this
6868 option will be escaped with a '^' character. This makes it possible
6869 to execute most external commands with cmd.exe.
6870
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 *'shellxquote'* *'sxq'*
6872'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006873 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006874 for Win32, when 'shell' is
6875 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006876 for Win32, when 'shell' contains "sh"
6877 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 for Unix, when using system(): "\"")
6879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 Quoting character(s), put around the command passed to the shell, for
6881 the "!" and ":!" commands. Includes the redirection. See
6882 'shellquote' to exclude the redirection. It's probably not useful
6883 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006884 When the value is '(' then ')' is appended. When the value is '"('
6885 then ')"' is appended.
6886 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006887 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006888 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6889 pwsh.exe which automatically strips off the first and last quote on a
6890 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6891 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006892 'shell', to reduce the need to set this option by the user. See
6893 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 This option cannot be set from a |modeline| or in the |sandbox|, for
6895 security reasons.
6896
6897 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6898'shiftround' 'sr' boolean (default off)
6899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 Round indent to multiple of 'shiftwidth'. Applies to > and <
6901 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6902 a multiple of 'shiftwidth' (this is Vi compatible).
6903 NOTE: This option is reset when 'compatible' is set.
6904
6905 *'shiftwidth'* *'sw'*
6906'shiftwidth' 'sw' number (default 8)
6907 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006908 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006910 When zero the 'ts' value will be used. Use the |shiftwidth()|
6911 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912
6913 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006914'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6915 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 This option helps to avoid all the |hit-enter| prompts caused by file
6918 messages, for example with CTRL-G, and to avoid some other messages.
6919 It is a list of flags:
6920 flag meaning when present ~
6921 f use "(3 of 5)" instead of "(file 3 of 5)"
6922 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006923 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 m use "[+]" instead of "[Modified]"
6925 n use "[New]" instead of "[New File]"
6926 r use "[RO]" instead of "[readonly]"
6927 w use "[w]" instead of "written" for file write message
6928 and "[a]" instead of "appended" for ':w >> file' command
6929 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6930 "[unix format]" and "[mac]" instead of "[mac format]".
6931 a all of the above abbreviations
6932
6933 o overwrite message for writing a file with subsequent message
6934 for reading a file (useful for ":wn" or when 'autowrite' on)
6935 O message for reading a file overwrites any previous message.
6936 Also for quickfix message (e.g., ":cn").
6937 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006938 hit TOP, continuing at BOTTOM" messages; when using the search
6939 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 t truncate file message at the start if it is too long to fit
6941 on the command-line, "<" will appear in the left most column.
6942 Ignored in Ex mode.
6943 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006944 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 Ignored in Ex mode.
6946 W don't give "written" or "[w]" when writing a file
6947 A don't give the "ATTENTION" message when an existing swap file
6948 is found.
6949 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006950 c don't give |ins-completion-menu| messages. For example,
6951 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6952 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006953 q use "recording" instead of "recording @a"
6954 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006955 was used for the command; note that this also affects messages
6956 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006957 S do not show search count message when searching, e.g.
6958 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959
6960 This gives you the opportunity to avoid that a change between buffers
6961 requires you to hit <Enter>, but still gives as useful a message as
6962 possible for the space available. To get the whole message that you
6963 would have got with 'shm' empty, use ":file!"
6964 Useful values:
6965 shm= No abbreviation of message.
6966 shm=a Abbreviation, but no loss of information.
6967 shm=at Abbreviation, and truncate message when necessary.
6968
6969 NOTE: This option is set to the Vi default value when 'compatible' is
6970 set and to the Vim default value when 'compatible' is reset.
6971
6972 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6973'shortname' 'sn' boolean (default off)
6974 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 Filenames are assumed to be 8 characters plus one extension of 3
6976 characters. Multiple dots in file names are not allowed. When this
6977 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006978 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006980 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981
6982 *'showbreak'* *'sbr'* *E595*
6983'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006984 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006985 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 feature}
6987 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006988 values are "> " or "+++ ": >
6989 :set showbreak=>\
6990< Note the backslash to escape the trailing space. It's easier like
6991 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006992 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006993< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994 comma (in a future version the comma might be used to separate the
6995 part that is shown at the end and at the start of a line).
6996 The characters are highlighted according to the '@' flag in
6997 'highlight'.
6998 Note that tabs after the showbreak will be displayed differently.
6999 If you want the 'showbreak' to appear in between line numbers, add the
7000 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007001 A window-local value overrules a global value. If the global value is
7002 set and you want no value in the current window use NONE: >
7003 :setlocal showbreak=NONE
7004<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007006'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7007 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 {not available when compiled without the
7010 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007011 Show (partial) command in the last line of the screen. Set this
7012 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 In Visual mode the size of the selected area is shown:
7014 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007015 If the number of bytes is different it is also displayed: "2-6"
7016 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007018 - When selecting a block, the size in screen characters:
7019 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 NOTE: This option is set to the Vi default value when 'compatible' is
7021 set and to the Vim default value when 'compatible' is reset.
7022
7023 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7024'showfulltag' 'sft' boolean (default off)
7025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 When completing a word in insert mode (see |ins-completion|) from the
7027 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007028 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 matched a C function, you can see a template for what arguments are
7030 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007031 Note that this doesn't work well together with having "longest" in
7032 'completeopt', because the completion from the search pattern may not
7033 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034
7035 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7036'showmatch' 'sm' boolean (default off)
7037 global
7038 When a bracket is inserted, briefly jump to the matching one. The
7039 jump is only done if the match can be seen on the screen. The time to
7040 show the match can be set with 'matchtime'.
7041 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007042 seen or not).
7043 This option is reset when 'paste' is set and restored when 'paste' is
7044 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 When the 'm' flag is not included in 'cpoptions', typing a character
7046 will immediately move the cursor back to where it belongs.
7047 See the "sm" field in 'guicursor' for setting the cursor shape and
7048 blinking when showing the match.
7049 The 'matchpairs' option can be used to specify the characters to show
7050 matches for. 'rightleft' and 'revins' are used to look for opposite
7051 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007052 Also see the matchparen plugin for highlighting the match when moving
7053 around |pi_paren.txt|.
7054 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055
7056 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7057'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7058 global
7059 If in Insert, Replace or Visual mode put a message on the last line.
7060 Use the 'M' flag in 'highlight' to set the type of highlighting for
7061 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007062 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 doesn't mean XIM is really active, especially when 'imactivatekey' is
7064 not set.
7065 NOTE: This option is set to the Vi default value when 'compatible' is
7066 set and to the Vim default value when 'compatible' is reset.
7067
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007068 *'showtabline'* *'stal'*
7069'showtabline' 'stal' number (default 1)
7070 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007071 The value of this option specifies when the line with tab page labels
7072 will be displayed:
7073 0: never
7074 1: only if there are at least two tab pages
7075 2: always
7076 This is both for the GUI and non-GUI implementation of the tab pages
7077 line.
7078 See |tab-page| for more information about tab pages.
7079
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 *'sidescroll'* *'ss'*
7081'sidescroll' 'ss' number (default 0)
7082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007083 The minimal number of columns to scroll horizontally. Used only when
7084 the 'wrap' option is off and the cursor is moved off of the screen.
7085 When it is zero the cursor will be put in the middle of the screen.
7086 When using a slow terminal set it to a large number or 0. When using
7087 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7088 commands.
7089
7090 *'sidescrolloff'* *'siso'*
7091'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007092 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007094 right of the cursor if 'nowrap' is set. Setting this option to a
7095 value greater than 0 while having |'sidescroll'| also at a non-zero
7096 value makes some context visible in the line you are scrolling in
7097 horizontally (except at beginning of the line). Setting this option
7098 to a large value (like 999) has the effect of keeping the cursor
7099 horizontally centered in the window, as long as one does not come too
7100 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007101 After using the local value, go back the global value with one of
7102 these two: >
7103 setlocal sidescrolloff<
7104 setlocal sidescrolloff=-1
7105< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106
7107 Example: Try this together with 'sidescroll' and 'listchars' as
7108 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007109 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110
7111 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7112 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007113<
7114 *'signcolumn'* *'scl'*
7115'signcolumn' 'scl' string (default "auto")
7116 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007117 {not available when compiled without the |+signs|
7118 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007119 Whether or not to draw the signcolumn. Valid values are:
7120 "auto" only when there is a sign to display
7121 "no" never
7122 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007123 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007124 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125
7126
7127 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7128'smartcase' 'scs' boolean (default off)
7129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 Override the 'ignorecase' option if the search pattern contains upper
7131 case characters. Only used when the search pattern is typed and
7132 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007133 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7135 recalling the search pattern from history and hitting <Enter>.
7136 NOTE: This option is reset when 'compatible' is set.
7137
7138 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7139'smartindent' 'si' boolean (default off)
7140 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 {not available when compiled without the
7142 |+smartindent| feature}
7143 Do smart autoindenting when starting a new line. Works for C-like
7144 programs, but can also be used for other languages. 'cindent' does
7145 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007146 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007147 setting 'si' has no effect. 'indentexpr' is a more advanced
7148 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 Normally 'autoindent' should also be on when using 'smartindent'.
7150 An indent is automatically inserted:
7151 - After a line ending in '{'.
7152 - After a line starting with a keyword from 'cinwords'.
7153 - Before a line starting with '}' (only with the "O" command).
7154 When typing '}' as the first character in a new line, that line is
7155 given the same indent as the matching '{'.
7156 When typing '#' as the first character in a new line, the indent for
7157 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007158 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7160 When using the ">>" command, lines starting with '#' are not shifted
7161 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007162 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007163 This option is reset when 'paste' is set and restored when 'paste' is
7164 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165
7166 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7167'smarttab' 'sta' boolean (default off)
7168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007170 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7171 <BS> will delete a 'shiftwidth' worth of space at the start of the
7172 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007173 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007174 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7175 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007176 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007178 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007179 This option is reset when 'paste' is set and restored when 'paste' is
7180 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 NOTE: This option is reset when 'compatible' is set.
7182
7183 *'softtabstop'* *'sts'*
7184'softtabstop' 'sts' number (default 0)
7185 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 Number of spaces that a <Tab> counts for while performing editing
7187 operations, like inserting a <Tab> or using <BS>. It "feels" like
7188 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7189 used. This is useful to keep the 'ts' setting at its standard value
7190 of 8, while being able to edit like it is set to 'sts'. However,
7191 commands like "x" still work on the actual characters.
7192 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007193 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007194 'softtabstop' is set to 0 when the 'paste' option is set and restored
7195 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7197 spaces is minimized by using <Tab>s.
7198 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7199 set.
7200 NOTE: This option is set to 0 when 'compatible' is set.
7201
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007202 If Vim is compiled with the |+vartabs| feature then the value of
7203 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7204 anything other than an empty string.
7205
Bram Moolenaar217ad922005-03-20 22:37:15 +00007206 *'spell'* *'nospell'*
7207'spell' boolean (default off)
7208 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007209 {not available when compiled without the |+syntax|
7210 feature}
7211 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007212 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007213
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007214 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007215'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007216 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007217 {not available when compiled without the |+syntax|
7218 feature}
7219 Pattern to locate the end of a sentence. The following word will be
7220 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007221 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007222 When this check is not wanted make this option empty.
7223 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007224 Be careful with special characters, see |option-backslash| about
7225 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007226 To set this option automatically depending on the language, see
7227 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007228
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007229 *'spellfile'* *'spf'*
7230'spellfile' 'spf' string (default empty)
7231 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007232 {not available when compiled without the |+syntax|
7233 feature}
7234 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007235 commands. It must end in ".{encoding}.add". You need to include the
7236 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007237 *E765*
7238 It may also be a comma separated list of names. A count before the
7239 |zg| and |zw| commands can be used to access each. This allows using
7240 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007241 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007242 you: Using the first directory in 'runtimepath' that is writable. If
7243 there is no "spell" directory yet it will be created. For the file
7244 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007245 ignoring the region.
7246 The resulting ".spl" file will be used for spell checking, it does not
7247 have to appear in 'spelllang'.
7248 Normally one file is used for all regions, but you can add the region
7249 name if you want to. However, it will then only be used when
7250 'spellfile' is set to it, for entries in 'spelllang' only files
7251 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007252 This option cannot be set from a |modeline| or in the |sandbox|, for
7253 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007254
Bram Moolenaar217ad922005-03-20 22:37:15 +00007255 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007256'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007257 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007258 {not available when compiled without the |+syntax|
7259 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007260 A comma separated list of word list names. When the 'spell' option is
7261 on spellchecking will be done for these languages. Example: >
7262 set spelllang=en_us,nl,medical
7263< This means US English, Dutch and medical words are recognized. Words
7264 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007265 The word list name must consist of alphanumeric characters, a dash or
7266 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007267 recommended to separate the two letter language name from a
7268 specification. Thus "en-rare" is used for rare English words.
7269 A region name must come last and have the form "_xx", where "xx" is
7270 the two-letter, lower case region name. You can use more than one
7271 region by listing them: "en_us,en_ca" supports both US and Canadian
7272 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007273 Britain. (Note: currently en_au and en_nz dictionaries are older than
7274 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007275 If the name "cjk" is included East Asian characters are excluded from
7276 spell checking. This is useful when editing text that also has Asian
7277 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007278 Note that the "medical" dictionary does not exist, it is just an
7279 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007280 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007281 As a special case the name of a .spl file can be given as-is. The
7282 first "_xx" in the name is removed and used as the region name
7283 (_xx is an underscore, two letters and followed by a non-letter).
7284 This is mainly for testing purposes. You must make sure the correct
7285 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007286 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007287 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7288 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007289 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007290
Bram Moolenaar98692072006-02-04 00:57:42 +00007291 If the |spellfile.vim| plugin is active and you use a language name
7292 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7293 will ask you if you want to download the file.
7294
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007295 After this option has been set successfully, Vim will source the files
7296 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007297 up to the first character that is not an ASCII letter or number and
7298 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007299
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007300 *'spelloptions'* *'spo'*
7301'spelloptions' 'spo' string (default "")
7302 local to buffer
7303 {not available when compiled without the |+syntax|
7304 feature}
7305 A comma separated list of options for spell checking:
7306 camel When a word is CamelCased, assume "Cased" is a
7307 separate word: every upper-case character in a word
7308 that comes after a lower case character indicates the
7309 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007310
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007311 *'spellsuggest'* *'sps'*
7312'spellsuggest' 'sps' string (default "best")
7313 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007314 {not available when compiled without the |+syntax|
7315 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007316 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007317 the |spellsuggest()| function. This is a comma-separated list of
7318 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007319
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007320 best Internal method that works best for English. Finds
7321 changes like "fast" and uses a bit of sound-a-like
7322 scoring to improve the ordering.
7323
7324 double Internal method that uses two methods and mixes the
7325 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007326 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007327 word. That only works when the language specifies
7328 sound folding. Can be slow and doesn't always give
7329 better results.
7330
7331 fast Internal method that only checks for simple changes:
7332 character inserts/deletes/swaps. Works well for
7333 simple typing mistakes.
7334
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007335 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007336 Not used for |spellsuggest()|. The number of
7337 suggestions is never more than the value of 'lines'
7338 minus two.
7339
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007340 file:{filename} Read file {filename}, which must have two columns,
7341 separated by a slash. The first column contains the
7342 bad word, the second column the suggested good word.
7343 Example:
7344 theribal/terrible ~
7345 Use this for common mistakes that do not appear at the
7346 top of the suggestion list with the internal methods.
7347 Lines without a slash are ignored, use this for
7348 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007349 The word in the second column must be correct,
7350 otherwise it will not be used. Add the word to an
7351 ".add" file if it is currently flagged as a spelling
7352 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007353 The file is used for all languages.
7354
7355 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7356 trouble with spaces. |v:val| holds the badly spelled
7357 word. The expression must evaluate to a List of
7358 Lists, each with a suggestion and a score.
7359 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007360 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007361 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007362 internal methods use. A lower score is better.
7363 This may invoke |spellsuggest()| if you temporarily
7364 set 'spellsuggest' to exclude the "expr:" part.
7365 Errors are silently ignored, unless you set the
7366 'verbose' option to a non-zero value.
7367
7368 Only one of "best", "double" or "fast" may be used. The others may
7369 appear several times in any order. Example: >
7370 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7371<
7372 This option cannot be set from a |modeline| or in the |sandbox|, for
7373 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007374
7375
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7377'splitbelow' 'sb' boolean (default off)
7378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 When on, splitting a window will put the new window below the current
7380 one. |:split|
7381
7382 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7383'splitright' 'spr' boolean (default off)
7384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 When on, splitting a window will put the new window right of the
7386 current one. |:vsplit|
7387
7388 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7389'startofline' 'sol' boolean (default on)
7390 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007392 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007393 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007394 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 with a linewise operator, with "%" with a count and to buffer changing
7396 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7397 only has a line number, e.g., ":25" or ":+".
7398 In case of buffer changing commands the cursor is placed at the column
7399 where it was the last time the buffer was edited.
7400 NOTE: This option is set when 'compatible' is set.
7401
Bram Moolenaar00654022011-02-25 14:42:19 +01007402 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007404 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 {not available when compiled without the |+statusline|
7406 feature}
7407 When nonempty, this option determines the content of the status line.
7408 Also see |status-line|.
7409
7410 The option consists of printf style '%' items interspersed with
7411 normal text. Each status line item is of the form:
7412 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007413 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007414 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415
Bram Moolenaar238a5642006-02-21 22:12:05 +00007416 When the option starts with "%!" then it is used as an expression,
7417 evaluated and the result is used as the option value. Example: >
7418 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007419< The *g:statusline_winid* variable will be set to the |window-ID| of the
7420 window that the status line belongs to.
7421 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007422 Note that the "%!" expression is evaluated in the context of the
7423 current window and buffer, while %{} items are evaluated in the
7424 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007425
7426 When there is error while evaluating the option then it will be made
7427 empty to avoid further errors. Otherwise screen updating would loop.
7428
Bram Moolenaar071d4272004-06-13 20:20:40 +00007429 Note that the only effect of 'ruler' when this option is set (and
7430 'laststatus' is 2) is controlling the output of |CTRL-G|.
7431
7432 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007433 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007435 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 minwid Minimum width of the item, padding as set by '-' & '0'.
7437 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007438 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 on the left for text items. Numeric items will be
7440 shifted down to maxwid-2 digits followed by '>'number
7441 where number is the amount of missing digits, much like
7442 an exponential notation.
7443 item A one letter code as described below.
7444
7445 Following is a description of the possible statusline items. The
7446 second character in "item" is the type:
7447 N for number
7448 S for string
7449 F for flags as described below
7450 - not applicable
7451
7452 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007453 f S Path to the file in the buffer, as typed or relative to current
7454 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 F S Full path to the file in the buffer.
7456 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007457 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007459 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007461 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007463 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007465 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007467 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7469 being used: "<keymap>"
7470 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007471 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 B N As above, in hexadecimal.
7473 o N Byte number in file of byte under cursor, first byte is 1.
7474 Mnemonic: Offset from start of file (with one added)
7475 {not available when compiled without |+byte_offset| feature}
7476 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007477 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 l N Line number.
7479 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007480 c N Column number (byte index).
7481 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007482 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483 p N Percentage through file in lines as in |CTRL-G|.
7484 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007485 percentage described for 'ruler'. Always 3 in length, unless
7486 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007487 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007489 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007490 Note that there is no '%' before the closing '}'. The
7491 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007492 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007493 {% - This is almost same as { except the result of the expression is
7494 re-evaluated as a statusline format string. Thus if the
7495 return value of expr contains % items they will get expanded.
7496 The expression can contain the } character, the end of
7497 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007498 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007499 func! Stl_filename() abort
7500 return "%t"
7501 endfunc
7502< `stl=%{Stl_filename()}` results in `"%t"`
7503 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007504 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 ( - Start of item group. Can be used for setting the width and
7506 alignment of a section. Must be followed by %) somewhere.
7507 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007508 T N For 'tabline': start of tab page N label. Use %T after the last
7509 label. This information is used for mouse clicks.
7510 X N For 'tabline': start of close tab N label. Use %X after the
7511 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7512 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 < - Where to truncate line if too long. Default is at the start.
7514 No width fields allowed.
7515 = - Separation point between left and right aligned items.
7516 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007517 # - Set highlight group. The name must follow and then a # again.
7518 Thus use %#HLname# for highlight group HLname. The same
7519 highlighting is used, also for the statusline of non-current
7520 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007522 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 The difference between User{N} and StatusLine will be applied
7524 to StatusLineNC for the statusline of non-current windows.
7525 The number N must be between 1 and 9. See |hl-User1..9|
7526
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007527 When displaying a flag, Vim removes the leading comma, if any, when
7528 that flag comes right after plaintext. This will make a nice display
7529 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530
Bram Moolenaar582fd852005-03-28 20:58:01 +00007531 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 not set) and a minwid is not set for the group, the whole group will
7533 become empty. This will make a group like the following disappear
7534 completely from the statusline when none of the flags are set. >
7535 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007536< Beware that an expression is evaluated each and every time the status
7537 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007538 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007539 While evaluating %{} the current buffer and current window will be set
7540 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007541 currently being drawn. The expression will evaluate in this context.
7542 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7543 real current buffer and "g:actual_curwin" to the |window-ID| of the
7544 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007545
Bram Moolenaar30b65812012-07-12 22:01:11 +02007546 The 'statusline' option will be evaluated in the |sandbox| if set from
7547 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007548 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007549
7550 It is not allowed to change text or jump to another window while
7551 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552
7553 If the statusline is not updated when you want it (e.g., after setting
7554 a variable that's used in an expression), you can force an update by
7555 setting an option without changing its value. Example: >
7556 :let &ro = &ro
7557
7558< A result of all digits is regarded a number for display purposes.
7559 Otherwise the result is taken as flag text and applied to the rules
7560 described above.
7561
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007562 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007564 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565
7566 Examples:
7567 Emulate standard status line with 'ruler' set >
7568 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7569< Similar, but add ASCII value of char under the cursor (like "ga") >
7570 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7571< Display byte count and byte value, modified flag in red. >
7572 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7573 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7574< Display a ,GZ flag if a compressed file is loaded >
7575 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7576< In the |:autocmd|'s: >
7577 :let b:gzflag = 1
7578< And: >
7579 :unlet b:gzflag
7580< And define this function: >
7581 :function VarExists(var, val)
7582 : if exists(a:var) | return a:val | else | return '' | endif
7583 :endfunction
7584<
7585 *'suffixes'* *'su'*
7586'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 Files with these suffixes get a lower priority when multiple files
7589 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007590 suffixes. Spaces after the comma are ignored. A dot is also seen as
7591 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 separator, precede it with a backslash (see |option-backslash| about
7593 including spaces and backslashes).
7594 See 'wildignore' for completely ignoring files.
7595 The use of |:set+=| and |:set-=| is preferred when adding or removing
7596 suffixes from the list. This avoids problems when a future version
7597 uses another default.
7598
7599 *'suffixesadd'* *'sua'*
7600'suffixesadd' 'sua' string (default "")
7601 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 {not available when compiled without the
7603 |+file_in_path| feature}
7604 Comma separated list of suffixes, which are used when searching for a
7605 file for the "gf", "[I", etc. commands. Example: >
7606 :set suffixesadd=.java
7607<
7608 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7609'swapfile' 'swf' boolean (default on)
7610 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007611 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 swapfile is not wanted for a specific buffer. For example, with
7613 confidential information that even root must not be able to access.
7614 Careful: All text will be in memory:
7615 - Don't use this for big files.
7616 - Recovery will be impossible!
7617 A swapfile will only be present when |'updatecount'| is non-zero and
7618 'swapfile' is set.
7619 When 'swapfile' is reset, the swap file for the current buffer is
7620 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7621 non-zero, a swap file is immediately created.
7622 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007623 If you want to open a new buffer without creating a swap file for it,
7624 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007625 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626
7627 This option is used together with 'bufhidden' and 'buftype' to
7628 specify special kinds of buffers. See |special-buffers|.
7629
7630 *'swapsync'* *'sws'*
7631'swapsync' 'sws' string (default "fsync")
7632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007634 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 When this option is empty parts of the swap file may be in memory and
7636 not written to disk. When the system crashes you may lose more work.
7637 On Unix the system does a sync now and then without Vim asking for it,
7638 so the disadvantage of setting this option off is small. On some
7639 systems the swap file will not be written at all. For a unix system
7640 setting it to "sync" will use the sync() call instead of the default
7641 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007642 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643
7644 *'switchbuf'* *'swb'*
7645'switchbuf' 'swb' string (default "")
7646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007648 Mostly for |quickfix| commands some values are also used for other
7649 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 Possible values (comma separated list):
7651 useopen If included, jump to the first open window that
7652 contains the specified buffer (if there is one).
7653 Otherwise: Do not examine other windows.
7654 This setting is checked with |quickfix| commands, when
7655 jumping to errors (":cc", ":cn", "cp", etc.). It is
7656 also used in all buffer related split commands, for
7657 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007658 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007659 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007661 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007662 Otherwise: do not split, use current window (when used
7663 in the quickfix window: the previously used window or
7664 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007665 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007666 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007667 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007668 uselast If included, jump to the previously used window when
7669 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007671 *'synmaxcol'* *'smc'*
7672'synmaxcol' 'smc' number (default 3000)
7673 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007674 {not available when compiled without the |+syntax|
7675 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007676 Maximum column in which to search for syntax items. In long lines the
7677 text after this column is not highlighted and following lines may not
7678 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007679 This helps to avoid very slow redrawing for an XML file that is one
7680 long line.
7681 Set to zero to remove the limit.
7682
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 *'syntax'* *'syn'*
7684'syntax' 'syn' string (default empty)
7685 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 {not available when compiled without the |+syntax|
7687 feature}
7688 When this option is set, the syntax with this name is loaded, unless
7689 syntax highlighting has been switched off with ":syntax off".
7690 Otherwise this option does not always reflect the current syntax (the
7691 b:current_syntax variable does).
7692 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007693 not automatically recognized. Example, in an IDL file:
7694 /* vim: set syntax=idl : */ ~
7695 When a dot appears in the value then this separates two filetype
7696 names. Example:
7697 /* vim: set syntax=c.doxygen : */ ~
7698 This will use the "c" syntax first, then the "doxygen" syntax.
7699 Note that the second one must be prepared to be loaded as an addition,
7700 otherwise it will be skipped. More than one dot may appear.
7701 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702 :set syntax=OFF
7703< To switch syntax highlighting on according to the current value of the
7704 'filetype' option: >
7705 :set syntax=ON
7706< What actually happens when setting the 'syntax' option is that the
7707 Syntax autocommand event is triggered with the value as argument.
7708 This option is not copied to another buffer, independent of the 's' or
7709 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007710 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007712 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007713'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007714 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007715 When nonempty, this option determines the content of the tab pages
7716 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007717 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007718
7719 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007720 option and only when there is no GUI tab line. When 'e' is in
7721 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007722 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007723
7724 The value is evaluated like with 'statusline'. You can use
7725 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007726 the text to be displayed. Use "%1T" for the first label, "%2T" for
7727 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007728
Bram Moolenaare12bab32019-01-08 22:02:56 +01007729 When changing something that is used in 'tabline' that does not
7730 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007731 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007732
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007733 Keep in mind that only one of the tab pages is the current one, others
7734 are invisible and you can't jump to their windows.
7735
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007736
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007737 *'tabpagemax'* *'tpm'*
7738'tabpagemax' 'tpm' number (default 10)
7739 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007740 Maximum number of tab pages to be opened by the |-p| command line
7741 argument or the ":tab all" command. |tabpage|
7742
7743
7744 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745'tabstop' 'ts' number (default 8)
7746 local to buffer
7747 Number of spaces that a <Tab> in the file counts for. Also see
7748 |:retab| command, and 'softtabstop' option.
7749
7750 Note: Setting 'tabstop' to any other value than 8 can make your file
7751 appear wrong in many places (e.g., when printing it).
7752
7753 There are four main ways to use tabs in Vim:
7754 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7755 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007756 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 behave like a tab appears every 4 (or 3) characters.
7758 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7759 'expandtab'. This way you will always insert spaces. The
7760 formatting will never be messed up when 'tabstop' is changed.
7761 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007762 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 works when using Vim to edit the file.
7764 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7765 'noexpandtab'. This should then work (for initial indents only)
7766 for any tabstop setting that people use. It might be nice to have
7767 tabs after the first non-blank inserted as spaces if you do this
7768 though. Otherwise aligned comments will be wrong when 'tabstop' is
7769 changed.
7770
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007771 If Vim is compiled with the |+vartabs| feature then the value of
7772 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7773 than an empty string.
7774
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7776'tagbsearch' 'tbs' boolean (default on)
7777 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007778 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007779 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 searching makes searching for a tag a LOT faster, but a linear search
7781 will find more tags if the tags file wasn't properly sorted.
7782 Vim normally assumes that your tags files are sorted, or indicate that
7783 they are not sorted. Only when this is not the case does the
7784 'tagbsearch' option need to be switched off.
7785
7786 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007787 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 certain files, or retry all files with a linear search. When
7789 'tagbsearch' is off, only a linear search is done.
7790
7791 Linear searching is done anyway, for one file, when Vim finds a line
7792 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007793 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794< [The whitespace before and after the '0' must be a single <Tab>]
7795
7796 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007797 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 instead of a normal tag name, a retry is done with a linear search.
7799 Tags in unsorted tags files, and matches with different case will only
7800 be found in the retry.
7801
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007802 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007803 linear search can be avoided when case is ignored. Use a value of '2'
7804 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7805 sorted with the -f switch to "sort" in most unices, as in the command:
7806 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7807 (at least 5.5) the --sort=foldcase switch can be used for this as
7808 well. Note that case must be folded to uppercase for this to work.
7809
7810 By default, tag searches are case-sensitive. Case is ignored when
7811 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7812 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007813 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7814 'tagcase' is "smart", and the pattern contains only lowercase
7815 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816
7817 When 'tagbsearch' is off, tags searching is slower when a full match
7818 exists, but faster when no full match exists. Tags in unsorted tags
7819 files may only be found with 'tagbsearch' off.
7820 When the tags file is not sorted, or sorted in a wrong way (not on
7821 ASCII byte value), 'tagbsearch' should be off, or the line given above
7822 must be included in the tags file.
7823 This option doesn't affect commands that find all matching tags (e.g.,
7824 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007826 *'tagcase'* *'tc'*
7827'tagcase' 'tc' string (default "followic")
7828 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007829 This option specifies how case is handled when searching the tags
7830 file:
7831 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007832 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007833 ignore Ignore case
7834 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007835 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007836 NOTE: This option is set to the Vi default value when 'compatible' is
7837 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007838
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007839 *'tagfunc'* *'tfu'*
7840'tagfunc' 'tfu' string (default: empty)
7841 local to buffer
7842 {not available when compiled without the |+eval|
7843 feature}
7844 This option specifies a function to be used to perform tag searches.
7845 The function gets the tag pattern and should return a List of matching
7846 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007847 function and an example. The value can be the name of a function, a
7848 |lambda| or a |Funcref|. See |option-value-function| for more
7849 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007850
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 *'taglength'* *'tl'*
7852'taglength' 'tl' number (default 0)
7853 global
7854 If non-zero, tags are significant up to this number of characters.
7855
7856 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7857'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7858 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007859 If on and using a tags file in another directory, file names in that
7860 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 NOTE: This option is set to the Vi default value when 'compatible' is
7862 set and to the Vim default value when 'compatible' is reset.
7863
7864 *'tags'* *'tag'* *E433*
7865'tags' 'tag' string (default "./tags,tags", when compiled with
7866 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7867 global or local to buffer |global-local|
7868 Filenames for the tag command, separated by spaces or commas. To
7869 include a space or comma in a file name, precede it with a backslash
7870 (see |option-backslash| about including spaces and backslashes).
7871 When a file name starts with "./", the '.' is replaced with the path
7872 of the current file. But only when the 'd' flag is not included in
7873 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7874 |tags-option|.
7875 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007876 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7877 find all files named "tags" below "/lib". The filename itself cannot
7878 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7879 files called "tags?". {not available when compiled without the
7880 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007881 The |tagfiles()| function can be used to get a list of the file names
7882 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7884 files are also supported. They are automatically recognized. The
7885 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7886 differences are ignored (MS-Windows). |emacs-tags|
7887 The use of |:set+=| and |:set-=| is preferred when adding or removing
7888 file names from the list. This avoids problems when a future version
7889 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890
7891 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7892'tagstack' 'tgst' boolean (default on)
7893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 When on, the |tagstack| is used normally. When off, a ":tag" or
7895 ":tselect" command with an argument will not push the tag onto the
7896 tagstack. A following ":tag" without an argument, a ":pop" command or
7897 any other command that uses the tagstack will use the unmodified
7898 tagstack, but does change the pointer to the active entry.
7899 Resetting this option is useful when using a ":tag" command in a
7900 mapping which should not change the tagstack.
7901
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007902 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007903'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007904 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007905 {only available when compiled with the |+tcl/dyn|
7906 feature}
7907 Specifies the name of the Tcl shared library. The default is
7908 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007909 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007910 This option cannot be set from a |modeline| or in the |sandbox|, for
7911 security reasons.
7912
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 *'term'* *E529* *E530* *E531*
7914'term' string (default is $TERM, if that fails:
7915 in the GUI: "builtin_gui"
7916 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007917 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 on Unix: "ansi"
7920 on VMS: "ansi"
7921 on Win 32: "win32")
7922 global
7923 Name of the terminal. Used for choosing the terminal control
7924 characters. Environment variables are expanded |:set_env|.
7925 For example: >
7926 :set term=$TERM
7927< See |termcap|.
7928
7929 *'termbidi'* *'tbidi'*
7930 *'notermbidi'* *'notbidi'*
7931'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7932 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933 {only available when compiled with the |+arabic|
7934 feature}
7935 The terminal is in charge of Bi-directionality of text (as specified
7936 by Unicode). The terminal is also expected to do the required shaping
7937 that some languages (such as Arabic) require.
7938 Setting this option implies that 'rightleft' will not be set when
7939 'arabic' is set and the value of 'arabicshape' will be ignored.
7940 Note that setting 'termbidi' has the immediate effect that
7941 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7942 This option is reset when the GUI is started.
7943 For further details see |arabic.txt|.
7944
7945 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007946'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 Encoding used for the terminal. This specifies what character
7949 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007950 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007951 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007952 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007953 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7955 Any attempts to set a different value will be rejected, and an error
7956 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007957 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 because the Win32 system always passes Unicode characters.
7959 When empty, the same encoding is used as for the 'encoding' option.
7960 This is the normal value.
7961 Not all combinations for 'termencoding' and 'encoding' are valid. See
7962 |encoding-table|.
7963 The value for this option must be supported by internal conversions or
7964 iconv(). When this is not possible no conversion will be done and you
7965 will probably experience problems with non-ASCII characters.
7966 Example: You are working with the locale set to euc-jp (Japanese) and
7967 want to edit a UTF-8 file: >
7968 :let &termencoding = &encoding
7969 :set encoding=utf-8
7970< You need to do this when your system has no locale support for UTF-8.
7971
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007972 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007973'termguicolors' 'tgc' boolean (default off)
7974 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007975 {not available when compiled without the
7976 |+termguicolors| feature}
7977 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007978 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007979
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007980 Requires a ISO-8613-3 compatible terminal. If setting this option
7981 does not work (produces a colorless UI) reading |xterm-true-color|
7982 might help.
7983
7984 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7985 is required. Use this check to find out: >
7986 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007987< This requires Vim to be built with the |+vtp| feature.
7988
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007989 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007990 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007991
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007992 *'termwinkey'* *'twk'*
7993'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007994 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007995 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007996 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007997 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007998 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007999< The string must be one key stroke but can be multiple bytes.
8000 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008001 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008002 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008003
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008004 *'termwinscroll'* *'twsl'*
8005'termwinscroll' 'twsl' number (default 10000)
8006 local to buffer
8007 {not available when compiled without the
8008 |+terminal| feature}
8009 Number of scrollback lines to keep. When going over this limit the
8010 first 10% of the scrollback lines are deleted. This is just to reduce
8011 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008012 Also used as a limit for text sent to the terminal in one write,
8013 multiplied by the number of columns times 3 (average number of bytes
8014 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008015
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008016 *'termwinsize'* *'tws'*
8017'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008018 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008019 Size used when opening the |terminal| window. Format:
8020 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008021 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008022 - When set with a "x" (e.g., "24x80") the terminal size is not
8023 adjusted to the window size. If the window is smaller only the
8024 top-left part is displayed.
8025 - When set with a "*" (e.g., "10*50") the terminal size follows the
8026 window size, but will not be smaller than the specified rows and/or
8027 columns.
8028 - When rows is zero then use the height of the window.
8029 - When columns is zero then use the width of the window.
8030 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008031 - Can be overruled in the |term_start()| options with "term_rows" and
8032 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008033
8034 Examples:
8035 "30x0" uses 30 rows and the current window width.
8036 "20*0" uses at least 20 rows and the current window width.
8037 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008038 Note that the command running in the terminal window may still change
8039 the size of the terminal. In that case the Vim window will be
8040 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008041
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008042 *'termwintype'* *'twt'*
8043'termwintype' 'twt' string (default "")
8044 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008045 {only available when compiled with the |terminal|
8046 feature on MS-Windows}
8047 Specify the virtual console (pty) used when opening the terminal
8048 window.
8049
8050 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008051 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008052 "winpty" use winpty, fail if not supported
8053 "conpty" use |ConPTY|, fail if not supported
8054
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008055 |ConPTY| support depends on the platform. Windows 10 October 2018
8056 Update is the first version that supports ConPTY, however it is still
8057 considered unstable. ConPTY might become stable in the next release
8058 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008059 supported then you cannot open a terminal window.
8060
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061 *'terse'* *'noterse'*
8062'terse' boolean (default off)
8063 global
8064 When set: Add 's' flag to 'shortmess' option (this makes the message
8065 for a search that hits the start or end of the file not being
8066 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8067 shortens a lot of messages}
8068
8069 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8070'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 This option is obsolete. Use 'fileformats'.
8073 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8074 set to the default value for the current system. When 'textauto' is
8075 reset, 'fileformats' is made empty.
8076 NOTE: This option is set to the Vi default value when 'compatible' is
8077 set and to the Vim default value when 'compatible' is reset.
8078
8079 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008080'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081 others: default off)
8082 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 This option is obsolete. Use 'fileformat'.
8084 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8085 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8086 "unix".
8087
8088 *'textwidth'* *'tw'*
8089'textwidth' 'tw' number (default 0)
8090 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 Maximum width of text that is being inserted. A longer line will be
8092 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008093 this.
8094 'textwidth' is set to 0 when the 'paste' option is set and restored
8095 when 'paste' is reset.
8096 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008098 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099 NOTE: This option is set to 0 when 'compatible' is set.
8100
8101 *'thesaurus'* *'tsr'*
8102'thesaurus' 'tsr' string (default "")
8103 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008105 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8106 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008107
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008108 This option is not used if 'thesaurusfunc' is set, either for the
8109 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008110
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008111 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008113 name. See |option-backslash| about using backslashes. The use of
8114 |:set+=| and |:set-=| is preferred when adding or removing directories
8115 from the list. This avoids problems when a future version uses
8116 another default. Backticks cannot be used in this option for security
8117 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008119 *'thesaurusfunc'* *tsrfu'*
8120'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008121 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008122 {not available when compiled without the |+eval|
8123 feature}
8124 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008125 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008126 The value can be the name of a function, a |lambda| or a |Funcref|.
8127 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008128
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008129 This option cannot be set from a |modeline| or in the |sandbox|, for
8130 security reasons.
8131
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8133'tildeop' 'top' boolean (default off)
8134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008135 When on: The tilde command "~" behaves like an operator.
8136 NOTE: This option is reset when 'compatible' is set.
8137
8138 *'timeout'* *'to'* *'notimeout'* *'noto'*
8139'timeout' 'to' boolean (default on)
8140 global
8141 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008142'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 These two options together determine the behavior when part of a
8145 mapped key sequence or keyboard code has been received:
8146
8147 'timeout' 'ttimeout' action ~
8148 off off do not time out
8149 on on or off time out on :mappings and key codes
8150 off on time out on key codes
8151
8152 If both options are off, Vim will wait until either the complete
8153 mapping or key sequence has been received, or it is clear that there
8154 is no mapping or key sequence for the received characters. For
8155 example: if you have mapped "vl" and Vim has received 'v', the next
8156 character is needed to see if the 'v' is followed by an 'l'.
8157 When one of the options is on, Vim will wait for about 1 second for
8158 the next character to arrive. After that the already received
8159 characters are interpreted as single characters. The waiting time can
8160 be changed with the 'timeoutlen' option.
8161 On slow terminals or very busy systems timing out may cause
8162 malfunctioning cursor keys. If both options are off, Vim waits
8163 forever after an entered <Esc> if there are key codes that start
8164 with <Esc>. You will have to type <Esc> twice. If you do not have
8165 problems with key codes, but would like to have :mapped key
8166 sequences not timing out in 1 second, set the 'ttimeout' option and
8167 reset the 'timeout' option.
8168
8169 NOTE: 'ttimeout' is reset when 'compatible' is set.
8170
8171 *'timeoutlen'* *'tm'*
8172'timeoutlen' 'tm' number (default 1000)
8173 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008174
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008176'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 The time in milliseconds that is waited for a key code or mapped key
8179 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8180 when part of a command has been typed.
8181 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8182 different timeout value for key codes is desired set 'ttimeoutlen' to
8183 a non-negative number.
8184
8185 ttimeoutlen mapping delay key code delay ~
8186 < 0 'timeoutlen' 'timeoutlen'
8187 >= 0 'timeoutlen' 'ttimeoutlen'
8188
8189 The timeout only happens when the 'timeout' and 'ttimeout' options
8190 tell so. A useful setting would be >
8191 :set timeout timeoutlen=3000 ttimeoutlen=100
8192< (time out on mapping after three seconds, time out on key codes after
8193 a tenth of a second).
8194
8195 *'title'* *'notitle'*
8196'title' boolean (default off, on when title can be restored)
8197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 When on, the title of the window will be set to the value of
8199 'titlestring' (if it is not empty), or to:
8200 filename [+=-] (path) - VIM
8201 Where:
8202 filename the name of the file being edited
8203 - indicates the file cannot be modified, 'ma' off
8204 + indicates the file was modified
8205 = indicates the file is read-only
8206 =+ indicates the file is read-only and modified
8207 (path) is the path of the file being edited
8208 - VIM the server name |v:servername| or "VIM"
8209 Only works if the terminal supports setting window titles
8210 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008211 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8213 *X11*
8214 When Vim was compiled with HAVE_X11 defined, the original title will
8215 be restored if possible. The output of ":version" will include "+X11"
8216 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8217 works for the icon name |'icon'|.
8218 But: When Vim was started with the |-X| argument, restoring the title
8219 will not work (except in the GUI).
8220 If the title cannot be restored, it is set to the value of 'titleold'.
8221 You might want to restore the title outside of Vim then.
8222 When using an xterm from a remote machine you can use this command:
8223 rsh machine_name xterm -display $DISPLAY &
8224 then the WINDOWID environment variable should be inherited and the
8225 title of the window should change back to what it should be after
8226 exiting Vim.
8227
8228 *'titlelen'*
8229'titlelen' number (default 85)
8230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008232 title. When the title is longer, only the end of the path name is
8233 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234 Using a percentage makes this adapt to the width of the window. But
8235 it won't work perfectly, because the actual number of characters
8236 available also depends on the font used and other things in the title
8237 bar. When 'titlelen' is zero the full path is used. Otherwise,
8238 values from 1 to 30000 percent can be used.
8239 'titlelen' is also used for the 'titlestring' option.
8240
8241 *'titleold'*
8242'titleold' string (default "Thanks for flying Vim")
8243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 This option will be used for the window title when exiting Vim if the
8245 original title cannot be restored. Only happens if 'title' is on or
8246 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008247 This option cannot be set from a |modeline| or in the |sandbox|, for
8248 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 *'titlestring'*
8250'titlestring' string (default "")
8251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252 When this option is not empty, it will be used for the title of the
8253 window. This happens only when the 'title' option is on.
8254 Only works if the terminal supports setting window titles (currently
8255 Amiga console, Win32 console, all GUI versions and terminals with a
8256 non-empty 't_ts' option).
8257 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008258 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008259
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 When this option contains printf-style '%' items, they will be
8261 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008262 This option cannot be set in a modeline when 'modelineexpr' is off.
8263
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264 Example: >
8265 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8266 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8267< The value of 'titlelen' is used to align items in the middle or right
8268 of the available space.
8269 Some people prefer to have the file name first: >
8270 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8271< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008272 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 separating space only when needed.
8274 NOTE: Use of special characters in 'titlestring' may cause the display
8275 to be garbled (e.g., when it contains a CR or NL character).
8276 {not available when compiled without the |+statusline| feature}
8277
8278 *'toolbar'* *'tb'*
8279'toolbar' 'tb' string (default "icons,tooltips")
8280 global
8281 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8282 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008283 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 possible values are:
8285 icons Toolbar buttons are shown with icons.
8286 text Toolbar buttons shown with text.
8287 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008288 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 tooltips Tooltips are active for toolbar buttons.
8290 Tooltips refer to the popup help text which appears after the mouse
8291 cursor is placed over a toolbar button for a brief moment.
8292
8293 If you want the toolbar to be shown with icons as well as text, do the
8294 following: >
8295 :set tb=icons,text
8296< Motif and Athena cannot display icons and text at the same time. They
8297 will show icons if both are requested.
8298
8299 If none of the strings specified in 'toolbar' are valid or if
8300 'toolbar' is empty, this option is ignored. If you want to disable
8301 the toolbar, you need to set the 'guioptions' option. For example: >
8302 :set guioptions-=T
8303< Also see |gui-toolbar|.
8304
8305 *'toolbariconsize'* *'tbis'*
8306'toolbariconsize' 'tbis' string (default "small")
8307 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008308 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008310 tiny Use tiny icons.
8311 small Use small icons (default).
8312 medium Use medium-sized icons.
8313 large Use large icons.
8314 huge Use even larger icons.
8315 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008317 the current theme. Common dimensions are giant=48x48, huge=32x32,
8318 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319
8320 If 'toolbariconsize' is empty, the global default size as determined
8321 by user preferences or the current theme is used.
8322
8323 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8324'ttybuiltin' 'tbi' boolean (default on)
8325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 When on, the builtin termcaps are searched before the external ones.
8327 When off the builtin termcaps are searched after the external ones.
8328 When this option is changed, you should set the 'term' option next for
8329 the change to take effect, for example: >
8330 :set notbi term=$TERM
8331< See also |termcap|.
8332 Rationale: The default for this option is "on", because the builtin
8333 termcap entries are generally better (many systems contain faulty
8334 xterm entries...).
8335
8336 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8337'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8338 sun-cmd, screen, rxvt, dtterm or
8339 iris-ansi; also on when running Vim in
8340 a DOS console)
8341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 Indicates a fast terminal connection. More characters will be sent to
8343 the screen for redrawing, instead of using insert/delete line
8344 commands. Improves smoothness of redrawing when there are multiple
8345 windows and the terminal does not support a scrolling region.
8346 Also enables the extra writing of characters at the end of each screen
8347 line for lines that wrap. This helps when using copy/paste with the
8348 mouse in an xterm and other terminals.
8349
8350 *'ttymouse'* *'ttym'*
8351'ttymouse' 'ttym' string (default depends on 'term')
8352 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353 {only in Unix and VMS, doesn't work in the GUI; not
8354 available when compiled without |+mouse|}
8355 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008356 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 *xterm-mouse*
8358 xterm xterm-like mouse handling. The mouse generates
8359 "<Esc>[Mscr", where "scr" is three bytes:
8360 "s" = button state
8361 "c" = column plus 33
8362 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008363 This only works up to 223 columns! See "dec",
8364 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 xterm2 Works like "xterm", but with the xterm reporting the
8366 mouse position while the mouse is dragged. This works
8367 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008368 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 work. See below for how Vim detects this
8370 automatically.
8371 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008372 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008373 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008374 for the row and column. No other mouse events are
8375 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 *dec-mouse*
8377 dec DEC terminal mouse handling. The mouse generates a
8378 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008379 This is also available for an Xterm, if it was
8380 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381 *jsbterm-mouse*
8382 jsbterm JSB term mouse handling.
8383 *pterm-mouse*
8384 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008385 *urxvt-mouse*
8386 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008387 The mouse works only if the terminal supports this
8388 encoding style, but it does not have 223 columns limit
8389 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008390 *sgr-mouse*
8391 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008392 mouse reporting. The mouse works even in columns
8393 beyond 223. This option is backward compatible with
8394 "xterm2" because it can also decode "xterm2" style
8395 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396
8397 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008398 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8399 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8401 recognized, if enabled at compile time. DEC terminal mouse codes
8402 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008403 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8404 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008406 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8407 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8408 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008409 Additionally, if vim is compiled with the |+termresponse| feature and
8410 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008411 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008412 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008413 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8414 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8415 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008416 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8417 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 :set t_RV=
8419<
8420 *'ttyscroll'* *'tsl'*
8421'ttyscroll' 'tsl' number (default 999)
8422 global
8423 Maximum number of lines to scroll the screen. If there are more lines
8424 to scroll the window is redrawn. For terminals where scrolling is
8425 very slow and redrawing is not slow this can be set to a small number,
8426 e.g., 3, to speed up displaying.
8427
8428 *'ttytype'* *'tty'*
8429'ttytype' 'tty' string (default from $TERM)
8430 global
8431 Alias for 'term', see above.
8432
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008433 *'undodir'* *'udir'*
8434'undodir' 'udir' string (default ".")
8435 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008436 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008437 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008438 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008439 "." means using the directory of the file. The undo file name for
8440 "file.txt" is ".file.txt.un~".
8441 For other directories the file name is the full path of the edited
8442 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008443 When writing: The first directory that exists is used. "." always
8444 works, no directories after "." will be used for writing.
8445 When reading all entries are tried to find an undo file. The first
8446 undo file that exists is used. When it cannot be read an error is
8447 given, no further entry is used.
8448 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008449 This option cannot be set from a |modeline| or in the |sandbox|, for
8450 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008451
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008452 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008453'undofile' 'udf' boolean (default off)
8454 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008455 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008456 When on, Vim automatically saves undo history to an undo file when
8457 writing a buffer to a file, and restores undo history from the same
8458 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008459 The directory where the undo file is stored is specified by 'undodir'.
8460 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008461 The undo file is not read when 'undoreload' causes the buffer from
8462 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008463 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008464 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008465
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008467'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008468 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008470 is kept in memory, higher numbers will cause more memory to be used.
8471 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8473 itself: >
8474 set ul=0
8475< But you can also get Vi compatibility by including the 'u' flag in
8476 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008477 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008478 Set to -1 for no undo at all. You might want to do this only for the
8479 current buffer: >
8480 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008482
8483 The local value is set to -123456 when the global value is to be used.
8484
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008485 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008487 *'undoreload'* *'ur'*
8488'undoreload' 'ur' number (default 10000)
8489 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008490 Save the whole buffer for undo when reloading it. This applies to the
8491 ":e!" command and reloading for when the buffer changed outside of
8492 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008493 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008494 of lines is smaller than the value of this option.
8495 Set this option to zero to disable undo for a reload.
8496
8497 When saving undo for a reload, any undo file is not read.
8498
8499 Note that this causes the whole buffer to be stored in memory. Set
8500 this option to a lower value if you run out of memory.
8501
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 *'updatecount'* *'uc'*
8503'updatecount' 'uc' number (default: 200)
8504 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 After typing this many characters the swap file will be written to
8506 disk. When zero, no swap file will be created at all (see chapter on
8507 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8508 Vim with the "-n" option, see |startup|. When editing in readonly
8509 mode this option will be initialized to 10000.
8510 The swapfile can be disabled per buffer with |'swapfile'|.
8511 When 'updatecount' is set from zero to non-zero, swap files are
8512 created for all buffers that have 'swapfile' set. When 'updatecount'
8513 is set to zero, existing swap files are not deleted.
8514 Also see |'swapsync'|.
8515 This option has no meaning in buffers where |'buftype'| is "nofile"
8516 or "nowrite".
8517
8518 *'updatetime'* *'ut'*
8519'updatetime' 'ut' number (default 4000)
8520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 If this many milliseconds nothing is typed the swap file will be
8522 written to disk (see |crash-recovery|). Also used for the
8523 |CursorHold| autocommand event.
8524
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008525 *'varsofttabstop'* *'vsts'*
8526'varsofttabstop' 'vsts' string (default "")
8527 local to buffer
8528 {only available when compiled with the |+vartabs|
8529 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008530 A list of the number of spaces that a <Tab> counts for while editing,
8531 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8532 width <Tab>s are being inserted, while in fact a mixture of spaces
8533 and <Tab>s is used. Tab widths are separated with commas, with the
8534 final value applying to all subsequent tabs.
8535
8536 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008537 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008538 to use the following: >
8539 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008540< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8541 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008542
8543 Note that the value of |'softtabstop'| will be ignored while
8544 'varsofttabstop' is set.
8545
8546 *'vartabstop'* *'vts'*
8547'vartabstop' 'vts' string (default "")
8548 local to buffer
8549 {only available when compiled with the |+vartabs|
8550 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008551 A list of the number of spaces that a <Tab> in the file counts for,
8552 separated by commas. Each value corresponds to one tab, with the
8553 final value applying to all subsequent tabs. For example: >
8554 :set vartabstop=4,20,10,8
8555< This will make the first tab 4 spaces wide, the second 20 spaces,
8556 the third 10 spaces, and all following tabs 8 spaces.
8557
8558 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8559 is set.
8560
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 *'verbose'* *'vbs'*
8562'verbose' 'vbs' number (default 0)
8563 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 When bigger than zero, Vim will give messages about what it is doing.
8565 Currently, these messages are given:
8566 >= 1 When the viminfo file is read or written.
8567 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008568 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008569 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 >= 8 Files for which a group of autocommands is executed.
8571 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008572 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 >= 12 Every executed function.
8574 >= 13 When an exception is thrown, caught, finished, or discarded.
8575 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008576 >= 15 Every executed Ex command from a script (truncated at 200
8577 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008578 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579
8580 This option can also be set with the "-V" argument. See |-V|.
8581 This option is also set by the |:verbose| command.
8582
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008583 When the 'verbosefile' option is set then the verbose messages are not
8584 displayed.
8585
8586 *'verbosefile'* *'vfile'*
8587'verbosefile' 'vfile' string (default empty)
8588 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008589 When not empty all messages are written in a file with this name.
8590 When the file exists messages are appended.
8591 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008592 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008593 Setting 'verbosefile' to a new value is like making it empty first.
8594 The difference with |:redir| is that verbose messages are not
8595 displayed when 'verbosefile' is set.
8596
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008598'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 "$VIM/vimfiles/view",
8600 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008601 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008602 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008604 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 feature}
8606 Name of the directory where to store files for |:mkview|.
8607 This option cannot be set from a |modeline| or in the |sandbox|, for
8608 security reasons.
8609
8610 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008611'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008613 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 feature}
8615 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008616 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 word save and restore ~
8618 cursor cursor position in file and in window
8619 folds manually created folds, opened/closed folds and local
8620 fold options
8621 options options and mappings local to a window or buffer (not
8622 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008623 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 slash backslashes in file names replaced with forward
8625 slashes
8626 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008627 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008628 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008630 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008632 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633
8634 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008635'viminfo' 'vi' string (Vi default: "", Vim default for
8636 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008637 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8638 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008640 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 feature}
8642 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008643 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8644 "NONE".
8645 The string should be a comma separated list of parameters, each
8646 consisting of a single character identifying the particular parameter,
8647 followed by a number or string which specifies the value of that
8648 parameter. If a particular character is left out, then the default
8649 value is used for that parameter. The following is a list of the
8650 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008652 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 ! When included, save and restore global variables that start
8654 with an uppercase letter, and don't contain a lowercase
8655 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008656 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008657 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008658 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 " Maximum number of lines saved for each register. Old name of
8660 the '<' item, with the disadvantage that you need to put a
8661 backslash before the ", otherwise it will be recognized as the
8662 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008663 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 % When included, save and restore the buffer list. If Vim is
8665 started with a file name argument, the buffer list is not
8666 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008667 buffer list is restored from the viminfo file. Quickfix
8668 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8669 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008670 When followed by a number, the number specifies the maximum
8671 number of buffers that are stored. Without a number all
8672 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008673 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 ' Maximum number of previously edited files for which the marks
8675 are remembered. This parameter must always be included when
8676 'viminfo' is non-empty.
8677 Including this item also means that the |jumplist| and the
8678 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008679 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008680 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008681 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 patterns are also saved. When not included, the value of
8683 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008684 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008686 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008687 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 < Maximum number of lines saved for each register. If zero then
8689 registers are not saved. When not included, all lines are
8690 saved. '"' is the old name for this item.
8691 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008692 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008694 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008695 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 c When included, convert the text in the viminfo file from the
8697 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008698 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008699 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 f Whether file marks need to be stored. If zero, file marks ('0
8701 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008702 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008704 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 h Disable the effect of 'hlsearch' when loading the viminfo
8706 file. When not included, it depends on whether ":nohlsearch"
8707 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008708 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008710 the 'n'. Must be at the end of the option! If the
8711 'viminfofile' option is set, that file name overrides the one
8712 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008713 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008714 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008715 r Removable media. The argument is a string (up to the next
8716 ','). This parameter can be given several times. Each
8717 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008718 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8720 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8721 ignored. Maximum length of each 'r' argument is 50
8722 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008723 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 s Maximum size of an item in Kbyte. If zero then registers are
8725 not saved. Currently only applies to registers. The default
8726 "s10" will exclude registers with more than 10 Kbyte of text.
8727 Also see the '<' item above: line count limit.
8728
8729 Example: >
8730 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8731<
8732 '50 Marks will be remembered for the last 50 files you
8733 edited.
8734 <1000 Contents of registers (up to 1000 lines each) will be
8735 remembered.
8736 s100 Registers with more than 100 Kbyte text are skipped.
8737 :0 Command-line history will not be saved.
8738 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8739 no / Since '/' is not specified, the default will be used,
8740 that is, save all of the search history, and also the
8741 previous search and substitute patterns.
8742 no % The buffer list will not be saved nor read back.
8743 no h 'hlsearch' highlighting will be restored.
8744
8745 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8746 load the contents of the file, this is not done automatically.
8747
8748 This option cannot be set from a |modeline| or in the |sandbox|, for
8749 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008750 NOTE: This option is set to the Vim default value when 'compatible'
8751 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008752
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008753 *'viminfofile'* *'vif'*
8754'viminfofile' 'vif' string (default: "")
8755 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008756 {not available when compiled without the |+viminfo|
8757 feature}
8758 When non-empty, overrides the file name used for viminfo.
8759 When equal to "NONE" no viminfo file will be read or written.
8760 This option can be set with the |-i| command line flag. The |--clean|
8761 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008762 This option cannot be set from a |modeline| or in the |sandbox|, for
8763 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008764
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 *'virtualedit'* *'ve'*
8766'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008767 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768 A comma separated list of these words:
8769 block Allow virtual editing in Visual block mode.
8770 insert Allow virtual editing in Insert mode.
8771 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008772 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008773 none When used as the local value, do not allow virtual
8774 editing even when the global value is set. When used
8775 as the global value, "none" is the same as "".
8776 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008777
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008779 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 of the line. Useful for selecting a rectangle in Visual mode and
8781 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008782 "onemore" is not the same, it will only allow moving the cursor just
8783 after the last character of the line. This makes some commands more
8784 consistent. Previously the cursor was always past the end of the line
8785 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008786 break some plugins or Vim scripts. For example because |l| can move
8787 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008788 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008789 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008790 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008791 It doesn't make sense to combine "all" with "onemore", but you will
8792 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008793 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008794 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795
8796 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8797'visualbell' 'vb' boolean (default off)
8798 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008799 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008801 use: >
8802 :set vb t_vb=
8803< If you want a short flash, you can use this on many terminals: >
8804 :set vb t_vb=[?5h$<100>[?5l
8805< Here $<100> specifies the time, you can use a smaller or bigger value
8806 to get a shorter or longer flash.
8807
8808 Note: Vim will limit the bell to once per half a second. This avoids
8809 having to wait for the flashing to finish when there are lots of
8810 bells, e.g. on key repeat. This also happens without 'visualbell'
8811 set.
8812
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8814 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8815 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008816
8817 Note: When the GUI starts, 't_vb' is reset to its default value. You
8818 might want to set it again in your |gvimrc|.
8819
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 Does not work on the Amiga, you always get a screen flash.
8821 Also see 'errorbells'.
8822
8823 *'warn'* *'nowarn'*
8824'warn' boolean (default on)
8825 global
8826 Give a warning message when a shell command is used while the buffer
8827 has been changed.
8828
8829 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8830'weirdinvert' 'wiv' boolean (default off)
8831 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008832 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 It is provided for backwards compatibility with version 4.x.
8834 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8835 vice versa. Has no effect when the GUI is running.
8836
8837 *'whichwrap'* *'ww'*
8838'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 Allow specified keys that move the cursor left/right to move to the
8841 previous/next line when the cursor is on the first/last character in
8842 the line. Concatenate characters to allow this for these keys:
8843 char key mode ~
8844 b <BS> Normal and Visual
8845 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008846 h "h" Normal and Visual (not recommended)
8847 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 < <Left> Normal and Visual
8849 > <Right> Normal and Visual
8850 ~ "~" Normal
8851 [ <Left> Insert and Replace
8852 ] <Right> Insert and Replace
8853 For example: >
8854 :set ww=<,>,[,]
8855< allows wrap only when cursor keys are used.
8856 When the movement keys are used in combination with a delete or change
8857 operator, the <EOL> also counts for a character. This makes "3h"
8858 different from "3dh" when the cursor crosses the end of a line. This
8859 is also true for "x" and "X", because they do the same as "dl" and
8860 "dh". If you use this, you may also want to use the mapping
8861 ":map <BS> X" to make backspace delete the character in front of the
8862 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008863 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008864 line (not an empty line) then it will not move to the next line. This
8865 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 NOTE: This option is set to the Vi default value when 'compatible' is
8867 set and to the Vim default value when 'compatible' is reset.
8868
8869 *'wildchar'* *'wc'*
8870'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 Character you have to type to start wildcard expansion in the
8873 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008874 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 The character is not recognized when used inside a macro. See
8876 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008877 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008879 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880< NOTE: This option is set to the Vi default value when 'compatible' is
8881 set and to the Vim default value when 'compatible' is reset.
8882
8883 *'wildcharm'* *'wcm'*
8884'wildcharm' 'wcm' number (default: none (0))
8885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008887 recognized when used inside a macro. You can find "spare" command-line
8888 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 you'll never actually type 'wildcharm', just use it in mappings that
8890 automatically invoke completion mode, e.g.: >
8891 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008892 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893< Then after typing :ss you can use CTRL-P & CTRL-N.
8894
8895 *'wildignore'* *'wig'*
8896'wildignore' 'wig' string (default "")
8897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 {not available when compiled without the |+wildignore|
8899 feature}
8900 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008901 patterns is ignored when expanding |wildcards|, completing file or
8902 directory names, and influences the result of |expand()|, |glob()| and
8903 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008904 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8905 Also see 'suffixes'.
8906 Example: >
8907 :set wildignore=*.o,*.obj
8908< The use of |:set+=| and |:set-=| is preferred when adding or removing
8909 a pattern from the list. This avoids problems when a future version
8910 uses another default.
8911
Bram Moolenaar94950a92010-12-02 16:01:29 +01008912
Bram Moolenaar81af9252010-12-10 20:35:50 +01008913 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008914'wildignorecase' 'wic' boolean (default off)
8915 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008916 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008917 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008918 Does not apply when the shell is used to expand wildcards, which
8919 happens when there are special characters.
8920
8921
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008923'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925 {not available if compiled without the |+wildmenu|
8926 feature}
8927 When 'wildmenu' is on, command-line completion operates in an enhanced
8928 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8929 the possible matches are shown just above the command line, with the
8930 first match highlighted (overwriting the status line, if there is
8931 one). Keys that show the previous/next match, such as <Tab> or
8932 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8933 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8934 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008935 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008936 If there are more matches than can fit in the line, a ">" is shown on
8937 the right and/or a "<" is shown on the left. The status line scrolls
8938 as needed.
8939 The "wildmenu" mode is abandoned when a key is hit that is not used
8940 for selecting a completion.
8941 While the "wildmenu" is active the following keys have special
8942 meanings:
8943
8944 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8945 <Down> - in filename/menu name completion: move into a
8946 subdirectory or submenu.
8947 <CR> - in menu completion, when the cursor is just after a
8948 dot: move into a submenu.
8949 <Up> - in filename/menu name completion: move up into
8950 parent directory or parent menu.
8951
8952 This makes the menus accessible from the console |console-menus|.
8953
8954 If you prefer the <Left> and <Right> keys to move the cursor instead
8955 of selecting a different match, use this: >
8956 :cnoremap <Left> <Space><BS><Left>
8957 :cnoremap <Right> <Space><BS><Right>
8958<
8959 The "WildMenu" highlighting is used for displaying the current match
8960 |hl-WildMenu|.
8961
8962 *'wildmode'* *'wim'*
8963'wildmode' 'wim' string (Vim default: "full")
8964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008966 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008967 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 first part specifies the behavior for the first use of 'wildchar',
8969 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008970
8971 Each part consists of a colon separated list consisting of the
8972 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973 "" Complete only the first match.
8974 "full" Complete the next full match. After the last match,
8975 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008976 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008977 "longest" Complete till longest common string. If this doesn't
8978 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008979 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008980 "lastused" When completing buffer names and more than one buffer
8981 matches, sort buffers by time last used (other than
8982 the current buffer).
8983 When there is only a single match, it is fully completed in all cases.
8984
8985 Examples of useful colon-separated values:
8986 "longest:full" Like "longest", but also start 'wildmenu' if it is
8987 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008988 "list:full" When more than one match, list all matches and
8989 complete first match.
8990 "list:longest" When more than one match, list all matches and
8991 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008992 "list:lastused" When more than one buffer matches, list all matches
8993 and sort buffers by time last used (other than the
8994 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995
8996 Examples: >
8997 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008998< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 :set wildmode=longest,full
9000< Complete longest common string, then each full match >
9001 :set wildmode=list:full
9002< List all matches and complete each full match >
9003 :set wildmode=list,full
9004< List all matches without completing, then each full match >
9005 :set wildmode=longest,list
9006< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009007 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009009 *'wildoptions'* *'wop'*
9010'wildoptions' 'wop' string (default "")
9011 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009012 {not available when compiled without the |+wildignore|
9013 feature}
9014 A list of words that change how command line completion is done.
9015 Currently only one word is allowed:
9016 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009017 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009018 is displayed per line. Often used tag kinds are:
9019 d #define
9020 f function
9021 Also see |cmdline-completion|.
9022
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023 *'winaltkeys'* *'wak'*
9024'winaltkeys' 'wak' string (default "menu")
9025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 {only used in Win32, Motif, GTK and Photon GUI}
9027 Some GUI versions allow the access to menu entries by using the ALT
9028 key in combination with a character that appears underlined in the
9029 menu. This conflicts with the use of the ALT key for mappings and
9030 entering special characters. This option tells what to do:
9031 no Don't use ALT keys for menus. ALT key combinations can be
9032 mapped, but there is no automatic handling. This can then be
9033 done with the |:simalt| command.
9034 yes ALT key handling is done by the windowing system. ALT key
9035 combinations cannot be mapped.
9036 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009037 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009038 keys can be mapped.
9039 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9040 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009041 This option is not used for <F10>; on Win32 and with GTK <F10> will
9042 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009044 *'wincolor'* *'wcr'*
9045'wincolor' 'wcr' string (default empty)
9046 local to window
9047 Highlight group name to use for this window instead of the Normal
9048 color |hl-Normal|.
9049
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009050 *'window'* *'wi'*
9051'window' 'wi' number (default screen height - 1)
9052 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009053 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9054 window and the value is smaller than 'lines' minus one. The screen
9055 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009056 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9057 in a much smarter way, taking care of wrapping lines.
9058 When resizing the Vim window, the value is smaller than 1 or more than
9059 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009060 Note: Do not confuse this with the height of the Vim window, use
9061 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009062
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 *'winheight'* *'wh'* *E591*
9064'winheight' 'wh' number (default 1)
9065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009066 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009067 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009068 focus goes to a window that is smaller, its size is increased, at the
9069 cost of the height of other windows.
9070 Set 'winheight' to a small number for normal editing.
9071 Set it to 999 to make the current window fill most of the screen.
9072 Other windows will be only 'winminheight' high. This has the drawback
9073 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9074 to create only two windows, set the option after startup is done,
9075 using the |VimEnter| event: >
9076 au VimEnter * set winheight=999
9077< Minimum value is 1.
9078 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079 height of the current window.
9080 'winheight' applies to the current window. Use 'winminheight' to set
9081 the minimal height for other windows.
9082
9083 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9084'winfixheight' 'wfh' boolean (default off)
9085 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009087 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9088 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089 The height may be changed anyway when running out of room.
9090
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009091 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9092'winfixwidth' 'wfw' boolean (default off)
9093 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009094 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009095 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009096 The width may be changed anyway when running out of room.
9097
Bram Moolenaar071d4272004-06-13 20:20:40 +00009098 *'winminheight'* *'wmh'*
9099'winminheight' 'wmh' number (default 1)
9100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009101 The minimal height of a window, when it's not the current window.
9102 This is a hard minimum, windows will never become smaller.
9103 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9104 status bar) if necessary. They will return to at least one line when
9105 they become active (since the cursor has to have somewhere to go.)
9106 Use 'winheight' to set the minimal height of the current window.
9107 This option is only checked when making a window smaller. Don't use a
9108 large number, it will cause errors when opening more than a few
9109 windows. A value of 0 to 3 is reasonable.
9110
9111 *'winminwidth'* *'wmw'*
9112'winminwidth' 'wmw' number (default 1)
9113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114 The minimal width of a window, when it's not the current window.
9115 This is a hard minimum, windows will never become smaller.
9116 When set to zero, windows may be "squashed" to zero columns (i.e. just
9117 a vertical separator) if necessary. They will return to at least one
9118 line when they become active (since the cursor has to have somewhere
9119 to go.)
9120 Use 'winwidth' to set the minimal width of the current window.
9121 This option is only checked when making a window smaller. Don't use a
9122 large number, it will cause errors when opening more than a few
9123 windows. A value of 0 to 12 is reasonable.
9124
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009125 *'winptydll'*
9126'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9127 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009128 {only available when compiled with the |terminal|
9129 feature on MS-Windows}
9130 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009131 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009132 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009133 a fallback.
9134 Environment variables are expanded |:set_env|.
9135 This option cannot be set from a |modeline| or in the |sandbox|, for
9136 security reasons.
9137
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138 *'winwidth'* *'wiw'* *E592*
9139'winwidth' 'wiw' number (default 20)
9140 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 Minimal number of columns for the current window. This is not a hard
9142 minimum, Vim will use fewer columns if there is not enough room. If
9143 the current window is smaller, its size is increased, at the cost of
9144 the width of other windows. Set it to 999 to make the current window
9145 always fill the screen. Set it to a small number for normal editing.
9146 The width is not adjusted after one of the commands to change the
9147 width of the current window.
9148 'winwidth' applies to the current window. Use 'winminwidth' to set
9149 the minimal width for other windows.
9150
9151 *'wrap'* *'nowrap'*
9152'wrap' boolean (default on)
9153 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009154 This option changes how text is displayed. It doesn't change the text
9155 in the buffer, see 'textwidth' for that.
9156 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009157 displaying continues on the next line. When off lines will not wrap
9158 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159 moved to a part that is not shown, the screen will scroll
9160 horizontally.
9161 The line will be broken in the middle of a word if necessary. See
9162 'linebreak' to get the break at a word boundary.
9163 To make scrolling horizontally a bit more useful, try this: >
9164 :set sidescroll=5
9165 :set listchars+=precedes:<,extends:>
9166< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009167 This option can't be set from a |modeline| when the 'diff' option is
9168 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009169
9170 *'wrapmargin'* *'wm'*
9171'wrapmargin' 'wm' number (default 0)
9172 local to buffer
9173 Number of characters from the right window border where wrapping
9174 starts. When typing text beyond this limit, an <EOL> will be inserted
9175 and inserting continues on the next line.
9176 Options that add a margin, such as 'number' and 'foldcolumn', cause
9177 the text width to be further reduced. This is Vi compatible.
9178 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009179 This option is set to 0 when 'paste' is set and restored when 'paste'
9180 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009181 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009182
9183 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9184'wrapscan' 'ws' boolean (default on) *E384* *E385*
9185 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009186 Searches wrap around the end of the file. Also applies to |]s| and
9187 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009188
9189 *'write'* *'nowrite'*
9190'write' boolean (default on)
9191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009192 Allows writing files. When not set, writing a file is not allowed.
9193 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009194 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009195 argument. Filtering text is still possible, even though this requires
9196 writing a temporary file.
9197
9198 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9199'writeany' 'wa' boolean (default off)
9200 global
9201 Allows writing to any file with no need for "!" override.
9202
9203 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9204'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9205 otherwise)
9206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009207 Make a backup before overwriting a file. The backup is removed after
9208 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009209 also on.
9210 WARNING: Switching this option off means that when Vim fails to write
9211 your buffer correctly and then, for whatever reason, Vim exits, you
9212 lose both the original file and what you were writing. Only reset
9213 this option if your file system is almost full and it makes the write
9214 fail (and make sure not to exit Vim until the write was successful).
9215 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009216 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009217 Depending on 'backupcopy' the backup is a new file or the original
9218 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 NOTE: This option is set to the default value when 'compatible' is
9220 set.
9221
9222 *'writedelay'* *'wd'*
9223'writedelay' 'wd' number (default 0)
9224 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009225 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009226 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009227 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009228
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009229 *'xtermcodes'* *'noxtermcodes'*
9230'xtermcodes' boolean (default on)
9231 global
9232 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009233 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009234 key codes and number of colors from the terminal. This takes care of
9235 various configuration options of the terminal that cannot be obtained
9236 from the termlib/terminfo entry, see |xterm-codes|.
9237 A side effect may be that t_Co changes and Vim will redraw the
9238 display.
9239
9240
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009241 vim:tw=78:ts=8:noet:ft=help:norl: