blob: 199c261761c33b24c7ee24d2f68d23aaa7632e2f [file] [log] [blame]
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001*options.txt* For Vim version 8.2. Last change: 2022 Jan 22
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
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000173< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100174
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000175The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
176security reasons.
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000179at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180"set all" probably does not fit on the screen, causing Vim to give the
181|more-prompt|.
182
183 *option-backslash*
184To include white space in a string option value it has to be preceded with a
185backslash. To include a backslash you have to use two. Effectively this
186means that the number of backslashes in an option value is halved (rounded
187down).
188A few examples: >
189 :set tags=tags\ /usr/tags results in "tags /usr/tags"
190 :set tags=tags\\,file results in "tags\,file"
191 :set tags=tags\\\ file results in "tags\ file"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193The "|" character separates a ":set" command from a following command. To
194include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195'titlestring' option to "hi|there": >
196 :set titlestring=hi\|there
197This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
198 :set titlestring=hi|set iconstring=there
199
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200200Similarly, in legacy script the double quote character starts a comment. To
201include the '"' in the option value, use '\"' instead. This example sets the
202'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000203 :set titlestring=hi\ \"there\"
204
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200205In |Vim9| script it's simpler, comments start with a '#' character, and only
206when preceded by white space. A backslash is needed less often: >
207 vim9script
208 set titlestring=hi\ "there"
209 set titlestring=hi#there#
210 set titlestring=hi\ \#there#
211
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100212For Win32 backslashes in file names are mostly not removed. More precise: For
213options that expect a file name (those where environment variables are
214expanded) a backslash before a normal file name character is not removed. But
215a backslash before a special character (space, backslash, comma, etc.) is used
216like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217There is one special situation, when the value starts with "\\": >
218 :set dir=\\machine\path results in "\\machine\path"
219 :set dir=\\\\machine\\path results in "\\machine\path"
220 :set dir=\\path\\file results in "\\path\file" (wrong!)
221For the first one the start is kept, but for the second one the backslashes
222are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000223halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224result which is probably not what you want. Avoid it.
225
226 *add-option-flags* *remove-option-flags*
227 *E539* *E550* *E551* *E552*
228Some options are a list of flags. When you want to add a flag to such an
229option, without changing the existing ones, you can do it like this: >
230 :set guioptions+=a
231Remove a flag from an option like this: >
232 :set guioptions-=a
233This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000234Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
236doesn't appear.
237
238 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000239Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240environment variable exists the '$' and the following environment variable
241name is replaced with its value. If it does not exist the '$' and the name
242are not modified. Any non-id character (not a letter, digit or '_') may
243follow the environment variable name. That character and what follows is
244appended to the value of the environment variable. Examples: >
245 :set term=$TERM.new
246 :set path=/usr/$INCLUDE,$HOME/include,.
247When adding or removing a string from an option with ":set opt-=val" or ":set
248opt+=val" the expansion is done before the adding or removing.
249
250
251Handling of local options *local-options*
252
253Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100254has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255allows you to set 'list' in one window but not in another. And set
256'shiftwidth' to 3 in one buffer and 4 in another.
257
258The following explains what happens to these local options in specific
259situations. You don't really need to know all of this, since Vim mostly uses
260the option values you would expect. Unfortunately, doing what the user
261expects is a bit complicated...
262
263When splitting a window, the local options are copied to the new window. Thus
264right after the split the contents of the two windows look the same.
265
266When editing a new buffer, its local option values must be initialized. Since
267the local options of the current buffer might be specifically for that buffer,
268these are not used. Instead, for each buffer-local option there also is a
269global value, which is used for new buffers. With ":set" both the local and
270global value is changed. With "setlocal" only the local value is changed,
271thus this value is not used when editing a new buffer.
272
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200273When editing a buffer that has been edited before, the options from the window
274that was last closed are used again. If this buffer has been edited in this
275window, the values from back then are used. Otherwise the values from the
276last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278It's possible to set a local window option specifically for a type of buffer.
279When you edit another buffer in the same window, you don't want to keep
280using these local window options. Therefore Vim keeps a global value of the
281local window options, which is used when editing another buffer. Each window
282has its own copy of these values. Thus these are local to the window, but
283global to all buffers in the window. With this you can do: >
284 :e one
285 :set list
286 :e two
287Now the 'list' option will also be set in "two", since with the ":set list"
288command you have also set the global value. >
289 :set nolist
290 :e one
291 :setlocal list
292 :e two
293Now the 'list' option is not set, because ":set nolist" resets the global
294value, ":setlocal list" only changes the local value and ":e two" gets the
295global value. Note that if you do this next: >
296 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200297You will get back the 'list' value as it was the last time you edited "one".
298The options local to a window are remembered for each buffer. This also
299happens when the buffer is not loaded, but they are lost when the buffer is
300wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100303:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 current buffer or window. Not all options have a
305 local value. If the option does not have a local
306 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200307 With the "all" argument: display local values for all
308 local options.
309 Without argument: Display local values for all local
310 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312 local value. For a global/local boolean option, when
313 the global value is being used, "--" is displayed
314 before the option name.
315 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318:setl[ocal] {option}< Set the local value of {option} to its global value by
319 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100321:se[t] {option}< For |global-local| options: Remove the local value of
322 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100325:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 option without changing the local value.
327 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200328 With the "all" argument: display global values for all
329 local options.
330 Without argument: display global values for all local
331 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333For buffer-local and window-local options:
334 Command global value local value ~
335 :set option=value set set
336 :setlocal option=value - set
337:setglobal option=value set -
338 :set option? - display
339 :setlocal option? - display
340:setglobal option? display -
341
342
343Global options with a local value *global-local*
344
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000345Options are global when you mostly use one value for all buffers and windows.
346For some global options it's useful to sometimes have a different local value.
347You can set the local value with ":setlocal". That buffer or window will then
348use the local value, while other buffers and windows continue using the global
349value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351For example, you have two windows, both on C source code. They use the global
352'makeprg' option. If you do this in one of the two windows: >
353 :set makeprg=gmake
354then the other window will switch to the same value. There is no need to set
355the 'makeprg' option in the other C source window too.
356However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000357another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000358files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal makeprg=perlmake
360You can switch back to using the global value by making the local value empty: >
361 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100362This only works for a string option. For a number or boolean option you need
363to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100365Note that for non-boolean and non-number options using "<" copies the global
366value to the local value, it doesn't switch back to using the global value
367(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368 :set path<
369This will make the local value of 'path' empty, so that the global value is
370used. Thus it does the same as: >
371 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000372Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373":setlocal" on a global option might work differently then.
374
375
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000376 *option-value-function*
377Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000378'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000379a function name or a function reference or a lambda function. When using a
380lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000381>
382 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000383 set opfunc=function('MyOpFunc')
384 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000385 set opfunc={a\ ->\ MyOpFunc(a)}
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`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000880 `: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
Bram Moolenaar47003982021-12-05 21:54:04 +0000882 to another file.
883 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000884 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()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001232< Otherwise, the expression is evaluated in the context of the script
1233 where the option was set, thus script-local items are available.
1234
Bram Moolenaar30b65812012-07-12 22:01:11 +02001235 The expression will be evaluated in the |sandbox| when set from a
1236 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001237 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001238
1239 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001240 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001241
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001242 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001243 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001244< When they are supported "\n" characters will start a new line. If the
1245 expression evaluates to a |List| this is equal to using each List item
1246 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001247 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001248
Bram Moolenaar165bc692015-07-21 17:53:25 +02001249 *'belloff'* *'bo'*
1250'belloff' 'bo' string (default "")
1251 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001252 Specifies for which events the bell will not be rung. It is a comma
1253 separated list of items. For each item that is present, the bell
1254 will be silenced. This is most useful to specify specific events in
1255 insert mode to be silenced.
1256
1257 item meaning when present ~
1258 all All events.
1259 backspace When hitting <BS> or <Del> and deleting results in an
1260 error.
1261 cursor Fail to move around using the cursor keys or
1262 <PageUp>/<PageDown> in |Insert-mode|.
1263 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1264 |i_CTRL-X_CTRL-T|.
1265 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1266 |i_CTRL-E|.
1267 ctrlg Unknown Char after <C-G> in Insert mode.
1268 error Other Error occurred (e.g. try to join last line)
1269 (mostly used in |Normal-mode| or |Cmdline-mode|).
1270 esc hitting <Esc> in |Normal-mode|.
1271 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001272 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001273 insertmode Pressing <Esc> in 'insertmode'.
1274 lang Calling the beep module for Lua/Mzscheme/TCL.
1275 mess No output available for |g<|.
1276 showmatch Error occurred for 'showmatch' function.
1277 operator Empty region error |cpo-E|.
1278 register Unknown register after <C-R> in |Insert-mode|.
1279 shell Bell from shell output |:!|.
1280 spell Error happened on spell suggest.
1281 wildmode More matches in |cmdline-completion| available
1282 (depends on the 'wildmode' setting).
1283
Bram Moolenaar036986f2017-03-16 17:41:02 +01001284 This is most useful to fine tune when in Insert mode the bell should
1285 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001286 indicate that an error occurred. It can be silenced by adding the
1287 "error" keyword.
1288
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1290'binary' 'bin' boolean (default off)
1291 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 This option should be set before editing a binary file. You can also
1293 use the |-b| Vim argument. When this option is switched on a few
1294 options will be changed (also when it already was on):
1295 'textwidth' will be set to 0
1296 'wrapmargin' will be set to 0
1297 'modeline' will be off
1298 'expandtab' will be off
1299 Also, 'fileformat' and 'fileformats' options will not be used, the
1300 file is read and written like 'fileformat' was "unix" (a single <NL>
1301 separates lines).
1302 The 'fileencoding' and 'fileencodings' options will not be used, the
1303 file is read without conversion.
1304 NOTE: When you start editing a(nother) file while the 'bin' option is
1305 on, settings from autocommands may change the settings again (e.g.,
1306 'textwidth'), causing trouble when editing. You might want to set
1307 'bin' again when the file has been loaded.
1308 The previous values of these options are remembered and restored when
1309 'bin' is switched from on to off. Each buffer has its own set of
1310 saved option values.
1311 To edit a file with 'binary' set you can use the |++bin| argument.
1312 This avoids you have to do ":set bin", which would have effect for all
1313 files you edit.
1314 When writing a file the <EOL> for the last line is only written if
1315 there was one in the original file (normally Vim appends an <EOL> to
1316 the last line if there is none; this would make the file longer). See
1317 the 'endofline' option.
1318
1319 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1320'bioskey' 'biosk' boolean (default on)
1321 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001322 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001323 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324
1325 *'bomb'* *'nobomb'*
1326'bomb' boolean (default off)
1327 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 When writing a file and the following conditions are met, a BOM (Byte
1329 Order Mark) is prepended to the file:
1330 - this option is on
1331 - the 'binary' option is off
1332 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1333 endian variants.
1334 Some applications use the BOM to recognize the encoding of the file.
1335 Often used for UCS-2 files on MS-Windows. For other applications it
1336 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001337 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1339 check for the presence of the BOM is done and 'bomb' set accordingly.
1340 Unless 'binary' is set, it is removed from the first line, so that you
1341 don't see it when editing. When you don't change the options, the BOM
1342 will be restored when writing the file.
1343
1344 *'breakat'* *'brk'*
1345'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1346 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001347 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 feature}
1349 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001350 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1351 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001353 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001354'breakindent' 'bri' boolean (default off)
1355 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001356 {not available when compiled without the |+linebreak|
1357 feature}
1358 Every wrapped line will continue visually indented (same amount of
1359 space as the beginning of that line), thus preserving horizontal blocks
1360 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001361 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001362
1363 *'breakindentopt'* *'briopt'*
1364'breakindentopt' 'briopt' string (default empty)
1365 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001366 {not available when compiled without the |+linebreak|
1367 feature}
1368 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001369 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001370 min:{n} Minimum text width that will be kept after
1371 applying 'breakindent', even if the resulting
1372 text should normally be narrower. This prevents
1373 text indented almost to the right window border
1374 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001375 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001376 shift:{n} After applying 'breakindent', the wrapped line's
1377 beginning will be shifted by the given number of
1378 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001379 indentation (negative) or emphasizing the line
1380 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001381 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001382 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001383 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001384 numbered or bulleted list (using the
1385 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001386 list:-1 Uses the length of a match with 'formatlistpat'
1387 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001388 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001389
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001391'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001393 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001395 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001396 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 buffer Use the directory of the related buffer.
1398 current Use the current directory.
1399 {path} Use the specified directory
1400
1401 *'bufhidden'* *'bh'*
1402'bufhidden' 'bh' string (default: "")
1403 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 This option specifies what happens when a buffer is no longer
1405 displayed in a window:
1406 <empty> follow the global 'hidden' option
1407 hide hide the buffer (don't unload it), also when 'hidden'
1408 is not set
1409 unload unload the buffer, also when 'hidden' is set or using
1410 |:hide|
1411 delete delete the buffer from the buffer list, also when
1412 'hidden' is set or using |:hide|, like using
1413 |:bdelete|
1414 wipe wipe out the buffer from the buffer list, also when
1415 'hidden' is set or using |:hide|, like using
1416 |:bwipeout|
1417
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001418 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001419 are lost without a warning. Also, these values may break autocommands
1420 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421 This option is used together with 'buftype' and 'swapfile' to specify
1422 special kinds of buffers. See |special-buffers|.
1423
1424 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1425'buflisted' 'bl' boolean (default: on)
1426 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427 When this option is set, the buffer shows up in the buffer list. If
1428 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1429 This option is reset by Vim for buffers that are only used to remember
1430 a file name or marks. Vim sets it when starting to edit a buffer.
1431 But not when moving to a buffer with ":buffer".
1432
1433 *'buftype'* *'bt'* *E382*
1434'buftype' 'bt' string (default: "")
1435 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 The value of this option specifies the type of a buffer:
1437 <empty> normal buffer
1438 nofile buffer which is not related to a file and will not be
1439 written
1440 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001441 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001442 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001444 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 help help buffer (you are not supposed to set this
1446 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001447 terminal buffer for a |terminal| (you are not supposed to set
1448 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001449 prompt buffer where only the last line can be edited, meant
1450 to be used by a plugin, see |prompt-buffer|
1451 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001452 popup buffer used in a popup window, see |popup|.
1453 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 This option is used together with 'bufhidden' and 'swapfile' to
1456 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001457 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458
1459 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001460 One such effect is that Vim will not check the timestamp of the file,
1461 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462
Bram Moolenaar280f1262006-01-30 00:14:18 +00001463 A "quickfix" buffer is only used for the error list and the location
1464 list. This value is set by the |:cwindow| and |:lwindow| commands and
1465 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466
1467 "nofile" and "nowrite" buffers are similar:
1468 both: The buffer is not to be written to disk, ":w" doesn't
1469 work (":w filename" does work though).
1470 both: The buffer is never considered to be |'modified'|.
1471 There is no warning when the changes will be lost, for
1472 example when you quit Vim.
1473 both: A swap file is only created when using too much memory
1474 (when 'swapfile' has been reset there is never a swap
1475 file).
1476 nofile only: The buffer name is fixed, it is not handled like a
1477 file name. It is not modified in response to a |:cd|
1478 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001479 both: When using ":e bufname" and already editing "bufname"
1480 the buffer is made empty and autocommands are
1481 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001482 *E676*
1483 "acwrite" implies that the buffer name is not related to a file, like
1484 "nofile", but it will be written. Thus, in contrast to "nofile" and
1485 "nowrite", ":w" does work and a modified buffer can't be abandoned
1486 without saving. For writing there must be matching |BufWriteCmd|,
1487 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488
1489 *'casemap'* *'cmp'*
1490'casemap' 'cmp' string (default: "internal,keepascii")
1491 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 Specifies details about changing the case of letters. It may contain
1493 these words, separated by a comma:
1494 internal Use internal case mapping functions, the current
1495 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001496 matters when 'encoding' is a Unicode encoding,
1497 "latin1" or "iso-8859-15". When "internal" is
1498 omitted, the towupper() and towlower() system library
1499 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1501 case mapping, the current locale is not effective.
1502 This probably only matters for Turkish.
1503
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001504 *'cdhome'* *'cdh'*
1505'cdhome' 'cdh' boolean (default: off)
1506 global
1507 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1508 current working directory to the |$HOME| directory like in Unix.
1509 When off, those commands just print the current directory name.
1510 On Unix this option has no effect.
1511 NOTE: This option is reset when 'compatible' is set.
1512
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 *'cdpath'* *'cd'* *E344* *E346*
1514'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1515 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 {not available when compiled without the
1517 |+file_in_path| feature}
1518 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001519 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1520 searched for has a relative path, not an absolute part starting with
1521 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 The 'cdpath' option's value has the same form and semantics as
1523 |'path'|. Also see |file-searching|.
1524 The default value is taken from $CDPATH, with a "," prepended to look
1525 in the current directory first.
1526 If the default value taken from $CDPATH is not what you want, include
1527 a modified version of the following command in your vimrc file to
1528 override it: >
1529 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1530< This option cannot be set from a |modeline| or in the |sandbox|, for
1531 security reasons.
1532 (parts of 'cdpath' can be passed to the shell to expand file names).
1533
1534 *'cedit'*
1535'cedit' string (Vi default: "", Vim default: CTRL-F)
1536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 The key used in Command-line Mode to open the command-line window.
1538 The default is CTRL-F when 'compatible' is off.
1539 Only non-printable keys are allowed.
1540 The key can be specified as a single character, but it is difficult to
1541 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001542 :exe "set cedit=\<C-Y>"
1543 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544< |Nvi| also has this option, but it only uses the first character.
1545 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001546 NOTE: This option is set to the Vim default value when 'compatible'
1547 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548
1549 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1550'charconvert' 'ccv' string (default "")
1551 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001552 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 An expression that is used for character encoding conversion. It is
1554 evaluated when a file that is to be read or has been written has a
1555 different encoding from what is desired.
1556 'charconvert' is not used when the internal iconv() function is
1557 supported and is able to do the conversion. Using iconv() is
1558 preferred, because it is much faster.
1559 'charconvert' is not used when reading stdin |--|, because there is no
1560 file to convert from. You will have to save the text in a file first.
1561 The expression must return zero or an empty string for success,
1562 non-zero for failure.
1563 The possible encoding names encountered are in 'encoding'.
1564 Additionally, names given in 'fileencodings' and 'fileencoding' are
1565 used.
1566 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1567 is done internally by Vim, 'charconvert' is not used for this.
1568 'charconvert' is also used to convert the viminfo file, if the 'c'
1569 flag is present in 'viminfo'. Also used for Unicode conversion.
1570 Example: >
1571 set charconvert=CharConvert()
1572 fun CharConvert()
1573 system("recode "
1574 \ . v:charconvert_from . ".." . v:charconvert_to
1575 \ . " <" . v:fname_in . " >" v:fname_out)
1576 return v:shell_error
1577 endfun
1578< The related Vim variables are:
1579 v:charconvert_from name of the current encoding
1580 v:charconvert_to name of the desired encoding
1581 v:fname_in name of the input file
1582 v:fname_out name of the output file
1583 Note that v:fname_in and v:fname_out will never be the same.
1584 Note that v:charconvert_from and v:charconvert_to may be different
1585 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1586 Encryption is not done by Vim when using 'charconvert'. If you want
1587 to encrypt the file after conversion, 'charconvert' should take care
1588 of this.
1589 This option cannot be set from a |modeline| or in the |sandbox|, for
1590 security reasons.
1591
1592 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1593'cindent' 'cin' boolean (default off)
1594 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 {not available when compiled without the |+cindent|
1596 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001597 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598 that trigger reindenting in insert mode and 'cinoptions' to set your
1599 preferred indent style.
1600 If 'indentexpr' is not empty, it overrules 'cindent'.
1601 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1602 the "=" operator indents using this algorithm rather than calling an
1603 external program.
1604 See |C-indenting|.
1605 When you don't like the way 'cindent' works, try the 'smartindent'
1606 option or 'indentexpr'.
1607 This option is not used when 'paste' is set.
1608 NOTE: This option is reset when 'compatible' is set.
1609
1610 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001611'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 {not available when compiled without the |+cindent|
1614 feature}
1615 A list of keys that, when typed in Insert mode, cause reindenting of
1616 the current line. Only used if 'cindent' is on and 'indentexpr' is
1617 empty.
1618 For the format of this option see |cinkeys-format|.
1619 See |C-indenting|.
1620
1621 *'cinoptions'* *'cino'*
1622'cinoptions' 'cino' string (default "")
1623 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 {not available when compiled without the |+cindent|
1625 feature}
1626 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1627 program. See |cinoptions-values| for the values of this option, and
1628 |C-indenting| for info on C indenting in general.
1629
1630
1631 *'cinwords'* *'cinw'*
1632'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1633 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 {not available when compiled without both the
1635 |+cindent| and the |+smartindent| features}
1636 These keywords start an extra indent in the next line when
1637 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1638 an appropriate place (inside {}).
1639 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1640 matter, include the keyword both the uppercase and lowercase:
1641 "if,If,IF".
1642
1643 *'clipboard'* *'cb'*
1644'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1645 for X-windows, "" otherwise)
1646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 {only in GUI versions or when the |+xterm_clipboard|
1648 feature is included}
1649 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001650 Note: if one of the items is "exclude:", then you can't add an item
1651 after that. Therefore do append an item with += but use ^= to
1652 prepend, e.g.: >
1653 set clipboard^=unnamed
1654< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001656 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 unnamed When included, Vim will use the clipboard register '*'
1658 for all yank, delete, change and put operations which
1659 would normally go to the unnamed register. When a
1660 register is explicitly specified, it will always be
1661 used regardless of whether "unnamed" is in 'clipboard'
1662 or not. The clipboard register can always be
1663 explicitly accessed using the "* notation. Also see
1664 |gui-clipboard|.
1665
Bram Moolenaar30b65812012-07-12 22:01:11 +02001666 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001667 unnamedplus A variant of the "unnamed" flag which uses the
1668 clipboard register '+' (|quoteplus|) instead of
1669 register '*' for all yank, delete, change and put
1670 operations which would normally go to the unnamed
1671 register. When "unnamed" is also included to the
1672 option, yank operations (but not delete, change or
1673 put) will additionally copy the text into register
1674 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001675 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001676 Availability can be checked with: >
1677 if has('unnamedplus')
1678<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001679 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 autoselect Works like the 'a' flag in 'guioptions': If present,
1681 then whenever Visual mode is started, or the Visual
1682 area extended, Vim tries to become the owner of the
1683 windowing system's global selection or put the
1684 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001685 register "*. See |'go-a'| and |quotestar| for details.
1686 When the GUI is active, the 'a' flag in 'guioptions'
1687 is used, when the GUI is not active, this "autoselect"
1688 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 Also applies to the modeless selection.
1690
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001691 *clipboard-autoselectplus*
1692 autoselectplus Like "autoselect" but using the + register instead of
1693 the * register. Compare to the 'P' flag in
1694 'guioptions'.
1695
1696 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 autoselectml Like "autoselect", but for the modeless selection
1698 only. Compare to the 'A' flag in 'guioptions'.
1699
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001700 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001701 html When the clipboard contains HTML, use this when
1702 pasting. When putting text on the clipboard, mark it
1703 as HTML. This works to copy rendered HTML from
1704 Firefox, paste it as raw HTML in Vim, select the HTML
1705 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001706 You probably want to add this only temporarily,
1707 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001708 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001709
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001710 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 exclude:{pattern}
1712 Defines a pattern that is matched against the name of
1713 the terminal 'term'. If there is a match, no
1714 connection will be made to the X server. This is
1715 useful in this situation:
1716 - Running Vim in a console.
1717 - $DISPLAY is set to start applications on another
1718 display.
1719 - You do not want to connect to the X server in the
1720 console, but do want this in a terminal emulator.
1721 To never connect to the X server use: >
1722 exclude:.*
1723< This has the same effect as using the |-X| argument.
1724 Note that when there is no connection to the X server
1725 the window title won't be restored and the clipboard
1726 cannot be accessed.
1727 The value of 'magic' is ignored, {pattern} is
1728 interpreted as if 'magic' was on.
1729 The rest of the option value will be used for
1730 {pattern}, this must be the last entry.
1731
1732 *'cmdheight'* *'ch'*
1733'cmdheight' 'ch' number (default 1)
1734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 Number of screen lines to use for the command-line. Helps avoiding
1736 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001737 The value of this option is stored with the tab page, so that each tab
1738 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739
1740 *'cmdwinheight'* *'cwh'*
1741'cmdwinheight' 'cwh' number (default 7)
1742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 Number of screen lines to use for the command-line window. |cmdwin|
1744
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001745 *'colorcolumn'* *'cc'*
1746'colorcolumn' 'cc' string (default "")
1747 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001748 {not available when compiled without the |+syntax|
1749 feature}
1750 'colorcolumn' is a comma separated list of screen columns that are
1751 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1752 text. Will make screen redrawing slower.
1753 The screen column can be an absolute number, or a number preceded with
1754 '+' or '-', which is added to or subtracted from 'textwidth'. >
1755
1756 :set cc=+1 " highlight column after 'textwidth'
1757 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1758 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1759<
1760 When 'textwidth' is zero then the items with '-' and '+' are not used.
1761 A maximum of 256 columns are highlighted.
1762
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 *'columns'* *'co'* *E594*
1764'columns' 'co' number (default 80 or terminal width)
1765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001767 initialization and does not have to be set by hand. Also see
1768 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 When Vim is running in the GUI or in a resizable window, setting this
1770 option will cause the window size to be changed. When you only want
1771 to use the size for the GUI, put the command in your |gvimrc| file.
1772 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001773 number of columns of the display, the display may be messed up. For
1774 the GUI it is always possible and Vim limits the number of columns to
1775 what fits on the screen. You can use this command to get the widest
1776 window possible: >
1777 :set columns=9999
1778< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779
1780 *'comments'* *'com'* *E524* *E525*
1781'comments' 'com' string (default
1782 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1783 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 A comma separated list of strings that can start a comment line. See
1785 |format-comments|. See |option-backslash| about using backslashes to
1786 insert a space.
1787
1788 *'commentstring'* *'cms'* *E537*
1789'commentstring' 'cms' string (default "/*%s*/")
1790 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 {not available when compiled without the |+folding|
1792 feature}
1793 A template for a comment. The "%s" in the value is replaced with the
1794 comment text. Currently only used to add markers for folding, see
1795 |fold-marker|.
1796
1797 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001798'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001799 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 This option has the effect of making Vim either more Vi-compatible, or
1802 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001803
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001805 other options are also changed as a side effect.
1806 NOTE: Setting or resetting this option can have a lot of unexpected
1807 effects: Mappings are interpreted in another way, undo behaves
1808 differently, etc. If you set this option in your vimrc file, you
1809 should probably put it at the very start.
1810
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 By default this option is on and the Vi defaults are used for the
1812 options. This default was chosen for those people who want to use Vim
1813 just like Vi, and don't even (want to) know about the 'compatible'
1814 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001815 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001816 this option is switched off, and all options that have not been
1817 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001818 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001819 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001820 happen for the system-wide vimrc or gvimrc file, nor for a file given
1821 with the |-u| argument). Also see |compatible-default| and
1822 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 You can also set this option with the "-C" argument, and reset it with
1824 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001825 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826
Bram Moolenaar214641f2017-03-05 17:04:09 +01001827 When this option is set, numerous other options are set to make Vim as
1828 Vi-compatible as possible. When this option is unset, various options
1829 are set to make Vim more useful. The table below lists all the
1830 options affected.
1831 The {?} column indicates when the options are affected:
1832 + Means that the option is set to the value given in {set value} when
1833 'compatible' is set.
1834 & Means that the option is set to the value given in {set value} when
1835 'compatible' is set AND is set to its Vim default value when
1836 'compatible' is unset.
1837 - Means the option is NOT changed when setting 'compatible' but IS
1838 set to its Vim default when 'compatible' is unset.
1839 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840
Bram Moolenaar036986f2017-03-16 17:41:02 +01001841 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001842
1843 'allowrevins' + off no CTRL-_ command
1844 'antialias' + off don't use antialiased fonts
1845 'arabic' + off reset arabic-related options
1846 'arabicshape' + on correct character shapes
1847 'backspace' + "" normal backspace
1848 'backup' + off no backup file
1849 'backupcopy' & Unix: "yes" backup file is a copy
1850 else: "auto" copy or rename backup file
1851 'balloonexpr' + "" text to show in evaluation balloon
1852 'breakindent' + off don't indent when wrapping lines
1853 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001854 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001855 'cindent' + off no C code indentation
1856 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1857 'copyindent' + off don't copy indent structure
1858 'cpoptions' & (all flags) Vi-compatible flags
1859 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001860 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001861 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001862 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001863 'cscopeverbose' + off see |cscopeverbose|
1864 'delcombine' + off unicode: delete whole char combination
1865 'digraph' + off no digraphs
1866 'esckeys' & off no <Esc>-keys in Insert mode
1867 'expandtab' + off tabs not expanded to spaces
1868 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001869 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001870 'formatexpr' + "" use 'formatprg' for auto-formatting
1871 'formatoptions' & "vt" Vi compatible formatting
1872 'gdefault' + off no default 'g' flag for ":s"
1873 'history' & 0 no commandline history
1874 'hkmap' + off no Hebrew keyboard mapping
1875 'hkmapp' + off no phonetic Hebrew keyboard mapping
1876 'hlsearch' + off no highlighting of search matches
1877 'incsearch' + off no incremental searching
1878 'indentexpr' + "" no indenting by expression
1879 'insertmode' + off do not start in Insert mode
1880 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001882 'joinspaces' + on insert 2 spaces after period
1883 'modeline' & off no modelines
1884 'more' & off no pauses in listings
1885 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1886 'numberwidth' & 8 min number of columns for line number
1887 'preserveindent'+ off don't preserve current indent structure
1888 when changing it
1889 'revins' + off no reverse insert
1890 'ruler' + off no ruler
1891 'scrolljump' + 1 no jump scroll
1892 'scrolloff' + 0 no scroll offset
1893 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1894 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001895 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001896 'showcmd' & off command characters not shown
1897 'showmode' & off current mode not shown
1898 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1899 'smartcase' + off no automatic ignore case switch
1900 'smartindent' + off no smart indentation
1901 'smarttab' + off no smart tab size
1902 'softtabstop' + 0 tabs are always 'tabstop' positions
1903 'startofline' + on goto startofline with some commands
1904 'tagcase' & "followic" 'ignorecase' when searching tags file
1905 'tagrelative' & off tag file names are not relative
1906 'termguicolors' + off don't use highlight-(guifg|guibg)
1907 'textauto' & off no automatic textmode detection
1908 'textwidth' + 0 no automatic line wrap
1909 'tildeop' + off tilde is not an operator
1910 'ttimeout' + off no terminal timeout
1911 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001912 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001913 'virtualedit' + "" cursor can only be placed on characters
1914 'whichwrap' & "" left-right movements don't wrap
1915 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001917 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918
1919 *'complete'* *'cpt'* *E535*
1920'complete' 'cpt' string (default: ".,w,b,u,t,i")
1921 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922 This option specifies how keyword completion |ins-completion| works
1923 when CTRL-P or CTRL-N are used. It is also used for whole-line
1924 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1925 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001926 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 w scan buffers from other windows
1928 b scan other loaded buffers that are in the buffer list
1929 u scan the unloaded buffers that are in the buffer list
1930 U scan the buffers that are not in the buffer list
1931 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001932 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 k{dict} scan the file {dict}. Several "k" flags can be given,
1934 patterns are valid too. For example: >
1935 :set cpt=k/usr/dict/*,k~/spanish
1936< s scan the files given with the 'thesaurus' option
1937 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1938 are valid too.
1939 i scan current and included files
1940 d scan current and included files for defined name or macro
1941 |i_CTRL-X_CTRL-D|
1942 ] tag completion
1943 t same as "]"
1944
1945 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1946 not executed, this may lead to unexpected completions from some files
1947 (gzipped files for example). Unloaded buffers are not scanned for
1948 whole-line completion.
1949
1950 The default is ".,w,b,u,t,i", which means to scan:
1951 1. the current buffer
1952 2. buffers in other windows
1953 3. other loaded buffers
1954 4. unloaded buffers
1955 5. tags
1956 6. included files
1957
1958 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001959 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1960 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001962 *'completefunc'* *'cfu'*
1963'completefunc' 'cfu' string (default: empty)
1964 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001965 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001966 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001967 This option specifies a function to be used for Insert mode completion
1968 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001969 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001970 invoked and what it should return. The value can be the name of a
1971 function, a |lambda| or a |Funcref|. See |option-value-function| for
1972 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001973 This option cannot be set from a |modeline| or in the |sandbox|, for
1974 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001975
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001976 *'completeslash'* *'csl'*
1977'completeslash' 'csl' string (default: "")
1978 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001979 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001980 When this option is set it overrules 'shellslash' for completion:
1981 - When this option is set to "slash", a forward slash is used for path
1982 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001983 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001984 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001985 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001986 - When this option is empty, same character is used as for
1987 'shellslash'.
1988 For Insert mode completion the buffer-local value is used. For
1989 command line completion the global value is used.
1990
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001991 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001992'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001993 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001994 A comma separated list of options for Insert mode completion
1995 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001996
1997 menu Use a popup menu to show the possible completions. The
1998 menu is only shown when there is more than one match and
1999 sufficient colors are available. |ins-completion-menu|
2000
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002001 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002002 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002003 match, e.g., what file it comes from.
2004
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002005 longest Only insert the longest common text of the matches. If
2006 the menu is displayed you can use CTRL-L to add more
2007 characters. Whether case is ignored depends on the kind
2008 of completion. For buffer text the 'ignorecase' option is
2009 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002010
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002011 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002012 completion in the preview window. Only works in
2013 combination with "menu" or "menuone".
2014
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002015 popup Show extra information about the currently selected
2016 completion in a popup window. Only works in combination
2017 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002018 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002019 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002020
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002021 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002022 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002023 |CompleteChanged| autocommand to fetch the info and call
2024 |popup_show()| once the popup has been filled.
2025 See the example at |complete-popuphidden|.
2026 {only works when compiled with the |+textprop| feature}
2027
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002028 noinsert Do not insert any text for a match until the user selects
2029 a match from the menu. Only works in combination with
2030 "menu" or "menuone". No effect if "longest" is present.
2031
2032 noselect Do not select a match in the menu, force the user to
2033 select one from the menu. Only works in combination with
2034 "menu" or "menuone".
2035
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002036
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002037 *'completepopup'* *'cpp'*
2038'completepopup' 'cpp' string (default empty)
2039 global
2040 {not available when compiled without the |+textprop|
2041 or |+quickfix| feature}
2042 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002043 properties of the info popup when it is created. If an info popup
2044 window already exists it is closed, so that the option value is
2045 applied when it is created again.
2046 You can also use |popup_findinfo()| and then set properties for an
2047 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002048
2049
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002050 *'concealcursor'* *'cocu'*
2051'concealcursor' 'cocu' string (default: "")
2052 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002053 {not available when compiled without the |+conceal|
2054 feature}
2055 Sets the modes in which text in the cursor line can also be concealed.
2056 When the current mode is listed then concealing happens just like in
2057 other lines.
2058 n Normal mode
2059 v Visual mode
2060 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002061 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002062
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002063 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002064 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002065 are moving around text is concealed, but when starting to insert text
2066 or selecting a Visual area the concealed text is displayed, so that
2067 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002068 Keep in mind that the cursor position is not always where it's
2069 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002070
2071
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002072 *'conceallevel'* *'cole'*
2073'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002074 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002075 {not available when compiled without the |+conceal|
2076 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002077 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2078 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002079
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002080 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002081 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002082 1 Each block of concealed text is replaced with one
2083 character. If the syntax item does not have a custom
2084 replacement character defined (see |:syn-cchar|) the
2085 character defined in 'listchars' is used (default is a
2086 space).
2087 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002088 2 Concealed text is completely hidden unless it has a
2089 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002090 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002091 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002092
Bram Moolenaara7781e02010-07-19 20:13:22 +02002093 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002094 edit and copy the text. This can be changed with the 'concealcursor'
2095 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002096
Bram Moolenaar071d4272004-06-13 20:20:40 +00002097 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2098'confirm' 'cf' boolean (default off)
2099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 When 'confirm' is on, certain operations that would normally
2101 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2102 instead raise a |dialog| asking if you wish to save the current
2103 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2104 If 'confirm' is off you can still activate confirmation for one
2105 command only (this is most useful in mappings) with the |:confirm|
2106 command.
2107 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2108
2109 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2110'conskey' 'consk' boolean (default off)
2111 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002112 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113
2114 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2115'copyindent' 'ci' boolean (default off)
2116 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 Copy the structure of the existing lines indent when autoindenting a
2118 new line. Normally the new indent is reconstructed by a series of
2119 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2120 in which case only spaces are used). Enabling this option makes the
2121 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002122 existing line. 'expandtab' has no effect on these characters, a Tab
2123 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002125 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 Also see 'preserveindent'.
2127
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002128 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129'cpoptions' 'cpo' string (Vim default: "aABceFs",
2130 Vi default: all flags)
2131 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002133 this indicates Vi-compatible behavior. This is used for things where
2134 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 'cpoptions' stands for "compatible-options".
2136 Commas can be added for readability.
2137 To avoid problems with flags that are added in the future, use the
2138 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002139
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 NOTE: This option is set to the Vi default value when 'compatible' is
2141 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002142
2143 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2144 is saved, 'cpoptions' is set to the Vim default, and the saved value
2145 is restored at the end of the script. Changes to the value of
2146 'cpoptions' will be applied to the saved value, but keep in mind that
2147 removing a flag that is not present when 'cpoptions' is changed has no
2148 effect. In the |.vimrc| file the value is not restored, thus using
2149 `vim9script` in the |.vimrc| file results in using the Vim default.
2150
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002151 NOTE: This option is set to the POSIX default value at startup when
2152 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002153 variable exists |posix|. This means Vim tries to behave like the
2154 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155
2156 contains behavior ~
2157 *cpo-a*
2158 a When included, a ":read" command with a file name
2159 argument will set the alternate file name for the
2160 current window.
2161 *cpo-A*
2162 A When included, a ":write" command with a file name
2163 argument will set the alternate file name for the
2164 current window.
2165 *cpo-b*
2166 b "\|" in a ":map" command is recognized as the end of
2167 the map command. The '\' is included in the mapping,
2168 the text after the '|' is interpreted as the next
2169 command. Use a CTRL-V instead of a backslash to
2170 include the '|' in the mapping. Applies to all
2171 mapping, abbreviation, menu and autocmd commands.
2172 See also |map_bar|.
2173 *cpo-B*
2174 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002175 abbreviations, user commands and the "to" part of the
2176 menu commands. Remove this flag to be able to use a
2177 backslash like a CTRL-V. For example, the command
2178 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 'B' included: "\^[" (^[ is a real <Esc>)
2180 'B' excluded: "<Esc>" (5 characters)
2181 ('<' excluded in both cases)
2182 *cpo-c*
2183 c Searching continues at the end of any match at the
2184 cursor position, but not further than the start of the
2185 next line. When not present searching continues
2186 one character from the cursor position. With 'c'
2187 "abababababab" only gets three matches when repeating
2188 "/abab", without 'c' there are five matches.
2189 *cpo-C*
2190 C Do not concatenate sourced lines that start with a
2191 backslash. See |line-continuation|.
2192 *cpo-d*
2193 d Using "./" in the 'tags' option doesn't mean to use
2194 the tags file relative to the current file, but the
2195 tags file in the current directory.
2196 *cpo-D*
2197 D Can't use CTRL-K to enter a digraph after Normal mode
2198 commands with a character argument, like |r|, |f| and
2199 |t|.
2200 *cpo-e*
2201 e When executing a register with ":@r", always add a
2202 <CR> to the last line, also when the register is not
2203 linewise. If this flag is not present, the register
2204 is not linewise and the last line does not end in a
2205 <CR>, then the last line is put on the command-line
2206 and can be edited before hitting <CR>.
2207 *cpo-E*
2208 E It is an error when using "y", "d", "c", "g~", "gu" or
2209 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002210 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 This makes "y0" fail in the first column.
2212 *cpo-f*
2213 f When included, a ":read" command with a file name
2214 argument will set the file name for the current buffer,
2215 if the current buffer doesn't have a file name yet.
2216 *cpo-F*
2217 F When included, a ":write" command with a file name
2218 argument will set the file name for the current
2219 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002220 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 *cpo-g*
2222 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002223 *cpo-H*
2224 H When using "I" on a line with only blanks, insert
2225 before the last blank. Without this flag insert after
2226 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 *cpo-i*
2228 i When included, interrupting the reading of a file will
2229 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002230 *cpo-I*
2231 I When moving the cursor up or down just after inserting
2232 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 *cpo-j*
2234 j When joining lines, only add two spaces after a '.',
2235 not after '!' or '?'. Also see 'joinspaces'.
2236 *cpo-J*
2237 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002238 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 white space.
2240 *cpo-k*
2241 k Disable the recognition of raw key codes in
2242 mappings, abbreviations, and the "to" part of menu
2243 commands. For example, if <Key> sends ^[OA (where ^[
2244 is <Esc>), the command ":map X ^[OA" results in X
2245 being mapped to:
2246 'k' included: "^[OA" (3 characters)
2247 'k' excluded: "<Key>" (one key code)
2248 Also see the '<' flag below.
2249 *cpo-K*
2250 K Don't wait for a key code to complete when it is
2251 halfway a mapping. This breaks mapping <F1><F1> when
2252 only part of the second <F1> has been read. It
2253 enables cancelling the mapping by typing <F1><Esc>.
2254 *cpo-l*
2255 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002256 literally, only "\]", "\^", "\-" and "\\" are special.
2257 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2259 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002260 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 *cpo-L*
2262 L When the 'list' option is set, 'wrapmargin',
2263 'textwidth', 'softtabstop' and Virtual Replace mode
2264 (see |gR|) count a <Tab> as two characters, instead of
2265 the normal behavior of a <Tab>.
2266 *cpo-m*
2267 m When included, a showmatch will always wait half a
2268 second. When not included, a showmatch will wait half
2269 a second or until a character is typed. |'showmatch'|
2270 *cpo-M*
2271 M When excluded, "%" matching will take backslashes into
2272 account. Thus in "( \( )" and "\( ( \)" the outer
2273 parenthesis match. When included "%" ignores
2274 backslashes, which is Vi compatible.
2275 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002276 n When included, the column used for 'number' and
2277 'relativenumber' will also be used for text of wrapped
2278 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 *cpo-o*
2280 o Line offset to search command is not remembered for
2281 next search.
2282 *cpo-O*
2283 O Don't complain if a file is being overwritten, even
2284 when it didn't exist when editing it. This is a
2285 protection against a file unexpectedly created by
2286 someone else. Vi didn't complain about this.
2287 *cpo-p*
2288 p Vi compatible Lisp indenting. When not present, a
2289 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002290 *cpo-P*
2291 P When included, a ":write" command that appends to a
2292 file will set the file name for the current buffer, if
2293 the current buffer doesn't have a file name yet and
2294 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002295 *cpo-q*
2296 q When joining multiple lines leave the cursor at the
2297 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 *cpo-r*
2299 r Redo ("." command) uses "/" to repeat a search
2300 command, instead of the actually used search string.
2301 *cpo-R*
2302 R Remove marks from filtered lines. Without this flag
2303 marks are kept like |:keepmarks| was used.
2304 *cpo-s*
2305 s Set buffer options when entering the buffer for the
2306 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002307 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308 set when the buffer is created.
2309 *cpo-S*
2310 S Set buffer options always when entering a buffer
2311 (except 'readonly', 'fileformat', 'filetype' and
2312 'syntax'). This is the (most) Vi compatible setting.
2313 The options are set to the values in the current
2314 buffer. When you change an option and go to another
2315 buffer, the value is copied. Effectively makes the
2316 buffer options global to all buffers.
2317
2318 's' 'S' copy buffer options
2319 no no when buffer created
2320 yes no when buffer first entered (default)
2321 X yes each time when buffer entered (vi comp.)
2322 *cpo-t*
2323 t Search pattern for the tag command is remembered for
2324 "n" command. Otherwise Vim only puts the pattern in
2325 the history for search pattern, but doesn't change the
2326 last used search pattern.
2327 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002328 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 *cpo-v*
2330 v Backspaced characters remain visible on the screen in
2331 Insert mode. Without this flag the characters are
2332 erased from the screen right away. With this flag the
2333 screen newly typed text overwrites backspaced
2334 characters.
2335 *cpo-w*
2336 w When using "cw" on a blank character, only change one
2337 character and not all blanks until the start of the
2338 next word.
2339 *cpo-W*
2340 W Don't overwrite a readonly file. When omitted, ":w!"
2341 overwrites a readonly file, if possible.
2342 *cpo-x*
2343 x <Esc> on the command-line executes the command-line.
2344 The default in Vim is to abandon the command-line,
2345 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002346 *cpo-X*
2347 X When using a count with "R" the replaced text is
2348 deleted only once. Also when repeating "R" with "."
2349 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002351 y A yank command can be redone with ".". Think twice if
2352 you really want to use this, it may break some
2353 plugins, since most people expect "." to only repeat a
2354 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002355 *cpo-Z*
2356 Z When using "w!" while the 'readonly' option is set,
2357 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 *cpo-!*
2359 ! When redoing a filter command, use the last used
2360 external command, whatever it was. Otherwise the last
2361 used -filter- command is used.
2362 *cpo-$*
2363 $ When making a change to one line, don't redisplay the
2364 line, but put a '$' at the end of the changed text.
2365 The changed text will be overwritten when you type the
2366 new text. The line is redisplayed if you type any
2367 command that moves the cursor from the insertion
2368 point.
2369 *cpo-%*
2370 % Vi-compatible matching is done for the "%" command.
2371 Does not recognize "#if", "#endif", etc.
2372 Does not recognize "/*" and "*/".
2373 Parens inside single and double quotes are also
2374 counted, causing a string that contains a paren to
2375 disturb the matching. For example, in a line like
2376 "if (strcmp("foo(", s))" the first paren does not
2377 match the last one. When this flag is not included,
2378 parens inside single and double quotes are treated
2379 specially. When matching a paren outside of quotes,
2380 everything inside quotes is ignored. When matching a
2381 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002382 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002383 This flag is also used for other features, such as
2384 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002385 *cpo--*
2386 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002387 it would go above the first line or below the last
2388 line. Without it the cursor moves to the first or
2389 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002390 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002391 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002392 *cpo-+*
2393 + When included, a ":write file" command will reset the
2394 'modified' flag of the buffer, even though the buffer
2395 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002396 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 * Use ":*" in the same way as ":@". When not included,
2398 ":*" is an alias for ":'<,'>", select the Visual area.
2399 *cpo-<*
2400 < Disable the recognition of special key codes in |<>|
2401 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002402 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 ":map X <Tab>" results in X being mapped to:
2404 '<' included: "<Tab>" (5 characters)
2405 '<' excluded: "^I" (^I is a real <Tab>)
2406 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002407 *cpo->*
2408 > When appending to a register, put a line break before
2409 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002410 *cpo-;*
2411 ; When using |,| or |;| to repeat the last |t| search
2412 and the cursor is right in front of the searched
2413 character, the cursor won't move. When not included,
2414 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002415 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002416
2417 POSIX flags. These are not included in the Vi default value, except
2418 when $VIM_POSIX was set on startup. |posix|
2419
2420 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002421 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002422 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002423 *cpo-&*
2424 & When ":preserve" was used keep the swap file when
2425 exiting normally while this buffer is still loaded.
2426 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002427 *cpo-\*
2428 \ Backslash in a [] range in a search pattern is taken
2429 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002430 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2431 '\' excluded: "/[ \-]" finds <Space> and '-'
2432 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002433 *cpo-/*
2434 / When "%" is used as the replacement string in a |:s|
2435 command, use the previous replacement string. |:s%|
2436 *cpo-{*
2437 { The |{| and |}| commands also stop at a "{" character
2438 at the start of a line.
2439 *cpo-.*
2440 . The ":chdir" and ":cd" commands fail if the current
2441 buffer is modified, unless ! is used. Vim doesn't
2442 need this, since it remembers the full path of an
2443 opened file.
2444 *cpo-bar*
2445 | The value of the $LINES and $COLUMNS environment
2446 variables overrule the terminal size values obtained
2447 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002448
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002450 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002451'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002452 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002453 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002454 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002455 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002456 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002457 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002458 blowfish Blowfish method. Medium strong encryption but it has
2459 an implementation flaw. Requires Vim 7.3 or later,
2460 files can NOT be read by Vim 7.2 and older. This adds
2461 a "seed" to the file, every time you write the file
2462 the encrypted bytes will be different.
2463 *blowfish2*
2464 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002465 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002466 and older. This adds a "seed" to the file, every time
2467 you write the file the encrypted bytes will be
2468 different. The whole undo file is encrypted, not just
2469 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002470 *E1193* *E1194* *E1195* *E1196*
2471 *E1197* *E1198* *E1199* *E1200* *E1201*
2472 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2473 Code. Medium strong till strong encryption.
2474 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002475 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002476 It adds a seed and a message authentication code (MAC)
2477 to the file. This needs at least a Vim 8.2.3022 to
2478 read the encrypted file.
2479 Encryption of swap files is not supported, therefore
2480 no swap file will be used when xchacha20 encryption is
2481 enabled.
2482 Encryption of undo files is not yet supported,
2483 therefore no undo file will currently be written.
2484 CURRENTLY EXPERIMENTAL: Files written with this method
2485 might have to be read back with the same version of
2486 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002487
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002488 You should use "blowfish2", also to re-encrypt older files.
2489
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002490 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002491 to the detected method of the file being read. Thus if you write it
2492 without changing 'cryptmethod' the same method will be used.
2493 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002494 explicitly write it, you don't get a warning unless there are other
2495 modifications. Also see |:X|.
2496
2497 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002498 the value "blowfish2". When setting the local value to an empty
2499 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002500
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002501 When a new encryption method is added in a later version of Vim, and
2502 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002503 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002504
2505
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 *'cscopepathcomp'* *'cspc'*
2507'cscopepathcomp' 'cspc' number (default 0)
2508 global
2509 {not available when compiled without the |+cscope|
2510 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 Determines how many components of the path to show in a list of tags.
2512 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002513 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514
2515 *'cscopeprg'* *'csprg'*
2516'cscopeprg' 'csprg' string (default "cscope")
2517 global
2518 {not available when compiled without the |+cscope|
2519 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 Specifies the command to execute cscope. See |cscopeprg|.
2521 This option cannot be set from a |modeline| or in the |sandbox|, for
2522 security reasons.
2523
2524 *'cscopequickfix'* *'csqf'*
2525'cscopequickfix' 'csqf' string (default "")
2526 global
2527 {not available when compiled without the |+cscope|
2528 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 Specifies whether to use quickfix window to show cscope results.
2530 See |cscopequickfix|.
2531
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002532 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002533'cscoperelative' 'csre' boolean (default off)
2534 global
2535 {not available when compiled without the |+cscope|
2536 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002537 In the absence of a prefix (-P) for cscope. setting this option enables
2538 to use the basename of cscope.out path as the prefix.
2539 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002540 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002541
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2543'cscopetag' 'cst' boolean (default off)
2544 global
2545 {not available when compiled without the |+cscope|
2546 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 Use cscope for tag commands. See |cscope-options|.
2548 NOTE: This option is reset when 'compatible' is set.
2549
2550 *'cscopetagorder'* *'csto'*
2551'cscopetagorder' 'csto' number (default 0)
2552 global
2553 {not available when compiled without the |+cscope|
2554 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 Determines the order in which ":cstag" performs a search. See
2556 |cscopetagorder|.
2557 NOTE: This option is set to 0 when 'compatible' is set.
2558
2559 *'cscopeverbose'* *'csverb'*
2560 *'nocscopeverbose'* *'nocsverb'*
2561'cscopeverbose' 'csverb' boolean (default off)
2562 global
2563 {not available when compiled without the |+cscope|
2564 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 Give messages when adding a cscope database. See |cscopeverbose|.
2566 NOTE: This option is reset when 'compatible' is set.
2567
Bram Moolenaar860cae12010-06-05 23:22:07 +02002568 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2569'cursorbind' 'crb' boolean (default off)
2570 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002571 When this option is set, as the cursor in the current
2572 window moves other cursorbound windows (windows that also have
2573 this option set) move their cursors to the corresponding line and
2574 column. This option is useful for viewing the
2575 differences between two versions of a file (see 'diff'); in diff mode,
2576 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002577 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002578
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002579
2580 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2581'cursorcolumn' 'cuc' boolean (default off)
2582 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002583 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002584 feature}
2585 Highlight the screen column of the cursor with CursorColumn
2586 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2587 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002588 If you only want the highlighting in the current window you can use
2589 these autocommands: >
2590 au WinLeave * set nocursorline nocursorcolumn
2591 au WinEnter * set cursorline cursorcolumn
2592<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002593
2594 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2595'cursorline' 'cul' boolean (default off)
2596 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002597 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002598 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002599 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2600 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002601 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002602 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002603
2604
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002605 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002606'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002607 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002608 {not available when compiled without the |+syntax|
2609 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002610 Comma separated list of settings for how 'cursorline' is displayed.
2611 Valid values:
2612 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002613 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002614 "screenline" Highlight only the screen line of the cursor with
2615 CursorLine |hl-CursorLine|.
2616 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002617 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002618
2619 Special value:
2620 "both" Alias for the values "line,number".
2621
2622 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002623
2624
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 *'debug'*
2626'debug' string (default "")
2627 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002628 These values can be used:
2629 msg Error messages that would otherwise be omitted will be given
2630 anyway.
2631 throw Error messages that would otherwise be omitted will be given
2632 anyway and also throw an exception and set |v:errmsg|.
2633 beep A message will be given when otherwise only a beep would be
2634 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002635 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002636 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2637 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638
2639 *'define'* *'def'*
2640'define' 'def' string (default "^\s*#\s*define")
2641 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002642 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 pattern, just like for the "/" command. This option is used for the
2644 commands like "[i" and "[d" |include-search|. The 'isident' option is
2645 used to recognize the defined name after the match:
2646 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2647 See |option-backslash| about inserting backslashes to include a space
2648 or backslash.
2649 The default value is for C programs. For C++ this value would be
2650 useful, to include const type declarations: >
2651 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002652< You can also use "\ze" just before the name and continue the pattern
2653 to check what is following. E.g. for Javascript, if a function is
2654 defined with "func_name = function(args)": >
2655 ^\s*\ze\i\+\s*=\s*function(
2656< If the function is defined with "func_name : function() {...": >
2657 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002659 To avoid that use `:let` with a single quote string: >
2660 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002661<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662
2663 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2664'delcombine' 'deco' boolean (default off)
2665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 If editing Unicode and this option is set, backspace and Normal mode
2667 "x" delete each combining character on its own. When it is off (the
2668 default) the character along with its combining characters are
2669 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002670 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671
2672 This is useful for Arabic, Hebrew and many other languages where one
2673 may have combining characters overtop of base characters, and want
2674 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002675 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676
2677 *'dictionary'* *'dict'*
2678'dictionary' 'dict' string (default "")
2679 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 List of file names, separated by commas, that are used to lookup words
2681 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2682 contain a list of words. This can be one word per line, or several
2683 words per line, separated by non-keyword characters (white space is
2684 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002685
2686 When this option is empty or an entry "spell" is present, and spell
2687 checking is enabled, words in the word lists for the currently active
2688 'spelllang' are used. See |spell|.
2689
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002690 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 after a comma are ignored, otherwise spaces are included in the file
2692 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002693 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 Where to find a list of words?
2695 - On FreeBSD, there is the file "/usr/share/dict/words".
2696 - In the Simtel archive, look in the "msdos/linguist" directory.
2697 - In "miscfiles" of the GNU collection.
2698 The use of |:set+=| and |:set-=| is preferred when adding or removing
2699 directories from the list. This avoids problems when a future version
2700 uses another default.
2701 Backticks cannot be used in this option for security reasons.
2702
2703 *'diff'* *'nodiff'*
2704'diff' boolean (default off)
2705 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 {not available when compiled without the |+diff|
2707 feature}
2708 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002709 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710
2711 *'dex'* *'diffexpr'*
2712'diffexpr' 'dex' string (default "")
2713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 {not available when compiled without the |+diff|
2715 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002716 Expression which is evaluated to obtain a diff file (either ed-style
2717 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 This option cannot be set from a |modeline| or in the |sandbox|, for
2719 security reasons.
2720
2721 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002722'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 {not available when compiled without the |+diff|
2725 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002726 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 All are optional. Items must be separated by a comma.
2728
2729 filler Show filler lines, to keep the text
2730 synchronized with a window that has inserted
2731 lines at the same position. Mostly useful
2732 when windows are side-by-side and 'scrollbind'
2733 is set.
2734
2735 context:{n} Use a context of {n} lines between a change
2736 and a fold that contains unchanged lines.
2737 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002738 When using zero the context is actually one,
2739 since folds require a line in between, also
2740 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 See |fold-diff|.
2742
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002743 iblank Ignore changes where lines are all blank. 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.
2748 NOTE: the diff windows will get out of sync,
2749 because no differences between blank lines are
2750 taken into account.
2751
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 icase Ignore changes in case of text. "a" and "A"
2753 are considered the same. Adds the "-i" flag
2754 to the "diff" command if 'diffexpr' is empty.
2755
2756 iwhite Ignore changes in amount of white space. Adds
2757 the "-b" flag to the "diff" command if
2758 'diffexpr' is empty. Check the documentation
2759 of the "diff" command for what this does
2760 exactly. It should ignore adding trailing
2761 white space, but not leading white space.
2762
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002763 iwhiteall Ignore all white space changes. Adds
2764 the "-w" flag to the "diff" command if
2765 'diffexpr' is empty. Check the documentation
2766 of the "diff" command for what this does
2767 exactly.
2768
2769 iwhiteeol Ignore white space changes at end of line.
2770 Adds the "-Z" flag to the "diff" command if
2771 'diffexpr' is empty. Check the documentation
2772 of the "diff" command for what this does
2773 exactly.
2774
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002775 horizontal Start diff mode with horizontal splits (unless
2776 explicitly specified otherwise).
2777
2778 vertical Start diff mode with vertical splits (unless
2779 explicitly specified otherwise).
2780
Bram Moolenaarc8234772019-11-10 21:00:27 +01002781 closeoff When a window is closed where 'diff' is set
2782 and there is only one window remaining in the
2783 same tab page with 'diff' set, execute
2784 `:diffoff` in that window. This undoes a
2785 `:diffsplit` command.
2786
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002787 hiddenoff Do not use diff mode for a buffer when it
2788 becomes hidden.
2789
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002790 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2791 starting diff mode. Without this 2 is used.
2792
Bram Moolenaar4223d432021-02-10 13:18:17 +01002793 followwrap Follow the 'wrap' option and leave as it is.
2794
Bram Moolenaare828b762018-09-10 17:51:58 +02002795 internal Use the internal diff library. This is
2796 ignored when 'diffexpr' is set. *E960*
2797 When running out of memory when writing a
2798 buffer this item will be ignored for diffs
2799 involving that buffer. Set the 'verbose'
2800 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801
Bram Moolenaare828b762018-09-10 17:51:58 +02002802 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002803 Use the indent heuristic for the internal
2804 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002805
2806 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002807 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002808 algorithms are:
2809 myers the default algorithm
2810 minimal spend extra time to generate the
2811 smallest possible diff
2812 patience patience diff algorithm
2813 histogram histogram diff algorithm
2814
2815 Examples: >
2816 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002818 :set diffopt=internal,filler,foldcolumn:3
2819 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820<
2821 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2822'digraph' 'dg' boolean (default off)
2823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 {not available when compiled without the |+digraphs|
2825 feature}
2826 Enable the entering of digraphs in Insert mode with {char1} <BS>
2827 {char2}. See |digraphs|.
2828 NOTE: This option is reset when 'compatible' is set.
2829
2830 *'directory'* *'dir'*
2831'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002832 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 for Unix: ".,~/tmp,/var/tmp,/tmp")
2834 global
2835 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002836 Recommended value: ".,~/vimswap//" - this will put the swap file next
2837 to the edited file if possible, and in your personal swap directory
2838 otherwise. Make sure "~/vimswap//" is only readable for you.
2839
2840 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 - The swap file will be created in the first directory where this is
2842 possible.
2843 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002844 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 - A directory "." means to put the swap file in the same directory as
2846 the edited file. On Unix, a dot is prepended to the file name, so
2847 it doesn't show in a directory listing. On MS-Windows the "hidden"
2848 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002849 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2850 the swap file relative to where the edited file is. The leading "."
2851 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002852 - For Unix and Win32, if a directory ends in two path separators "//",
2853 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002854 with all path separators replaced by percent '%' signs (including
2855 the colon following the drive letter on Win32). This will ensure
2856 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002857 On Win32, it is also possible to end with "\\". However, When a
2858 separating comma is following, you must use "//", since "\\" will
2859 include the comma in the file name. Therefore it is recommended to
2860 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 - Spaces after the comma are ignored, other spaces are considered part
2862 of the directory name. To have a space at the start of a directory
2863 name, precede it with a backslash.
2864 - To include a comma in a directory name precede it with a backslash.
2865 - A directory name may end in an ':' or '/'.
2866 - Environment variables are expanded |:set_env|.
2867 - Careful with '\' characters, type one before a space, type two to
2868 get one in the option (see |option-backslash|), for example: >
2869 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2870< - For backwards compatibility with Vim version 3.0 a '>' at the start
2871 of the option is removed.
2872 Using "." first in the list is recommended. This means that editing
2873 the same file twice will result in a warning. Using "/tmp" on Unix is
2874 discouraged: When the system crashes you lose the swap file.
2875 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002876 choice than "/tmp". But others on the computer may be able to see the
2877 files, and it can contain a lot of files, your swap files get lost in
2878 the crowd. That is why a "tmp" directory in your home directory is
2879 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 The use of |:set+=| and |:set-=| is preferred when adding or removing
2881 directories from the list. This avoids problems when a future version
2882 uses another default.
2883 This option cannot be set from a |modeline| or in the |sandbox|, for
2884 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885
2886 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002887'display' 'dy' string (default "", set to "truncate" in
2888 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 Change the way text is displayed. This is comma separated list of
2891 flags:
2892 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002893 in a window will be displayed. "@@@" is put in the
2894 last columns of the last screen line to indicate the
2895 rest of the line is not displayed.
2896 truncate Like "lastline", but "@@@" is displayed in the first
2897 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 uhex Show unprintable characters hexadecimal as <xx>
2899 instead of using ^C and ~C.
2900
Bram Moolenaard0796902016-09-16 20:02:31 +02002901 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002902 doesn't fit is replaced with "@" lines.
2903
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 *'eadirection'* *'ead'*
2905'eadirection' 'ead' string (default "both")
2906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 Tells when the 'equalalways' option applies:
2908 ver vertically, width of windows is not affected
2909 hor horizontally, height of windows is not affected
2910 both width and height of windows is affected
2911
2912 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2913'edcompatible' 'ed' boolean (default off)
2914 global
2915 Makes the 'g' and 'c' flags of the ":substitute" command to be
2916 toggled each time the flag is given. See |complex-change|. See
2917 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002918 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002919 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920
Bram Moolenaar03413f42016-04-12 21:07:15 +02002921 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002922'emoji' 'emo' boolean (default: on)
2923 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002924 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002925 This excludes "text emoji" characters, which are normally displayed as
2926 single width. Unfortunately there is no good specification for this
2927 and it has been determined on trial-and-error basis. Use the
2928 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002929
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002931'encoding' 'enc' string (default for MS-Windows: "utf-8",
2932 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 Sets the character encoding used inside Vim. It applies to text in
2935 the buffers, registers, Strings in expressions, text stored in the
2936 viminfo file, etc. It sets the kind of characters which Vim can work
2937 with. See |encoding-names| for the possible values.
2938
2939 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002940 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002942 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943
Bram Moolenaar865242e2010-07-14 21:12:05 +02002944 This option cannot be set from a |modeline|. It would most likely
2945 corrupt the text.
2946
Bram Moolenaar3df01732017-02-17 22:47:16 +01002947 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2948 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 'encoding', "utf-8" is the natural choice for the environment and
2950 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002951 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 versions, and to avoid changing the encoding of newly created files
2953 without your knowledge (in case 'fileencodings' is empty).
2954
2955 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002956 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 iconv() or as specified with 'charconvert'.
2958
Bram Moolenaar207f0092020-08-30 17:20:20 +02002959 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002960 can use: >
2961 if has("multi_byte_encoding")
2962<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 Normally 'encoding' will be equal to your current locale. This will
2964 be the default if Vim recognizes your environment settings. If
2965 'encoding' is not set to the current locale, 'termencoding' must be
2966 set to convert typed and displayed text. See |encoding-table|.
2967
2968 When you set this option, it fires the |EncodingChanged| autocommand
2969 event so that you can set up fonts if necessary.
2970
2971 When the option is set, the value is converted to lowercase. Thus
2972 you can set it with uppercase values too. Underscores are translated
2973 to '-' signs.
2974 When the encoding is recognized, it is changed to the standard name.
2975 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2976 "iso-8859-2" and "utf8" becomes "utf-8".
2977
2978 Note: "latin1" is also used when the encoding could not be detected.
2979 This only works when editing files in the same encoding! When the
2980 actual character set is not latin1, make sure 'fileencoding' and
2981 'fileencodings' are empty. When conversion is needed, switch to using
2982 utf-8.
2983
2984 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2985 You don't notice this while editing, but it does matter for the
2986 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2987 setting 'encoding' to one of these values instead of utf-8 only has
2988 effect for encoding used for files when 'fileencoding' is empty.
2989
Bram Moolenaar661b1822005-07-28 22:36:45 +00002990 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2991 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992
2993 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2994'endofline' 'eol' boolean (default on)
2995 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002997 is on, or 'fixeol' option is off, no <EOL> will be written for the
2998 last line in the file. This option is automatically set or reset when
2999 starting to edit a new file, depending on whether file has an <EOL>
3000 for the last line in the file. Normally you don't have to set or
3001 reset this option.
3002 When 'binary' is off and 'fixeol' is on the value is not used when
3003 writing the file. When 'binary' is on or 'fixeol' is off it is used
3004 to remember the presence of a <EOL> for the last line in the file, so
3005 that when you write the file the situation from the original file can
3006 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007
3008 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3009'equalalways' 'ea' boolean (default on)
3010 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003012 splitting or closing a window. This also happens the moment the
3013 option is switched on. When off, splitting a window will reduce the
3014 size of the current window and leave the other windows the same. When
3015 closing a window the extra lines are given to the window next to it
3016 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 When mixing vertically and horizontally split windows, a minimal size
3018 is computed and some windows may be larger if there is room. The
3019 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003020 Changing the height and width of a window can be avoided by setting
3021 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003022 If a window size is specified when creating a new window sizes are
3023 currently not equalized (it's complicated, but may be implemented in
3024 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025
3026 *'equalprg'* *'ep'*
3027'equalprg' 'ep' string (default "")
3028 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003030 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003031 or 'indentexpr'. When Vim was compiled without internal formatting,
3032 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003033 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 about including spaces and backslashes.
3035 This option cannot be set from a |modeline| or in the |sandbox|, for
3036 security reasons.
3037
3038 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3039'errorbells' 'eb' boolean (default off)
3040 global
3041 Ring the bell (beep or screen flash) for error messages. This only
3042 makes a difference for error messages, the bell will be used always
3043 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003044 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003045 screen flash or do nothing. See 'belloff' to finetune when to ring the
3046 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047
3048 *'errorfile'* *'ef'*
3049'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3050 others: "errors.err")
3051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 {not available when compiled without the |+quickfix|
3053 feature}
3054 Name of the errorfile for the QuickFix mode (see |:cf|).
3055 When the "-q" command-line argument is used, 'errorfile' is set to the
3056 following argument. See |-q|.
3057 NOT used for the ":make" command. See 'makeef' for that.
3058 Environment variables are expanded |:set_env|.
3059 See |option-backslash| about including spaces and backslashes.
3060 This option cannot be set from a |modeline| or in the |sandbox|, for
3061 security reasons.
3062
3063 *'errorformat'* *'efm'*
3064'errorformat' 'efm' string (default is very long)
3065 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 {not available when compiled without the |+quickfix|
3067 feature}
3068 Scanf-like description of the format for the lines in the error file
3069 (see |errorformat|).
3070
3071 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3072'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 Function keys that start with an <Esc> are recognized in Insert
3075 mode. When this option is off, the cursor and function keys cannot be
3076 used in Insert mode if they start with an <Esc>. The advantage of
3077 this is that the single <Esc> is recognized immediately, instead of
3078 after one second. Instead of resetting this option, you might want to
3079 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3080 when 'esckeys' is off, you can still map anything, but the cursor keys
3081 won't work by default.
3082 NOTE: This option is set to the Vi default value when 'compatible' is
3083 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003084 NOTE: when this option is off then the |modifyOtherKeys| functionality
3085 is disabled while in Insert mode to avoid ending Insert mode with any
3086 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087
3088 *'eventignore'* *'ei'*
3089'eventignore' 'ei' string (default "")
3090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003092 When set to "all" or when "all" is one of the items, all autocommand
3093 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 Otherwise this is a comma separated list of event names. Example: >
3095 :set ei=WinEnter,WinLeave
3096<
3097 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3098'expandtab' 'et' boolean (default off)
3099 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003101 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3103 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003104 This option is reset when the 'paste' option is set and restored when
3105 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 NOTE: This option is reset when 'compatible' is set.
3107
3108 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3109'exrc' 'ex' boolean (default off)
3110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003112 directory.
3113
3114 Setting this option is a potential security leak. E.g., consider
3115 unpacking a package or fetching files from github, a .vimrc in there
3116 might be a trojan horse. BETTER NOT SET THIS OPTION!
3117 Instead, define an autocommand in your .vimrc to set options for a
3118 matching directory.
3119
3120 If you do switch this option on you should also consider setting the
3121 'secure' option (see |initialization|).
3122 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 This option cannot be set from a |modeline| or in the |sandbox|, for
3124 security reasons.
3125
3126 *'fileencoding'* *'fenc'* *E213*
3127'fileencoding' 'fenc' string (default: "")
3128 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003130
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003132 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 When 'fileencoding' is empty, the same value as 'encoding' will be
3134 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003135 No error will be given when the value is set, only when it is used,
3136 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003137 Conversion will also be done when 'encoding' and 'fileencoding' are
3138 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3139 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003141 'encoding' is "utf-8" or another Unicode encoding, conversion
3142 is most likely done in a way that the reverse conversion
3143 results in the same text. When 'encoding' is not "utf-8" some
3144 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003145
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 See 'encoding' for the possible values. Additionally, values may be
3147 specified that can be handled by the converter, see
3148 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003149
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 When reading a file 'fileencoding' will be set from 'fileencodings'.
3151 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003152 'fileencoding', use the |++enc| argument. One exception: when
3153 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003154 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003155
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3157 When the option is set, the value is converted to lowercase. Thus
3158 you can set it with uppercase values too. '_' characters are
3159 replaced with '-'. If a name is recognized from the list for
3160 'encoding', it is replaced by the standard name. For example
3161 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003162
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 When this option is set, after starting to edit a file, the 'modified'
3164 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003165
3166 Keep in mind that changing 'fenc' from a modeline happens
3167 AFTER the text has been read, thus it applies to when the file will be
3168 written. If you do set 'fenc' in a modeline, you might want to set
3169 'nomodified' to avoid not being able to ":q".
3170
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 This option can not be changed when 'modifiable' is off.
3172
3173 *'fe'*
3174 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003175 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 old short name was 'fe', which is no longer used.
3177
3178 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003179'fileencodings' 'fencs' string (default: "ucs-bom",
3180 "ucs-bom,utf-8,default,latin1" when
3181 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 This is a list of character encodings considered when starting to edit
3184 an existing file. When a file is read, Vim tries to use the first
3185 mentioned character encoding. If an error is detected, the next one
3186 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003187 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 an empty string, which means the value of 'encoding' is used.
3189 WARNING: Conversion can cause loss of information! When
3190 'encoding' is "utf-8" (or one of the other Unicode variants)
3191 conversion is most likely done in a way that the reverse
3192 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003193 "utf-8" some non-ASCII characters may be lost! You can use
3194 the |++bad| argument to specify what is done with characters
3195 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 For an empty file or a file with only ASCII characters most encodings
3197 will work and the first entry of 'fileencodings' will be used (except
3198 "ucs-bom", which requires the BOM to be present). If you prefer
3199 another encoding use an BufReadPost autocommand event to test if your
3200 preferred encoding is to be used. Example: >
3201 au BufReadPost * if search('\S', 'w') == 0 |
3202 \ set fenc=iso-2022-jp | endif
3203< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3204 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003205 When the |++enc| argument is used then the value of 'fileencodings' is
3206 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003207 Note that 'fileencodings' is not used for a new file, the global value
3208 of 'fileencoding' is used instead. You can set it with: >
3209 :setglobal fenc=iso-8859-2
3210< This means that a non-existing file may get a different encoding than
3211 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 The special value "ucs-bom" can be used to check for a Unicode BOM
3213 (Byte Order Mark) at the start of the file. It must not be preceded
3214 by "utf-8" or another Unicode encoding for this to work properly.
3215 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3216 because Vim cannot detect an error, thus the encoding is always
3217 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003218 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003219 environment. On MS-Windows this is the system encoding. Otherwise
3220 this is the default value for 'encoding'. It is useful when
3221 'encoding' is set to "utf-8" and your environment uses a non-latin1
3222 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003223 When 'encoding' is "utf-8" and a file contains an illegal byte
3224 sequence it won't be recognized as UTF-8. You can use the |8g8|
3225 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 WRONG VALUES: WHAT'S WRONG:
3227 latin1,utf-8 "latin1" will always be used
3228 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3229 file
3230 cp1250,latin1 "cp1250" will always be used
3231 If 'fileencodings' is empty, 'fileencoding' is not modified.
3232 See 'fileencoding' for the possible values.
3233 Setting this option does not have an effect until the next time a file
3234 is read.
3235
3236 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003237'fileformat' 'ff' string (MS-Windows default: "dos",
3238 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 This gives the <EOL> of the current buffer, which is used for
3241 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003242 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 unix <NL>
3244 mac <CR>
3245 When "dos" is used, CTRL-Z at the end of a file is ignored.
3246 See |file-formats| and |file-read|.
3247 For the character encoding of the file see 'fileencoding'.
3248 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003249 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 This option is set automatically when starting to edit a file and
3251 'fileformats' is not empty and 'binary' is off.
3252 When this option is set, after starting to edit a file, the 'modified'
3253 option is set, because the file would be different when written.
3254 This option can not be changed when 'modifiable' is off.
3255 For backwards compatibility: When this option is set to "dos",
3256 'textmode' is set, otherwise 'textmode' is reset.
3257
3258 *'fileformats'* *'ffs'*
3259'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003260 Vim+Vi MS-Windows: "dos,unix",
3261 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 Vi Cygwin: "unix,dos",
3263 Vi others: "")
3264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 This gives the end-of-line (<EOL>) formats that will be tried when
3266 starting to edit a new buffer and when reading a file into an existing
3267 buffer:
3268 - When empty, the format defined with 'fileformat' will be used
3269 always. It is not set automatically.
3270 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003271 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 'fileformats' name will be used when a file is read into an existing
3273 buffer, no matter what 'fileformat' for that buffer is set to.
3274 - When more than one name is present, separated by commas, automatic
3275 <EOL> detection will be done when reading a file. When starting to
3276 edit a file, a check is done for the <EOL>:
3277 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3278 'fileformat' is set to "dos".
3279 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003280 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003282 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3283 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003284 This means that "mac" is only chosen when:
3285 "unix" is not present or no <NL> is found in the file, and
3286 "dos" is not present or no <CR><NL> is found in the file.
3287 Except: if "unix" was chosen, but there is a <CR> before
3288 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003289 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 4. If 'fileformat' is still not set, the first name from
3291 'fileformats' is used.
3292 When reading a file into an existing buffer, the same is done, but
3293 this happens like 'fileformat' has been set appropriately for that
3294 file only, the option is not changed.
3295 When 'binary' is set, the value of 'fileformats' is not used.
3296
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003297 When Vim starts up with an empty buffer the first item is used. You
3298 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003299
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3301 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3302 done:
3303 - When 'fileformats' is empty, there is no automatic detection. Dos
3304 format will be used.
3305 - When 'fileformats' is set to one or more names, automatic detection
3306 is done. This is based on the first <NL> in the file: If there is a
3307 <CR> in front of it, Dos format is used, otherwise Unix format is
3308 used.
3309 Also see |file-formats|.
3310 For backwards compatibility: When this option is set to an empty
3311 string or one format (no comma is included), 'textauto' is reset,
3312 otherwise 'textauto' is set.
3313 NOTE: This option is set to the Vi default value when 'compatible' is
3314 set and to the Vim default value when 'compatible' is reset.
3315
Bram Moolenaarbf884932013-04-05 22:26:15 +02003316 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3317'fileignorecase' 'fic' boolean (default on for systems where case in file
3318 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003319 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003320 When set case is ignored when using file names and directories.
3321 See 'wildignorecase' for only ignoring case when doing completion.
3322
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 *'filetype'* *'ft'*
3324'filetype' 'ft' string (default: "")
3325 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 When this option is set, the FileType autocommand event is triggered.
3327 All autocommands that match with the value of this option will be
3328 executed. Thus the value of 'filetype' is used in place of the file
3329 name.
3330 Otherwise this option does not always reflect the current file type.
3331 This option is normally set when the file type is detected. To enable
3332 this use the ":filetype on" command. |:filetype|
3333 Setting this option to a different value is most useful in a modeline,
3334 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003335 Example, for in an IDL file:
3336 /* vim: set filetype=idl : */ ~
3337 |FileType| |filetypes|
3338 When a dot appears in the value then this separates two filetype
3339 names. Example:
3340 /* vim: set filetype=c.doxygen : */ ~
3341 This will use the "c" filetype first, then the "doxygen" filetype.
3342 This works both for filetype plugins and for syntax files. More than
3343 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 This option is not copied to another buffer, independent of the 's' or
3345 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003346 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347
3348 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003349'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003351 {not available when compiled without the |+folding|
3352 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 Characters to fill the statuslines and vertical separators.
3354 It is a comma separated list of items:
3355
3356 item default Used for ~
3357 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003358 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 vert:c '|' vertical separators |:vsplit|
3360 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003361 foldopen:c '-' mark the beginning of a fold
3362 foldclose:c '+' show a closed fold
3363 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003365 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003367 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003368 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 otherwise.
3370
3371 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003372 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373< This is similar to the default, except that these characters will also
3374 be used when there is highlighting.
3375
Bram Moolenaar008bff92021-03-04 21:55:58 +01003376 For "stl" and "stlnc" single-byte and multibyte characters are
3377 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003378
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 The highlighting used for these items:
3380 item highlight group ~
3381 stl:c StatusLine |hl-StatusLine|
3382 stlnc:c StatusLineNC |hl-StatusLineNC|
3383 vert:c VertSplit |hl-VertSplit|
3384 fold:c Folded |hl-Folded|
3385 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003386 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003388 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3389'fixendofline' 'fixeol' boolean (default on)
3390 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003391 When writing a file and this option is on, <EOL> at the end of file
3392 will be restored if missing. Turn this option off if you want to
3393 preserve the situation from the original file.
3394 When the 'binary' option is set the value of this option doesn't
3395 matter.
3396 See the 'endofline' option.
3397
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003399'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 {only available when compiled with the |+rightleft|
3402 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003403 This option was for using Farsi, which has been removed. See
3404 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405
3406 *'foldclose'* *'fcl'*
3407'foldclose' 'fcl' string (default "")
3408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 {not available when compiled without the |+folding|
3410 feature}
3411 When set to "all", a fold is closed when the cursor isn't in it and
3412 its level is higher than 'foldlevel'. Useful if you want folds to
3413 automatically close when moving out of them.
3414
3415 *'foldcolumn'* *'fdc'*
3416'foldcolumn' 'fdc' number (default 0)
3417 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 {not available when compiled without the |+folding|
3419 feature}
3420 When non-zero, a column with the specified width is shown at the side
3421 of the window which indicates open and closed folds. The maximum
3422 value is 12.
3423 See |folding|.
3424
3425 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3426'foldenable' 'fen' boolean (default on)
3427 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 {not available when compiled without the |+folding|
3429 feature}
3430 When off, all folds are open. This option can be used to quickly
3431 switch between showing all text unfolded and viewing the text with
3432 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003433 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 'foldenable' is off.
3435 This option is set by commands that create a new fold or close a fold.
3436 See |folding|.
3437
3438 *'foldexpr'* *'fde'*
3439'foldexpr' 'fde' string (default: "0")
3440 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003442 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003444 for each line to obtain its fold level. The context is set to the
3445 script where 'foldexpr' was set, script-local items can be accessed.
3446 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003447
Bram Moolenaar30b65812012-07-12 22:01:11 +02003448 The expression will be evaluated in the |sandbox| if set from a
3449 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003450 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003451 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003452
3453 It is not allowed to change text or jump to another window while
3454 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455
3456 *'foldignore'* *'fdi'*
3457'foldignore' 'fdi' string (default: "#")
3458 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 {not available when compiled without the |+folding|
3460 feature}
3461 Used only when 'foldmethod' is "indent". Lines starting with
3462 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003463 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 The default "#" works well for C programs. See |fold-indent|.
3465
3466 *'foldlevel'* *'fdl'*
3467'foldlevel' 'fdl' number (default: 0)
3468 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 {not available when compiled without the |+folding|
3470 feature}
3471 Sets the fold level: Folds with a higher level will be closed.
3472 Setting this option to zero will close all folds. Higher numbers will
3473 close fewer folds.
3474 This option is set by commands like |zm|, |zM| and |zR|.
3475 See |fold-foldlevel|.
3476
3477 *'foldlevelstart'* *'fdls'*
3478'foldlevelstart' 'fdls' number (default: -1)
3479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 {not available when compiled without the |+folding|
3481 feature}
3482 Sets 'foldlevel' when starting to edit another buffer in a window.
3483 Useful to always start editing with all folds closed (value zero),
3484 some folds closed (one) or no folds closed (99).
3485 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003486 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 ignores this option and closes all folds.
3488 It is also done before BufReadPre autocommands, to allow an autocmd to
3489 overrule the 'foldlevel' value for specific files.
3490 When the value is negative, it is not used.
3491
3492 *'foldmarker'* *'fmr'* *E536*
3493'foldmarker' 'fmr' string (default: "{{{,}}}")
3494 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 {not available when compiled without the |+folding|
3496 feature}
3497 The start and end marker used when 'foldmethod' is "marker". There
3498 must be one comma, which separates the start and end marker. The
3499 marker is a literal string (a regular expression would be too slow).
3500 See |fold-marker|.
3501
3502 *'foldmethod'* *'fdm'*
3503'foldmethod' 'fdm' string (default: "manual")
3504 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 {not available when compiled without the |+folding|
3506 feature}
3507 The kind of folding used for the current window. Possible values:
3508 |fold-manual| manual Folds are created manually.
3509 |fold-indent| indent Lines with equal indent form a fold.
3510 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3511 |fold-marker| marker Markers are used to specify folds.
3512 |fold-syntax| syntax Syntax highlighting items specify folds.
3513 |fold-diff| diff Fold text that is not changed.
3514
3515 *'foldminlines'* *'fml'*
3516'foldminlines' 'fml' number (default: 1)
3517 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 {not available when compiled without the |+folding|
3519 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003520 Sets the number of screen lines above which a fold can be displayed
3521 closed. Also for manually closed folds. With the default value of
3522 one a fold can only be closed if it takes up two or more screen lines.
3523 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003524 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 "zc" to close a fold, which is displayed open because it's smaller
3526 than 'foldminlines', a following "zc" may close a containing fold.
3527
3528 *'foldnestmax'* *'fdn'*
3529'foldnestmax' 'fdn' number (default: 20)
3530 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 {not available when compiled without the |+folding|
3532 feature}
3533 Sets the maximum nesting of folds for the "indent" and "syntax"
3534 methods. This avoids that too many folds will be created. Using more
3535 than 20 doesn't work, because the internal limit is 20.
3536
3537 *'foldopen'* *'fdo'*
3538'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3539 search,tag,undo")
3540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 {not available when compiled without the |+folding|
3542 feature}
3543 Specifies for which type of commands folds will be opened, if the
3544 command moves the cursor into a closed fold. It is a comma separated
3545 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003546 NOTE: When the command is part of a mapping this option is not used.
3547 Add the |zv| command to the mapping to get the same effect.
3548 (rationale: the mapping may want to control opening folds itself)
3549
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 item commands ~
3551 all any
3552 block "(", "{", "[[", "[{", etc.
3553 hor horizontal movements: "l", "w", "fx", etc.
3554 insert any command in Insert mode
3555 jump far jumps: "G", "gg", etc.
3556 mark jumping to a mark: "'m", CTRL-O, etc.
3557 percent "%"
3558 quickfix ":cn", ":crew", ":make", etc.
3559 search search for a pattern: "/", "n", "*", "gd", etc.
3560 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003561 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 tag jumping to a tag: ":ta", CTRL-T, etc.
3563 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 When a movement command is used for an operator (e.g., "dl" or "y%")
3565 this option is not used. This means the operator will include the
3566 whole closed fold.
3567 Note that vertical movements are not here, because it would make it
3568 very difficult to move onto a closed fold.
3569 In insert mode the folds containing the cursor will always be open
3570 when text is inserted.
3571 To close folds you can re-apply 'foldlevel' with the |zx| command or
3572 set the 'foldclose' option to "all".
3573
3574 *'foldtext'* *'fdt'*
3575'foldtext' 'fdt' string (default: "foldtext()")
3576 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 {not available when compiled without the |+folding|
3578 feature}
3579 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003580 fold. The context is set to the script where 'foldexpr' was set,
3581 script-local items can be accessed. See |fold-foldtext| for the
3582 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583
Bram Moolenaar30b65812012-07-12 22:01:11 +02003584 The expression will be evaluated in the |sandbox| if set from a
3585 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003586 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003587
3588 It is not allowed to change text or jump to another window while
3589 evaluating 'foldtext' |textlock|.
3590
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003591 *'formatexpr'* *'fex'*
3592'formatexpr' 'fex' string (default "")
3593 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003594 {not available when compiled without the |+eval|
3595 feature}
3596 Expression which is evaluated to format a range of lines for the |gq|
3597 operator or automatic formatting (see 'formatoptions'). When this
3598 option is empty 'formatprg' is used.
3599
3600 The |v:lnum| variable holds the first line to be formatted.
3601 The |v:count| variable holds the number of lines to be formatted.
3602 The |v:char| variable holds the character that is going to be
3603 inserted if the expression is being evaluated due to
3604 automatic formatting. This can be empty. Don't insert
3605 it yet!
3606
3607 Example: >
3608 :set formatexpr=mylang#Format()
3609< This will invoke the mylang#Format() function in the
3610 autoload/mylang.vim file in 'runtimepath'. |autoload|
3611
3612 The expression is also evaluated when 'textwidth' is set and adding
3613 text beyond that limit. This happens under the same conditions as
3614 when internal formatting is used. Make sure the cursor is kept in the
3615 same spot relative to the text then! The |mode()| function will
3616 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003617
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003618 When the expression evaluates to non-zero Vim will fall back to using
3619 the internal format mechanism.
3620
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003621 If the expression starts with s: or |<SID>|, then it is replaced with
3622 the script ID (|local-function|). Example: >
3623 set formatexpr=s:MyFormatExpr()
3624 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003625< Otherwise, the expression is evaluated in the context of the script
3626 where the option was set, thus script-local items are available.
3627
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003628 The expression will be evaluated in the |sandbox| when set from a
3629 modeline, see |sandbox-option|. That stops the option from working,
3630 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003631 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003632 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003633
Bram Moolenaar86b68352004-12-27 21:59:20 +00003634 *'formatlistpat'* *'flp'*
3635'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3636 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003637 A pattern that is used to recognize a list header. This is used for
3638 the "n" flag in 'formatoptions'.
3639 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003640 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003641 while still checking more characters. There must be a character
3642 following the pattern, when it matches the whole line it is handled
3643 like there is no match.
3644 The default recognizes a number, followed by an optional punctuation
3645 character and white space.
3646
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003647 *'formatoptions'* *'fo'*
3648'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3649 local to buffer
3650 This is a sequence of letters which describes how automatic
3651 formatting is to be done. See |fo-table|. When the 'paste' option is
3652 on, no formatting is done (like 'formatoptions' is empty). Commas can
3653 be inserted for readability.
3654 To avoid problems with flags that are added in the future, use the
3655 "+=" and "-=" feature of ":set" |add-option-flags|.
3656 NOTE: This option is set to the Vi default value when 'compatible' is
3657 set and to the Vim default value when 'compatible' is reset.
3658
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 *'formatprg'* *'fp'*
3660'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003661 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003663 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003665 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003666 If the 'formatexpr' option is not empty it will be used instead.
3667 Otherwise, if 'formatprg' option is an empty string, the internal
3668 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003669 Environment variables are expanded |:set_env|. See |option-backslash|
3670 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003671 This option cannot be set from a |modeline| or in the |sandbox|, for
3672 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673
Bram Moolenaard94464e2015-11-02 15:28:18 +01003674 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003675'fsync' 'fs' boolean (default on)
3676 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003677 When on, the library function fsync() will be called after writing a
3678 file. This will flush a file to disk, ensuring that it is safely
3679 written even on filesystems which do metadata-only journaling. This
3680 will force the harddrive to spin up on Linux systems running in laptop
3681 mode, so it may be undesirable in some situations. Be warned that
3682 turning this off increases the chances of data loss after a crash. On
3683 systems without an fsync() implementation, this variable is always
3684 off.
3685 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003686 'fsync' also applies to |writefile()| (unless a flag is used to
3687 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003688 This option cannot be set from a |modeline| or in the |sandbox|, for
3689 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003690
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3692'gdefault' 'gd' boolean (default off)
3693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 When on, the ":substitute" flag 'g' is default on. This means that
3695 all matches in a line are substituted instead of one. When a 'g' flag
3696 is given to a ":substitute" command, this will toggle the substitution
3697 of all or one match. See |complex-change|.
3698
3699 command 'gdefault' on 'gdefault' off ~
3700 :s/// subst. all subst. one
3701 :s///g subst. one subst. all
3702 :s///gg subst. all subst. one
3703
3704 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003705 DEPRECATED: Setting this option may break plugins that are not aware
3706 of this option. Also, many users get confused that adding the /g flag
3707 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003708 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709
3710 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003711'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 Format to recognize for the ":grep" command output.
3714 This is a scanf-like string that uses the same format as the
3715 'errorformat' option: see |errorformat|.
3716
3717 *'grepprg'* *'gp'*
3718'grepprg' 'gp' string (default "grep -n ",
3719 Unix: "grep -n $* /dev/null",
3720 Win32: "findstr /n" or "grep -n",
3721 VMS: "SEARCH/NUMBERS ")
3722 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003723 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 and '#' characters, which are expanded like when used in a command-
3725 line. The placeholder "$*" is allowed to specify where the arguments
3726 will be included. Environment variables are expanded |:set_env|. See
3727 |option-backslash| about including spaces and backslashes.
3728 When your "grep" accepts the "-H" argument, use this to make ":grep"
3729 also work well with a single file: >
3730 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003731< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003732 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3733 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003734 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 apply equally to 'grepprg'.
3736 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3737 otherwise it's "grep -n".
3738 This option cannot be set from a |modeline| or in the |sandbox|, for
3739 security reasons.
3740
3741 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3742'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3743 ve:ver35-Cursor,
3744 o:hor50-Cursor,
3745 i-ci:ver25-Cursor/lCursor,
3746 r-cr:hor20-Cursor/lCursor,
3747 sm:block-Cursor
3748 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003749 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 "n-v-c:block,o:hor50,i-ci:hor15,
3751 r-cr:hor30,sm:block")
3752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003754 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003756 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003757 height of the cursor can be changed. This can be done by specifying a
3758 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003759 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3760 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003762 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 mode-list and an argument-list:
3764 mode-list:argument-list,mode-list:argument-list,..
3765 The mode-list is a dash separated list of these modes:
3766 n Normal mode
3767 v Visual mode
3768 ve Visual mode with 'selection' "exclusive" (same as 'v',
3769 if not specified)
3770 o Operator-pending mode
3771 i Insert mode
3772 r Replace mode
3773 c Command-line Normal (append) mode
3774 ci Command-line Insert mode
3775 cr Command-line Replace mode
3776 sm showmatch in Insert mode
3777 a all modes
3778 The argument-list is a dash separated list of these arguments:
3779 hor{N} horizontal bar, {N} percent of the character height
3780 ver{N} vertical bar, {N} percent of the character width
3781 block block cursor, fills the whole character
3782 [only one of the above three should be present]
3783 blinkwait{N} *cursor-blinking*
3784 blinkon{N}
3785 blinkoff{N}
3786 blink times for cursor: blinkwait is the delay before
3787 the cursor starts blinking, blinkon is the time that
3788 the cursor is shown and blinkoff is the time that the
3789 cursor is not shown. The times are in msec. When one
3790 of the numbers is zero, there is no blinking. The
3791 default is: "blinkwait700-blinkon400-blinkoff250".
3792 These numbers are used for a missing entry. This
3793 means that blinking is enabled by default. To switch
3794 blinking off you can use "blinkon0". The cursor only
3795 blinks when Vim is waiting for input, not while
3796 executing a command.
3797 To make the cursor blink in an xterm, see
3798 |xterm-blink|.
3799 {group-name}
3800 a highlight group name, that sets the color and font
3801 for the cursor
3802 {group-name}/{group-name}
3803 Two highlight group names, the first is used when
3804 no language mappings are used, the other when they
3805 are. |language-mapping|
3806
3807 Examples of parts:
3808 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3809 block cursor with colors from the "nCursor"
3810 highlight group
3811 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3812 In Insert and Command-line Insert mode, use a
3813 30% vertical bar cursor with colors from the
3814 "iCursor" highlight group. Blink a bit
3815 faster.
3816
3817 The 'a' mode is different. It will set the given argument-list for
3818 all modes. It does not reset anything to defaults. This can be used
3819 to do a common setting for all modes. For example, to switch off
3820 blinking: "a:blinkon0"
3821
3822 Examples of cursor highlighting: >
3823 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3824 :highlight Cursor gui=NONE guifg=bg guibg=fg
3825<
3826 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003827 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828'guifont' 'gfn' string (default "")
3829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 {only available when compiled with GUI enabled}
3831 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003832 In its simplest form the value is just one font name.
3833 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834
3835 *'guifontset'* *'gfs'*
3836 *E250* *E252* *E234* *E597* *E598*
3837'guifontset' 'gfs' string (default "")
3838 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 {only available when compiled with GUI enabled and
3840 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003841 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 When not empty, specifies two (or more) fonts to be used. The first
3843 one for normal English, the second one for your special language. See
3844 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003845
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3847'guifontwide' 'gfw' string (default "")
3848 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 {only available when compiled with GUI enabled}
3850 When not empty, specifies a comma-separated list of fonts to be used
3851 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003852 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003853
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 *'guiheadroom'* *'ghr'*
3855'guiheadroom' 'ghr' number (default 50)
3856 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003857 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 The number of pixels subtracted from the screen height when fitting
3859 the GUI window on the screen. Set this before the GUI is started,
3860 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003861 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 lines will be left for window decorations and other items on the
3863 screen. Set it to a negative value to allow windows taller than the
3864 screen.
3865
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003866 *'guiligatures'* *'gli'* *E1243*
3867'guiligatures' 'gli' string (default "")
3868 global
3869 {only for GTK GUI}
3870 List of ASCII characters that, when combined together, can create more
3871 complex shapes. Each character must be a printable ASCII character
3872 with a value in the 32-127 range.
3873 Example: >
3874 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3875< Changing this option updates screen output immediately. Set it to an
3876 empty string to disable ligatures.
3877
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003879'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3880 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003881 "aegimrLtT" (GTK, Motif and Athena),
3882 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003885 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 sequence of letters which describes what components and options of the
3887 GUI should be used.
3888 To avoid problems with flags that are added in the future, use the
3889 "+=" and "-=" feature of ":set" |add-option-flags|.
3890
Bram Moolenaar13568252018-03-16 20:46:58 +01003891 Valid characters are as follows:
3892 *'go-!'*
3893 '!' External commands are executed in a terminal window. Without
3894 this flag the MS-Windows GUI will open a console window to
3895 execute the command. The Unix GUI will simulate a dumb
3896 terminal to list the command output.
3897 The terminal window will be positioned at the bottom, and grow
3898 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003899 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 'a' Autoselect: If present, then whenever VISUAL mode is started,
3901 or the Visual area extended, Vim tries to become the owner of
3902 the windowing system's global selection. This means that the
3903 Visually highlighted text is available for pasting into other
3904 applications as well as into Vim itself. When the Visual mode
3905 ends, possibly due to an operation on the text, or when an
3906 application wants to paste the selection, the highlighted text
3907 is automatically yanked into the "* selection register.
3908 Thus the selection is still available for pasting into other
3909 applications after the VISUAL mode has ended.
3910 If not present, then Vim won't become the owner of the
3911 windowing system's global selection unless explicitly told to
3912 by a yank or delete operation for the "* register.
3913 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003914 *'go-P'*
3915 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003916 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003917 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003918 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 applies to the modeless selection.
3920
3921 'guioptions' autoselect Visual autoselect modeless ~
3922 "" - -
3923 "a" yes yes
3924 "A" - yes
3925 "aA" yes yes
3926
Bram Moolenaar02467872007-05-06 13:22:01 +00003927 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 'c' Use console dialogs instead of popup dialogs for simple
3929 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003930 *'go-d'*
3931 'd' Use dark theme variant if available. Currently only works for
3932 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003933 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003934 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003935 'guitablabel' can be used to change the text in the labels.
3936 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003937 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003938 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003939 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 'f' Foreground: Don't use fork() to detach the GUI from the shell
3941 where it was started. Use this for programs that wait for the
3942 editor to finish (e.g., an e-mail program). Alternatively you
3943 can use "gvim -f" or ":gui -f" to start the GUI in the
3944 foreground. |gui-fork|
3945 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003946 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003947 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3949 corner of the window. It's black&white on non-GTK, because of
3950 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003951 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003953 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003954 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003956 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003958 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003959 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 'g' Grey menu items: Make menu items that are not active grey. If
3961 'g' is not included inactive menu items are not shown at all.
3962 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003963 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 't' Include tearoff menu items. Currently only works for Win32,
3965 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003966 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003967 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003968 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003969 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003971 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 'R' Right-hand scrollbar is present when there is a vertically
3973 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003974 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003976 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 'L' Left-hand scrollbar is present when there is a vertically
3978 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003979 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3981 the longest visible line, or on the cursor line if the 'h'
3982 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003983 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 'h' Limit horizontal scrollbar size to the length of the cursor
3985 line. Reduces computations. |gui-horiz-scroll|
3986
3987 And yes, you may even have scrollbars on the left AND the right if
3988 you really want to :-). See |gui-scrollbars| for more information.
3989
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003990 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 'v' Use a vertical button layout for dialogs. When not included,
3992 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003993 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003994 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 'p' Use Pointer callbacks for X11 GUI. This is required for some
3996 window managers. If the cursor is not blinking or hollow at
3997 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003998 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004000 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004001 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004002 *'go-k'*
4003 'k' Keep the GUI window size when adding/removing a scrollbar, or
4004 toolbar, tabline, etc. Instead, the behavior is similar to
4005 when the window is maximized and will adjust 'lines' and
4006 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004007 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004008 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004009
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 *'guipty'* *'noguipty'*
4011'guipty' boolean (default on)
4012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 {only available when compiled with GUI enabled}
4014 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4015 I/O to/from shell commands. See |gui-pty|.
4016
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004017 *'guitablabel'* *'gtl'*
4018'guitablabel' 'gtl' string (default empty)
4019 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004020 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004021 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004022 pages line. When empty and when the result is empty Vim will use a
4023 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004024
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004025 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004026 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004027 The expression will be evaluated in the |sandbox| when set from a
4028 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004029 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004030
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004031 Only used when the GUI tab pages line is displayed. 'e' must be
4032 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4033 used.
4034
Bram Moolenaar57657d82006-04-21 22:12:41 +00004035 *'guitabtooltip'* *'gtt'*
4036'guitabtooltip' 'gtt' string (default empty)
4037 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004038 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004039 When nonempty describes the text to use in a tooltip for the GUI tab
4040 pages line. When empty Vim will use a default tooltip.
4041 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004042 You can include a line break. Simplest method is to use |:let|: >
4043 :let &guitabtooltip = "line one\nline two"
4044<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004045
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004047'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 (others) "$VIMRUNTIME/doc/help.txt")
4049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 Name of the main help file. All distributed help files should be
4051 placed together in one directory. Additionally, all "doc" directories
4052 in 'runtimepath' will be used.
4053 Environment variables are expanded |:set_env|. For example:
4054 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004055 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 spaces and backslashes.
4057 This option cannot be set from a |modeline| or in the |sandbox|, for
4058 security reasons.
4059
4060 *'helpheight'* *'hh'*
4061'helpheight' 'hh' number (default 20)
4062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 Minimal initial height of the help window when it is opened with the
4064 ":help" command. The initial height of the help window is half of the
4065 current window, or (when the 'ea' option is on) the same as other
4066 windows. When the height is less than 'helpheight', the height is
4067 set to 'helpheight'. Set to zero to disable.
4068
4069 *'helplang'* *'hlg'*
4070'helplang' 'hlg' string (default: messages language or empty)
4071 global
4072 {only available when compiled with the |+multi_lang|
4073 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 Comma separated list of languages. Vim will use the first language
4075 for which the desired help can be found. The English help will always
4076 be used as a last resort. You can add "en" to prefer English over
4077 another language, but that will only find tags that exist in that
4078 language and not in the English help.
4079 Example: >
4080 :set helplang=de,it
4081< This will first search German, then Italian and finally English help
4082 files.
4083 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4084 try to find the tag in the current language before using this option.
4085 See |help-translated|.
4086
4087 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4088'hidden' 'hid' boolean (default off)
4089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 When off a buffer is unloaded when it is |abandon|ed. When on a
4091 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4092 displayed in another window, it does not become hidden, of course.
4093 The commands that move through the buffer list sometimes make a buffer
4094 hidden although the 'hidden' option is off: When the buffer is
4095 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004096 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004097 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 This option is set for one command with ":hide {command}" |:hide|.
4099 WARNING: It's easy to forget that you have changes in hidden buffers.
4100 Think twice when using ":q!" or ":qa!".
4101
4102 *'highlight'* *'hl'*
4103'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004104 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4105 d:Directory,e:ErrorMsg,i:IncSearch,
4106 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004107 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004108 N:CursorLineNr,r:Question,s:StatusLine,
4109 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004110 v:Visual,V:VisualNOS,w:WarningMsg,
4111 W:WildMenu,f:Folded,F:FoldColumn,
4112 A:DiffAdd,C:DiffChange,D:DiffDelete,
4113 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004114 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004115 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004116 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4117 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004118 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004119 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 This option can be used to set highlighting mode for various
4122 occasions. It is a comma separated list of character pairs. The
4123 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004124 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004126 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4127 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 characters from 'showbreak'
4129 |hl-Directory| d directories in CTRL-D listing and other special
4130 things in listings
4131 |hl-ErrorMsg| e error messages
4132 h (obsolete, ignored)
4133 |hl-IncSearch| i 'incsearch' highlighting
4134 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4135 |hl-MoreMsg| m |more-prompt|
4136 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004137 |hl-LineNr| n line number for ":number" and ":#" commands, and
4138 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004139 |hl-LineNrAbove| a line number above the cursor for when the
4140 'relativenumber' option is set.
4141 |hl-LineNrBelow| b line number below the cursor for when the
4142 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004143 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4144 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 |hl-Question| r |hit-enter| prompt and yes/no questions
4146 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004147 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4149 |hl-VertSplit| c column used to separate vertically split windows
4150 |hl-Visual| v Visual mode
4151 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4152 Selection" Only X11 Gui's |gui-x11| and
4153 |xterm-clipboard|.
4154 |hl-WarningMsg| w warning messages
4155 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4156 |hl-Folded| f line used for closed folds
4157 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004158 |hl-DiffAdd| A added line in diff mode
4159 |hl-DiffChange| C changed line in diff mode
4160 |hl-DiffDelete| D deleted line in diff mode
4161 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004163 |hl-Conceal| - the placeholders used for concealed characters
4164 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004165 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004166 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004167 |hl-SpellRare| R rare word |spell|
4168 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004169 |hl-Pmenu| + popup menu normal line
4170 |hl-PmenuSel| = popup menu selected line
4171 |hl-PmenuSbar| x popup menu scrollbar
4172 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173
4174 The display modes are:
4175 r reverse (termcap entry "mr" and "me")
4176 i italic (termcap entry "ZH" and "ZR")
4177 b bold (termcap entry "md" and "me")
4178 s standout (termcap entry "so" and "se")
4179 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004180 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004181 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 n no highlighting
4183 - no highlighting
4184 : use a highlight group
4185 The default is used for occasions that are not included.
4186 If you want to change what the display modes do, see |dos-colors|
4187 for an example.
4188 When using the ':' display mode, this must be followed by the name of
4189 a highlight group. A highlight group can be used to define any type
4190 of highlighting, including using color. See |:highlight| on how to
4191 define one. The default uses a different group for each occasion.
4192 See |highlight-default| for the default highlight groups.
4193
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004195'history' 'hi' number (Vim default: 50, Vi default: 0,
4196 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004199 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004201 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 NOTE: This option is set to the Vi default value when 'compatible' is
4203 set and to the Vim default value when 'compatible' is reset.
4204
4205 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4206'hkmap' 'hk' boolean (default off)
4207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 {only available when compiled with the |+rightleft|
4209 feature}
4210 When on, the keyboard is mapped for the Hebrew character set.
4211 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4212 toggle this option. See |rileft.txt|.
4213 NOTE: This option is reset when 'compatible' is set.
4214
4215 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4216'hkmapp' 'hkp' boolean (default off)
4217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 {only available when compiled with the |+rightleft|
4219 feature}
4220 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4221 This is useful if you have a non-Hebrew keyboard.
4222 See |rileft.txt|.
4223 NOTE: This option is reset when 'compatible' is set.
4224
Bram Moolenaar036986f2017-03-16 17:41:02 +01004225 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4226'hlsearch' 'hls' boolean (default off)
4227 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004228 {not available when compiled without the
4229 |+extra_search| feature}
4230 When there is a previous search pattern, highlight all its matches.
4231 The type of highlighting used can be set with the 'l' occasion in the
4232 'highlight' option. This uses the "Search" highlight group by
4233 default. Note that only the matching text is highlighted, any offsets
4234 are not applied.
4235 See also: 'incsearch' and |:match|.
4236 When you get bored looking at the highlighted matches, you can turn it
4237 off with |:nohlsearch|. This does not change the option value, as
4238 soon as you use a search command, the highlighting comes back.
4239 'redrawtime' specifies the maximum time spent on finding matches.
4240 When the search pattern can match an end-of-line, Vim will try to
4241 highlight all of the matched text. However, this depends on where the
4242 search starts. This will be the first line in the window or the first
4243 line below a closed fold. A match in a previous line which is not
4244 drawn may not continue in a newly drawn line.
4245 You can specify whether the highlight status is restored on startup
4246 with the 'h' flag in 'viminfo' |viminfo-h|.
4247 NOTE: This option is reset when 'compatible' is set.
4248
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 *'icon'* *'noicon'*
4250'icon' boolean (default off, on when title can be restored)
4251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 When on, the icon text of the window will be set to the value of
4253 'iconstring' (if it is not empty), or to the name of the file
4254 currently being edited. Only the last part of the name is used.
4255 Overridden by the 'iconstring' option.
4256 Only works if the terminal supports setting window icons (currently
4257 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4258 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4259 builtin termcap).
4260 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004261 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004263 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264
4265 *'iconstring'*
4266'iconstring' string (default "")
4267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 When this option is not empty, it will be used for the icon text of
4269 the window. This happens only when the 'icon' option is on.
4270 Only works if the terminal supports setting window icon text
4271 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004272 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 When Vim was compiled with HAVE_X11 defined, the original icon will be
4274 restored if possible |X11|.
4275 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004276 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004278 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 {not available when compiled without the |+statusline| feature}
4280
4281 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4282'ignorecase' 'ic' boolean (default off)
4283 global
4284 Ignore case in search patterns. Also used when searching in the tags
4285 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004286 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 Can be overruled by using "\c" or "\C" in the pattern, see
4288 |/ignorecase|.
4289
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004290 *'imactivatefunc'* *'imaf'*
4291'imactivatefunc' 'imaf' string (default "")
4292 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004293 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004294 activate or deactivate the Input Method. The value can be the name of
4295 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4296 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004297 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004298 The expression will be evaluated in the |sandbox| when set from a
4299 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004300
4301 Example: >
4302 function ImActivateFunc(active)
4303 if a:active
4304 ... do something
4305 else
4306 ... do something
4307 endif
4308 " return value is not used
4309 endfunction
4310 set imactivatefunc=ImActivateFunc
4311<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 *'imactivatekey'* *'imak'*
4313'imactivatekey' 'imak' string (default "")
4314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004316 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 Specifies the key that your Input Method in X-Windows uses for
4318 activation. When this is specified correctly, vim can fully control
4319 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4320 You can't use this option to change the activation key, the option
4321 tells Vim what the key is.
4322 Format:
4323 [MODIFIER_FLAG-]KEY_STRING
4324
4325 These characters can be used for MODIFIER_FLAG (case is ignored):
4326 S Shift key
4327 L Lock key
4328 C Control key
4329 1 Mod1 key
4330 2 Mod2 key
4331 3 Mod3 key
4332 4 Mod4 key
4333 5 Mod5 key
4334 Combinations are allowed, for example "S-C-space" or "SC-space" are
4335 both shift+ctrl+space.
4336 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4337
4338 Example: >
4339 :set imactivatekey=S-space
4340< "S-space" means shift+space. This is the activation key for kinput2 +
4341 canna (Japanese), and ami (Korean).
4342
4343 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4344'imcmdline' 'imc' boolean (default off)
4345 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 When set the Input Method is always on when starting to edit a command
4347 line, unless entering a search pattern (see 'imsearch' for that).
4348 Setting this option is useful when your input method allows entering
4349 English characters directly, e.g., when it's used to type accented
4350 characters with dead keys.
4351
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004352 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 When set the Input Method is never used. This is useful to disable
4356 the IM when it doesn't work properly.
4357 Currently this option is on by default for SGI/IRIX machines. This
4358 may change in later releases.
4359
4360 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004361'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 Specifies whether :lmap or an Input Method (IM) is to be used in
4364 Insert mode. Valid values:
4365 0 :lmap is off and IM is off
4366 1 :lmap is ON and IM is off
4367 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 To always reset the option to zero when leaving Insert mode with <Esc>
4369 this can be used: >
4370 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4371< This makes :lmap and IM turn off automatically when leaving Insert
4372 mode.
4373 Note that this option changes when using CTRL-^ in Insert mode
4374 |i_CTRL-^|.
4375 The value is set to 1 when setting 'keymap' to a valid keymap name.
4376 It is also used for the argument of commands like "r" and "f".
4377 The value 0 may not work correctly with Athena and Motif with some XIM
4378 methods. Use 'imdisable' to disable XIM then.
4379
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004380 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004381 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004382 |+multi_byte_ime| or |global-ime|.
4383
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004385'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 Specifies whether :lmap or an Input Method (IM) is to be used when
4388 entering a search pattern. Valid values:
4389 -1 the value of 'iminsert' is used, makes it look like
4390 'iminsert' is also used when typing a search pattern
4391 0 :lmap is off and IM is off
4392 1 :lmap is ON and IM is off
4393 2 :lmap is off and IM is ON
4394 Note that this option changes when using CTRL-^ in Command-line mode
4395 |c_CTRL-^|.
4396 The value is set to 1 when it is not -1 and setting the 'keymap'
4397 option to a valid keymap name.
4398 The value 0 may not work correctly with Athena and Motif with some XIM
4399 methods. Use 'imdisable' to disable XIM then.
4400
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004401 *'imstatusfunc'* *'imsf'*
4402'imstatusfunc' 'imsf' string (default "")
4403 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004404 This option specifies a function that is called to obtain the status
4405 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004406 The value can be the name of a function, a |lambda| or a |Funcref|.
4407 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004408 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004409
4410 Example: >
4411 function ImStatusFunc()
4412 let is_active = ...do something
4413 return is_active ? 1 : 0
4414 endfunction
4415 set imstatusfunc=ImStatusFunc
4416<
4417 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004418 The expression will be evaluated in the |sandbox| when set from a
4419 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004420
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004421 *'imstyle'* *'imst'*
4422'imstyle' 'imst' number (default 1)
4423 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004424 {only available when compiled with |+xim| and
4425 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004426 This option specifies the input style of Input Method:
4427 0 use on-the-spot style
4428 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004429 See: |xim-input-style|
4430
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004431 For a long time on-the-spot style had been used in the GTK version of
4432 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004433 |single-repeat|, etc. Therefore over-the-spot style becomes the
4434 default now. This should work fine for most people, however if you
4435 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004436 The expression will be evaluated in the |sandbox| when set from a
4437 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004438
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 *'include'* *'inc'*
4440'include' 'inc' string (default "^\s*#\s*include")
4441 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 {not available when compiled without the
4443 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004444 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 pattern, just like for the "/" command (See |pattern|). The default
4446 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004447 "]I", "[d", etc.
4448 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004449 comes after the matched pattern. But if "\zs" appears in the pattern
4450 then the text matched from "\zs" to the end, or until "\ze" if it
4451 appears, is used as the file name. Use this to include characters
4452 that are not in 'isfname', such as a space. You can then use
4453 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004454 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455
4456 *'includeexpr'* *'inex'*
4457'includeexpr' 'inex' string (default "")
4458 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004460 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004462 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 :set includeexpr=substitute(v:fname,'\\.','/','g')
4464< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004465
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004467 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 Also used for |<cfile>|.
4469
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004470 If the expression starts with s: or |<SID>|, then it is replaced with
4471 the script ID (|local-function|). Example: >
4472 set includeexpr=s:MyIncludeExpr(v:fname)
4473 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004474< Otherwise, the expression is evaluated in the context of the script
4475 where the option was set, thus script-local items are available.
4476
Bram Moolenaar30b65812012-07-12 22:01:11 +02004477 The expression will be evaluated in the |sandbox| when set from a
4478 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004479 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004480
4481 It is not allowed to change text or jump to another window while
4482 evaluating 'includeexpr' |textlock|.
4483
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004485'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4486 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004489 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004490 While typing a search command, show where the pattern, as it was typed
4491 so far, matches. The matched string is highlighted. If the pattern
4492 is invalid or not found, nothing is shown. The screen will be updated
4493 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004494 Also applies to the pattern in commands: >
4495 :global
4496 :lvimgrep
4497 :lvimgrepadd
4498 :smagic
4499 :snomagic
4500 :sort
4501 :substitute
4502 :vglobal
4503 :vimgrep
4504 :vimgrepadd
4505< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004506 original position when no match is found and when pressing <Esc>. You
4507 still need to finish the search command with <Enter> to move the
4508 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004509 You can use the CTRL-G and CTRL-T keys to move to the next and
4510 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004511 When compiled with the |+reltime| feature Vim only searches for about
4512 half a second. With a complicated pattern and/or a lot of text the
4513 match may not be found. This is to avoid that Vim hangs while you
4514 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004515 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004516 When 'hlsearch' is on, all matched strings are highlighted too while
4517 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004518 If you don't want to turn 'hlsearch' on, but want to highlight all
4519 matches while searching, you can turn on and off 'hlsearch' with
4520 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004521 augroup vimrc-incsearch-highlight
4522 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004523 autocmd CmdlineEnter /,\? :set hlsearch
4524 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004525 augroup END
4526<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004527 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004528 to the command line. If 'ignorecase' and 'smartcase' are set and the
4529 command line has no uppercase characters, the added character is
4530 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004531 CTRL-R CTRL-W can be used to add the word at the end of the current
4532 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 NOTE: This option is reset when 'compatible' is set.
4534
4535 *'indentexpr'* *'inde'*
4536'indentexpr' 'inde' string (default "")
4537 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 {not available when compiled without the |+cindent|
4539 or |+eval| features}
4540 Expression which is evaluated to obtain the proper indent for a line.
4541 It is used when a new line is created, for the |=| operator and
4542 in Insert mode as specified with the 'indentkeys' option.
4543 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004544 'smartindent' indenting. When 'lisp' is set, this option is
4545 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 When 'paste' is set this option is not used for indenting.
4547 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004548 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004550
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004551 If the expression starts with s: or |<SID>|, then it is replaced with
4552 the script ID (|local-function|). Example: >
4553 set indentexpr=s:MyIndentExpr()
4554 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004555< Otherwise, the expression is evaluated in the context of the script
4556 where the option was set, thus script-local items are available.
4557
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 The expression must return the number of spaces worth of indent. It
4559 can return "-1" to keep the current indent (this means 'autoindent' is
4560 used for the indent).
4561 Functions useful for computing the indent are |indent()|, |cindent()|
4562 and |lispindent()|.
4563 The evaluation of the expression must not have side effects! It must
4564 not change the text, jump to another window, etc. Afterwards the
4565 cursor position is always restored, thus the cursor may be moved.
4566 Normally this option would be set to call a function: >
4567 :set indentexpr=GetMyIndent()
4568< Error messages will be suppressed, unless the 'debug' option contains
4569 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004570 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004571 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572
Bram Moolenaar30b65812012-07-12 22:01:11 +02004573 The expression will be evaluated in the |sandbox| when set from a
4574 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004575 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004576
4577 It is not allowed to change text or jump to another window while
4578 evaluating 'indentexpr' |textlock|.
4579
4580
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004582'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 {not available when compiled without the |+cindent|
4585 feature}
4586 A list of keys that, when typed in Insert mode, cause reindenting of
4587 the current line. Only happens if 'indentexpr' isn't empty.
4588 The format is identical to 'cinkeys', see |indentkeys-format|.
4589 See |C-indenting| and |indent-expression|.
4590
4591 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4592'infercase' 'inf' boolean (default off)
4593 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004595 'ignorecase' is also on, the case of the match is adjusted depending
4596 on the typed text. If the typed text contains a lowercase letter
4597 where the match has an upper case letter, the completed part is made
4598 lowercase. If the typed text has no lowercase letters and the match
4599 has a lowercase letter where the typed text has an uppercase letter,
4600 and there is a letter before it, the completed part is made uppercase.
4601 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602
4603 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4604'insertmode' 'im' boolean (default off)
4605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 Makes Vim work in a way that Insert mode is the default mode. Useful
4607 if you want to use Vim as a modeless editor. Used for |evim|.
4608 These Insert mode commands will be useful:
4609 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004610 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 this is a mapping, it is executed as if 'insertmode' was off.
4612 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004614 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4615 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616
4617 These items change when 'insertmode' is set:
4618 - when starting to edit of a file, Vim goes to Insert mode.
4619 - <Esc> in Insert mode is a no-op and beeps.
4620 - <Esc> in Normal mode makes Vim go to Insert mode.
4621 - CTRL-L in Insert mode is a command, it is not inserted.
4622 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4623 However, when <Esc> is used inside a mapping, it behaves like
4624 'insertmode' was not set. This was done to be able to use the same
4625 mappings with 'insertmode' set or not set.
4626 When executing commands with |:normal| 'insertmode' is not used.
4627
4628 NOTE: This option is reset when 'compatible' is set.
4629
4630 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004631'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4633 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4634 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4635 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4636 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 The characters specified by this option are included in file names and
4639 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004640 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 Multi-byte characters 256 and above are always included, only the
4642 characters up to 255 are specified with this option.
4643 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004644 Think twice before adding white space to this option. Although a
4645 space may appear inside a file name, the effect will be that Vim
4646 doesn't know where a file name starts or ends when doing completion.
4647 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648
4649 Note that on systems using a backslash as path separator, Vim tries to
4650 do its best to make it work as you would expect. That is a bit
4651 tricky, since Vi originally used the backslash to escape special
4652 characters. Vim will not remove a backslash in front of a normal file
4653 name character on these systems, but it will on Unix and alikes. The
4654 '&' and '^' are not included by default, because these are special for
4655 cmd.exe.
4656
4657 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004658 Each part can be a single character number or a range. A range is two
4659 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660 decimal number between 0 and 255 or the ASCII character itself (does
4661 not work for digits). Example:
4662 "_,-,128-140,#-43" (include '_' and '-' and the range
4663 128 to 140 and '#' to 43)
4664 If a part starts with '^', the following character number or range
4665 will be excluded from the option. The option is interpreted from left
4666 to right. Put the excluded character after the range where it is
4667 included. To include '^' itself use it as the last character of the
4668 option or the end of a range. Example:
4669 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4670 If the character is '@', all characters where isalpha() returns TRUE
4671 are included. Normally these are the characters a to z and A to Z,
4672 plus accented characters. To include '@' itself use "@-@". Examples:
4673 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004674 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 "a-z,A-Z,@-@" All letters plus the '@' character.
4676 A comma can be included by using it where a character number is
4677 expected. Example:
4678 "48-57,,,_" Digits, comma and underscore.
4679 A comma can be excluded by prepending a '^'. Example:
4680 " -~,^,,9" All characters from space to '~', excluding
4681 comma, plus <Tab>.
4682 See |option-backslash| about including spaces and backslashes.
4683
4684 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004685'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 "@,48-57,_,128-167,224-235"
4687 otherwise: "@,48-57,_,192-255")
4688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 The characters given by this option are included in identifiers.
4690 Identifiers are used in recognizing environment variables and after a
4691 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004692 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004693 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004695 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4697
4698 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004699'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 "@,48-57,_,128-167,224-235"
4701 otherwise: "@,48-57,_,192-255"
4702 Vi default: "@,48-57,_")
4703 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004705 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004706 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004707 characters above 255 check the "word" character class (any character
4708 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004709 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 For a help file it is set to all non-blank printable characters except
4711 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4712 command).
4713 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004714 This option also influences syntax highlighting, unless the syntax
4715 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716 NOTE: This option is set to the Vi default value when 'compatible' is
4717 set and to the Vim default value when 'compatible' is reset.
4718
4719 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004720'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 "@,~-255"; otherwise: "@,161-255")
4722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 The characters given by this option are displayed directly on the
4724 screen. It is also used for "\p" in a |pattern|. The characters from
4725 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4726 even when they are not included in 'isprint' or excluded. See
4727 'isfname' for a description of the format of this option.
4728
4729 Non-printable characters are displayed with two characters:
4730 0 - 31 "^@" - "^_"
4731 32 - 126 always single characters
4732 127 "^?"
4733 128 - 159 "~@" - "~_"
4734 160 - 254 "| " - "|~"
4735 255 "~?"
4736 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4737 displayed as <xx>, with the hexadecimal value of the byte.
4738 When 'display' contains "uhex" all unprintable characters are
4739 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004740 The SpecialKey highlighting will be used for unprintable characters.
4741 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742
4743 Multi-byte characters 256 and above are always included, only the
4744 characters up to 255 are specified with this option. When a character
4745 is printable but it is not available in the current font, a
4746 replacement character will be shown.
4747 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4748 There is no option to specify these characters.
4749
4750 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4751'joinspaces' 'js' boolean (default on)
4752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 Insert two spaces after a '.', '?' and '!' with a join command.
4754 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4755 Otherwise only one space is inserted.
4756 NOTE: This option is set when 'compatible' is set.
4757
4758 *'key'*
4759'key' string (default "")
4760 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004761 {only available when compiled with the |+cryptv|
4762 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004764 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 Careful: Do not set the key value by hand, someone might see the typed
4766 key. Use the |:X| command. But you can make 'key' empty: >
4767 :set key=
4768< It is not possible to get the value of this option with ":set key" or
4769 "echo &key". This is to avoid showing it to someone who shouldn't
4770 know. It also means you cannot see it yourself once you have set it,
4771 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004772 You can use "&key" in an expression to detect whether encryption is
4773 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774
4775 *'keymap'* *'kmp'* *E544*
4776'keymap' 'kmp' string (default "")
4777 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 {only available when compiled with the |+keymap|
4779 feature}
4780 Name of a keyboard mapping. See |mbyte-keymap|.
4781 Setting this option to a valid keymap name has the side effect of
4782 setting 'iminsert' to one, so that the keymap becomes effective.
4783 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004784 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785
4786 *'keymodel'* *'km'*
4787'keymodel' 'km' string (default "")
4788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 List of comma separated words, which enable special things that keys
4790 can do. These values can be used:
4791 startsel Using a shifted special key starts selection (either
4792 Select mode or Visual mode, depending on "key" being
4793 present in 'selectmode').
4794 stopsel Using a not-shifted special key stops selection.
4795 Special keys in this context are the cursor keys, <End>, <Home>,
4796 <PageUp> and <PageDown>.
4797 The 'keymodel' option is set by the |:behave| command.
4798
4799 *'keywordprg'* *'kp'*
4800'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004801 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 Program to use for the |K| command. Environment variables are
4804 expanded |:set_env|. ":help" may be used to access the Vim internal
4805 help. (Note that previously setting the global option to the empty
4806 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004807 When the first character is ":", the command is invoked as a Vim
4808 Ex command prefixed with [count].
4809 When "man", "man -s" or an Ex command is used, Vim will automatically
4810 translate a count for the "K" command and pass it as the first
4811 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 See |option-backslash| about including spaces and backslashes.
4813 Example: >
4814 :set keywordprg=man\ -s
4815< This option cannot be set from a |modeline| or in the |sandbox|, for
4816 security reasons.
4817
4818 *'langmap'* *'lmap'* *E357* *E358*
4819'langmap' 'lmap' string (default "")
4820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 {only available when compiled with the |+langmap|
4822 feature}
4823 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004824 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004825 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 care of translating these special characters to the original meaning
4827 of the key. This means you don't have to change the keyboard mode to
4828 be able to execute Normal mode commands.
4829 This is the opposite of the 'keymap' option, where characters are
4830 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004831 Also consider setting 'langremap' to off, to prevent 'langmap' from
4832 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004833 This option cannot be set from a |modeline| or in the |sandbox|, for
4834 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004836 Example (for Greek, in UTF-8): *greek* >
4837 :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 +00004838< Example (exchanges meaning of z and y for commands): >
4839 :set langmap=zy,yz,ZY,YZ
4840<
4841 The 'langmap' option is a list of parts, separated with commas. Each
4842 part can be in one of two forms:
4843 1. A list of pairs. Each pair is a "from" character immediately
4844 followed by the "to" character. Examples: "aA", "aAbBcC".
4845 2. A list of "from" characters, a semi-colon and a list of "to"
4846 characters. Example: "abc;ABC"
4847 Example: "aA,fgh;FGH,cCdDeE"
4848 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004849 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850
4851 This will allow you to activate vim actions without having to switch
4852 back and forth between the languages. Your language characters will
4853 be understood as normal vim English characters (according to the
4854 langmap mappings) in the following cases:
4855 o Normal/Visual mode (commands, buffer/register names, user mappings)
4856 o Insert/Replace Mode: Register names after CTRL-R
4857 o Insert/Replace Mode: Mappings
4858 Characters entered in Command-line mode will NOT be affected by
4859 this option. Note that this option can be changed at any time
4860 allowing to switch between mappings for different languages/encodings.
4861 Use a mapping to avoid having to type it each time!
4862
4863 *'langmenu'* *'lm'*
4864'langmenu' 'lm' string (default "")
4865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 {only available when compiled with the |+menu| and
4867 |+multi_lang| features}
4868 Language to use for menu translation. Tells which file is loaded
4869 from the "lang" directory in 'runtimepath': >
4870 "lang/menu_" . &langmenu . ".vim"
4871< (without the spaces). For example, to always use the Dutch menus, no
4872 matter what $LANG is set to: >
4873 :set langmenu=nl_NL.ISO_8859-1
4874< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004875 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 If your $LANG is set to a non-English language but you do want to use
4877 the English menus: >
4878 :set langmenu=none
4879< This option must be set before loading menus, switching on filetype
4880 detection or syntax highlighting. Once the menus are defined setting
4881 this option has no effect. But you could do this: >
4882 :source $VIMRUNTIME/delmenu.vim
4883 :set langmenu=de_DE.ISO_8859-1
4884 :source $VIMRUNTIME/menu.vim
4885< Warning: This deletes all menus that you defined yourself!
4886
Bram Moolenaard94464e2015-11-02 15:28:18 +01004887 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004888'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004889 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004890 {only available when compiled with the |+langmap|
4891 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004892 This is just like 'langremap' but with the value inverted. It only
4893 exists for backwards compatibility. When setting 'langremap' then
4894 'langnoremap' is set to the inverted value, and the other way around.
4895
4896 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004897'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004898 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004899 {only available when compiled with the |+langmap|
4900 feature}
4901 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004902 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004903 'langmap' disables some of your mappings, try resetting this option.
4904 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004905 that works for you to avoid mappings to break.
4906
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 *'laststatus'* *'ls'*
4908'laststatus' 'ls' number (default 1)
4909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 The value of this option influences when the last window will have a
4911 status line:
4912 0: never
4913 1: only if there are at least two windows
4914 2: always
4915 The screen looks nicer with a status line if you have several
4916 windows, but it takes another screen line. |status-line|
4917
4918 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4919'lazyredraw' 'lz' boolean (default off)
4920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 When this option is set, the screen will not be redrawn while
4922 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004923 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 update use |:redraw|.
4925
4926 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4927'linebreak' 'lbr' boolean (default off)
4928 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004929 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004931 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 than at the last character that fits on the screen. Unlike
4933 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004934 it only affects the way the file is displayed, not its contents.
4935 If 'breakindent' is set, line is visually indented. Then, the value
4936 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004937 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 Note that <Tab> characters after an <EOL> are mostly not displayed
4939 with the right amount of white space.
4940
4941 *'lines'* *E593*
4942'lines' number (default 24 or terminal height)
4943 global
4944 Number of lines of the Vim window.
4945 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004946 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 When Vim is running in the GUI or in a resizable window, setting this
4948 option will cause the window size to be changed. When you only want
4949 to use the size for the GUI, put the command in your |gvimrc| file.
4950 Vim limits the number of lines to what fits on the screen. You can
4951 use this command to get the tallest window possible: >
4952 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004953< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004954 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 When you set this option and Vim is unable to change the physical
4956 number of lines of the display, the display may be messed up.
4957
4958 *'linespace'* *'lsp'*
4959'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 {only in the GUI}
4962 Number of pixel lines inserted between characters. Useful if the font
4963 uses the full character cell height, making lines touch each other.
4964 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004965 With some fonts there can be too much room between lines (to have
4966 space for ascents and descents). Then it makes sense to set
4967 'linespace' to a negative value. This may cause display problems
4968 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969
4970 *'lisp'* *'nolisp'*
4971'lisp' boolean (default off)
4972 local to buffer
4973 {not available when compiled without the |+lispindent|
4974 feature}
4975 Lisp mode: When <Enter> is typed in insert mode set the indent for
4976 the next line to Lisp standards (well, sort of). Also happens with
4977 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4978 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4979 better. Also see 'lispwords'.
4980 The '-' character is included in keyword characters. Redefines the
4981 "=" operator to use this same indentation algorithm rather than
4982 calling an external program if 'equalprg' is empty.
4983 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984
4985 *'lispwords'* *'lw'*
4986'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004987 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 {not available when compiled without the |+lispindent|
4989 feature}
4990 Comma separated list of words that influence the Lisp indenting.
4991 |'lisp'|
4992
4993 *'list'* *'nolist'*
4994'list' boolean (default off)
4995 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004996 List mode: By default show tabs as CTRL-I is displayed, display $
4997 after end of line. Useful to see the difference between tabs and
4998 spaces and for trailing blanks. Further changed by the 'listchars'
4999 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005000
5001 The cursor is displayed at the start of the space a Tab character
5002 occupies, not at the end as usual in Normal mode. To get this cursor
5003 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005004 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005005<
5006 Note that list mode will also affect formatting (set with 'textwidth'
5007 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 changing the way tabs are displayed.
5009
5010 *'listchars'* *'lcs'*
5011'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005012 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005013 Strings to use in 'list' mode and for the |:list| command. It is a
5014 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005015 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 eol:c Character to show at the end of each line. When
5017 omitted, there is no extra character at the end of the
5018 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005019 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005020 tab:xy[z] Two or three characters to be used to show a tab.
5021 The third character is optional.
5022
5023 tab:xy The 'x' is always used, then 'y' as many times as will
5024 fit. Thus "tab:>-" displays:
5025 >
5026 >-
5027 >--
5028 etc.
5029
5030 tab:xyz The 'z' is always used, then 'x' is prepended, and
5031 then 'y' is used as many times as will fit. Thus
5032 "tab:<->" displays:
5033 >
5034 <>
5035 <->
5036 <-->
5037 etc.
5038
5039 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005040 *lcs-space*
5041 space:c Character to show for a space. When omitted, spaces
5042 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005043 *lcs-multispace*
5044 multispace:c...
5045 One or more characters to use cyclically to show for
5046 multiple consecutive spaces. Overrides the "space"
5047 setting, except for single spaces. When omitted, the
5048 "space" setting is used. For example,
5049 `:set listchars=multispace:---+` shows ten consecutive
5050 spaces as:
5051 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005052 *lcs-lead*
5053 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005054 leading spaces are blank. Overrides the "space" and
5055 "multispace" settings for leading spaces. You can
5056 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005057 :set listchars+=tab:>-,lead:.
5058< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005059 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005060 trailing spaces are blank. Overrides the "space" and
5061 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005062 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 extends:c Character to show in the last column, when 'wrap' is
5064 off and the line continues beyond the right of the
5065 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005066 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005067 precedes:c Character to show in the first visible column of the
5068 physical line, when there is text preceding the
5069 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005070 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005071 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005072 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005073 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005074 nbsp:c Character to show for a non-breakable space character
5075 (0xA0 (160 decimal) and U+202F). Left blank when
5076 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005078 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005080 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005082 Each character can be specified as hex: >
5083 set listchars=eol:\\x24
5084 set listchars=eol:\\u21b5
5085 set listchars=eol:\\U000021b5
5086< Note that a double backslash is used. The number of hex characters
5087 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5088
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 Examples: >
5090 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005091 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 :set lcs=extends:>,precedes:<
5093< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005094 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5095 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005096 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097
5098 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5099'loadplugins' 'lpl' boolean (default on)
5100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 When on the plugin scripts are loaded when starting up |load-plugins|.
5102 This option can be reset in your |vimrc| file to disable the loading
5103 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005104 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5105 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106
Bram Moolenaard94464e2015-11-02 15:28:18 +01005107 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005108'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005109 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005110 {only available when compiled with the |+lua/dyn|
5111 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005112 Specifies the name of the Lua shared library. The default is
5113 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005114 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005115 This option cannot be set from a |modeline| or in the |sandbox|, for
5116 security reasons.
5117
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005118 *'macatsui'* *'nomacatsui'*
5119'macatsui' boolean (default on)
5120 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005121 {not supported}
5122 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005123
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 *'magic'* *'nomagic'*
5125'magic' boolean (default on)
5126 global
5127 Changes the special characters that can be used in search patterns.
5128 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005129 WARNING: Switching this option off most likely breaks plugins! That
5130 is because many patterns assume it's on and will fail when it's off.
5131 Only switch it off when working with old Vi scripts. In any other
5132 situation write patterns that work when 'magic' is on. Include "\M"
5133 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005134 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5135 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136
5137 *'makeef'* *'mef'*
5138'makeef' 'mef' string (default: "")
5139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 {not available when compiled without the |+quickfix|
5141 feature}
5142 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5143 and the |:grep| command.
5144 When it is empty, an internally generated temp file will be used.
5145 When "##" is included, it is replaced by a number to make the name
5146 unique. This makes sure that the ":make" command doesn't overwrite an
5147 existing file.
5148 NOT used for the ":cf" command. See 'errorfile' for that.
5149 Environment variables are expanded |:set_env|.
5150 See |option-backslash| about including spaces and backslashes.
5151 This option cannot be set from a |modeline| or in the |sandbox|, for
5152 security reasons.
5153
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005154 *'makeencoding'* *'menc'*
5155'makeencoding' 'menc' string (default "")
5156 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005157 Encoding used for reading the output of external commands. When empty,
5158 encoding is not converted.
5159 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5160 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5161 and `:laddfile`.
5162
5163 This would be mostly useful when you use MS-Windows and set 'encoding'
5164 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5165 'makeencoding' to "char" has the same effect as setting to the system
5166 locale encoding. Example: >
5167 :set encoding=utf-8
5168 :set makeencoding=char " system locale is used
5169<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 *'makeprg'* *'mp'*
5171'makeprg' 'mp' string (default "make", VMS: "MMS")
5172 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005173 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005174 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5175 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005176 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005177 Environment variables are expanded |:set_env|. See |option-backslash|
5178 about including spaces and backslashes.
5179 Note that a '|' must be escaped twice: once for ":set" and once for
5180 the interpretation of a command. When you use a filter called
5181 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 :set makeprg=gmake\ \\\|\ myfilter
5183< The placeholder "$*" can be given (even multiple times) to specify
5184 where the arguments will be included, for example: >
5185 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5186< This option cannot be set from a |modeline| or in the |sandbox|, for
5187 security reasons.
5188
5189 *'matchpairs'* *'mps'*
5190'matchpairs' 'mps' string (default "(:),{:},[:]")
5191 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005193 other.
5194 Only character pairs are allowed that are different, thus you cannot
5195 jump between two double quotes.
5196 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005197 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005198 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 :set mps+=<:>
5200
5201< A more exotic example, to jump between the '=' and ';' in an
5202 assignment, useful for languages like C and Java: >
5203 :au FileType c,cpp,java set mps+==:;
5204
5205< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005206 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207
5208 *'matchtime'* *'mat'*
5209'matchtime' 'mat' number (default 5)
5210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 Tenths of a second to show the matching paren, when 'showmatch' is
5212 set. Note that this is not in milliseconds, like other options that
5213 set a time. This is to be compatible with Nvi.
5214
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005215 *'maxcombine'* *'mco'*
5216'maxcombine' 'mco' number (default 2)
5217 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005218 The maximum number of combining characters supported for displaying.
5219 Only used when 'encoding' is "utf-8".
5220 The default is OK for most languages. Hebrew may require 4.
5221 Maximum value is 6.
5222 Even when this option is set to 2 you can still edit text with more
5223 combining characters, you just can't see them. Use |g8| or |ga|.
5224 See |mbyte-combining|.
5225
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 *'maxfuncdepth'* *'mfd'*
5227'maxfuncdepth' 'mfd' number (default 100)
5228 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005229 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005230 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 Maximum depth of function calls for user functions. This normally
5232 catches endless recursion. When using a recursive function with
5233 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5234 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005235 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005236 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 See also |:function|.
5238
5239 *'maxmapdepth'* *'mmd'* *E223*
5240'maxmapdepth' 'mmd' number (default 1000)
5241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 Maximum number of times a mapping is done without resulting in a
5243 character to be used. This normally catches endless mappings, like
5244 ":map x y" with ":map y x". It still does not catch ":map g wg",
5245 because the 'w' is used before the next mapping is done. See also
5246 |key-mapping|.
5247
5248 *'maxmem'* *'mm'*
5249'maxmem' 'mm' number (default between 256 to 5120 (system
5250 dependent) or half the amount of memory
5251 available)
5252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5254 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005255 other memory to be freed.
5256 The maximum usable value is about 2000000. Use this to work without a
5257 limit.
5258 The value is ignored when 'swapfile' is off.
5259 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005261 *'maxmempattern'* *'mmp'*
5262'maxmempattern' 'mmp' number (default 1000)
5263 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005264 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005265 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005266 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005267 When Vim runs into the limit it gives an error message and mostly
5268 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005269 Running into the limit often means that the pattern is very
5270 inefficient or too complex. This may already happen with the pattern
5271 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005272 Might also happen on redraw, when syntax rules try to match a complex
5273 text structure.
5274 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5275 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005276
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 *'maxmemtot'* *'mmt'*
5278'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5279 dependent) or half the amount of memory
5280 available)
5281 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005282 Maximum amount of memory in Kbyte to use for all buffers together.
5283 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005284 without a limit.
5285 On 64 bit machines higher values might work. But hey, do you really
5286 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005287 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005288 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005289 Buffers with 'swapfile' off still count to the total amount of memory
5290 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005291 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292
5293 *'menuitems'* *'mis'*
5294'menuitems' 'mis' number (default 25)
5295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 {not available when compiled without the |+menu|
5297 feature}
5298 Maximum number of items to use in a menu. Used for menus that are
5299 generated from a list of items, e.g., the Buffers menu. Changing this
5300 option has no direct effect, the menu must be refreshed first.
5301
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005302 *'mkspellmem'* *'msm'*
5303'mkspellmem' 'msm' string (default "460000,2000,500")
5304 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005305 {not available when compiled without the |+syntax|
5306 feature}
5307 Parameters for |:mkspell|. This tunes when to start compressing the
5308 word tree. Compression can be slow when there are many words, but
5309 it's needed to avoid running out of memory. The amount of memory used
5310 per word depends very much on how similar the words are, that's why
5311 this tuning is complicated.
5312
5313 There are three numbers, separated by commas:
5314 {start},{inc},{added}
5315
5316 For most languages the uncompressed word tree fits in memory. {start}
5317 gives the amount of memory in Kbyte that can be used before any
5318 compression is done. It should be a bit smaller than the amount of
5319 memory that is available to Vim.
5320
5321 When going over the {start} limit the {inc} number specifies the
5322 amount of memory in Kbyte that can be allocated before another
5323 compression is done. A low number means compression is done after
5324 less words are added, which is slow. A high number means more memory
5325 will be allocated.
5326
5327 After doing compression, {added} times 1024 words can be added before
5328 the {inc} limit is ignored and compression is done when any extra
5329 amount of memory is needed. A low number means there is a smaller
5330 chance of hitting the {inc} limit, less memory is used but it's
5331 slower.
5332
5333 The languages for which these numbers are important are Italian and
5334 Hungarian. The default works for when you have about 512 Mbyte. If
5335 you have 1 Gbyte you could use: >
5336 :set mkspellmem=900000,3000,800
5337< If you have less than 512 Mbyte |:mkspell| may fail for some
5338 languages, no matter what you set 'mkspellmem' to.
5339
Bram Moolenaar07607392019-05-26 19:20:43 +02005340 This option cannot be set from a |modeline| or in the |sandbox|.
5341
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005343'modeline' 'ml' boolean (Vim default: on (off for root),
5344 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005346 If 'modeline' is on 'modelines' gives the number of lines that is
5347 checked for set commands. If 'modeline' is off or 'modelines' is zero
5348 no lines are checked. See |modeline|.
5349
5350 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5351'modelineexpr' 'mle' boolean (default: off)
5352 global
5353 When on allow some options that are an expression to be set in the
5354 modeline. Check the option for whether it is affected by
5355 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005356 This option cannot be set from a |modeline| or in the |sandbox|, for
5357 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005358
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 *'modelines'* *'mls'*
5360'modelines' 'mls' number (default 5)
5361 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 If 'modeline' is on 'modelines' gives the number of lines that is
5363 checked for set commands. If 'modeline' is off or 'modelines' is zero
5364 no lines are checked. See |modeline|.
5365 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5366 set and to the Vim default value when 'compatible' is reset.
5367
5368 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005369 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370'modifiable' 'ma' boolean (default on)
5371 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 When off the buffer contents cannot be changed. The 'fileformat' and
5373 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005374 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375
5376 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5377'modified' 'mod' boolean (default off)
5378 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 When on, the buffer is considered to be modified. This option is set
5380 when:
5381 1. A change was made to the text since it was last written. Using the
5382 |undo| command to go back to the original text will reset the
5383 option. But undoing changes that were made before writing the
5384 buffer will set the option again, since the text is different from
5385 when it was written.
5386 2. 'fileformat' or 'fileencoding' is different from its original
5387 value. The original value is set when the buffer is read or
5388 written. A ":set nomodified" command also resets the original
5389 values to the current values and the 'modified' option will be
5390 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005391 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005392 This option is not set when a change is made to the buffer as the
5393 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5394 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5395 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5397 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005398 Note that the text may actually be the same, e.g. 'modified' is set
5399 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400
5401 *'more'* *'nomore'*
5402'more' boolean (Vim default: on, Vi default: off)
5403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 When on, listings pause when the whole screen is filled. You will get
5405 the |more-prompt|. When this option is off there are no pauses, the
5406 listing continues until finished.
5407 NOTE: This option is set to the Vi default value when 'compatible' is
5408 set and to the Vim default value when 'compatible' is reset.
5409
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005410 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005411'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005412 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005414 Enable the use of the mouse. Works for most terminals (xterm, Win32
5415 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5416 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5417 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005418 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 v Visual mode
5420 i Insert mode
5421 c Command-line mode
5422 h all previous modes when editing a help file
5423 a all previous modes
5424 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005425 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005427< If your terminal can't overrule the mouse events going to the
5428 application, use: >
5429 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005430< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005431 back to Vim using the mouse events.
5432 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5433 "xterm".
5434
5435 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 modeless selection. This doesn't move the text cursor.
5437
5438 See |mouse-using|. Also see |'clipboard'|.
5439
5440 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005441 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 the mouse buttons can still be used by keeping the shift key pressed.
5443 Also see the 'clipboard' option.
5444
5445 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5446'mousefocus' 'mousef' boolean (default off)
5447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 {only works in the GUI}
5449 The window that the mouse pointer is on is automatically activated.
5450 When changing the window layout or window focus in another way, the
5451 mouse pointer is moved to the window with keyboard focus. Off is the
5452 default because it makes using the pull down menus a little goofy, as
5453 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005454 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005455 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456
5457 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5458'mousehide' 'mh' boolean (default on)
5459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 {only works in the GUI}
5461 When on, the mouse pointer is hidden when characters are typed.
5462 The mouse pointer is restored when the mouse is moved.
5463
5464 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005465'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 Sets the model to use for the mouse. The name mostly specifies what
5468 the right mouse button is used for:
5469 extend Right mouse button extends a selection. This works
5470 like in an xterm.
5471 popup Right mouse button pops up a menu. The shifted left
5472 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005473 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 popup_setpos Like "popup", but the cursor will be moved to the
5475 position where the mouse was clicked, and thus the
5476 selected operation will act upon the clicked object.
5477 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005478 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 course, that right clicking outside a selection will
5480 end Visual mode.
5481 Overview of what button does what for each model:
5482 mouse extend popup(_setpos) ~
5483 left click place cursor place cursor
5484 left drag start selection start selection
5485 shift-left search word extend selection
5486 right click extend selection popup menu (place cursor)
5487 right drag extend selection -
5488 middle click paste paste
5489
5490 In the "popup" model the right mouse button produces a pop-up menu.
5491 You need to define this first, see |popup-menu|.
5492
5493 Note that you can further refine the meaning of buttons with mappings.
5494 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5495 selection (because that's handled in the GUI code directly).
5496
5497 The 'mousemodel' option is set by the |:behave| command.
5498
5499 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005500'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5501 vs:leftright,vd:lrsizing,m:no,
5502 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 {only available when compiled with the |+mouseshape|
5505 feature}
5506 This option tells Vim what the mouse pointer should look like in
5507 different modes. The option is a comma separated list of parts, much
5508 like used for 'guicursor'. Each part consist of a mode/location-list
5509 and an argument-list:
5510 mode-list:shape,mode-list:shape,..
5511 The mode-list is a dash separated list of these modes/locations:
5512 In a normal window: ~
5513 n Normal mode
5514 v Visual mode
5515 ve Visual mode with 'selection' "exclusive" (same as 'v',
5516 if not specified)
5517 o Operator-pending mode
5518 i Insert mode
5519 r Replace mode
5520
5521 Others: ~
5522 c appending to the command-line
5523 ci inserting in the command-line
5524 cr replacing in the command-line
5525 m at the 'Hit ENTER' or 'More' prompts
5526 ml idem, but cursor in the last line
5527 e any mode, pointer below last window
5528 s any mode, pointer on a status line
5529 sd any mode, while dragging a status line
5530 vs any mode, pointer on a vertical separator line
5531 vd any mode, while dragging a vertical separator line
5532 a everywhere
5533
5534 The shape is one of the following:
5535 avail name looks like ~
5536 w x arrow Normal mouse pointer
5537 w x blank no pointer at all (use with care!)
5538 w x beam I-beam
5539 w x updown up-down sizing arrows
5540 w x leftright left-right sizing arrows
5541 w x busy The system's usual busy pointer
5542 w x no The system's usual 'no input' pointer
5543 x udsizing indicates up-down resizing
5544 x lrsizing indicates left-right resizing
5545 x crosshair like a big thin +
5546 x hand1 black hand
5547 x hand2 white hand
5548 x pencil what you write with
5549 x question big ?
5550 x rightup-arrow arrow pointing right-up
5551 w x up-arrow arrow pointing up
5552 x <number> any X11 pointer number (see X11/cursorfont.h)
5553
5554 The "avail" column contains a 'w' if the shape is available for Win32,
5555 x for X11.
5556 Any modes not specified or shapes not available use the normal mouse
5557 pointer.
5558
5559 Example: >
5560 :set mouseshape=s:udsizing,m:no
5561< will make the mouse turn to a sizing arrow over the status lines and
5562 indicate no input when the hit-enter prompt is displayed (since
5563 clicking the mouse has no effect in this state.)
5564
5565 *'mousetime'* *'mouset'*
5566'mousetime' 'mouset' number (default 500)
5567 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005568 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 time in msec between two mouse clicks for the second click to be
5570 recognized as a multi click.
5571
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005572 *'mzschemedll'*
5573'mzschemedll' string (default depends on the build)
5574 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005575 {only available when compiled with the |+mzscheme/dyn|
5576 feature}
5577 Specifies the name of the MzScheme shared library. The default is
5578 DYNAMIC_MZSCH_DLL which was specified at compile time.
5579 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005580 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005581 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005582 This option cannot be set from a |modeline| or in the |sandbox|, for
5583 security reasons.
5584
5585 *'mzschemegcdll'*
5586'mzschemegcdll' string (default depends on the build)
5587 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005588 {only available when compiled with the |+mzscheme/dyn|
5589 feature}
5590 Specifies the name of the MzScheme GC shared library. The default is
5591 DYNAMIC_MZGC_DLL which was specified at compile time.
5592 The value can be equal to 'mzschemedll' if it includes the GC code.
5593 Environment variables are expanded |:set_env|.
5594 This option cannot be set from a |modeline| or in the |sandbox|, for
5595 security reasons.
5596
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005597 *'mzquantum'* *'mzq'*
5598'mzquantum' 'mzq' number (default 100)
5599 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005600 {not available when compiled without the |+mzscheme|
5601 feature}
5602 The number of milliseconds between polls for MzScheme threads.
5603 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005604 NOTE: This option is set to the Vim default value when 'compatible'
5605 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005606
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005608'nrformats' 'nf' string (default "bin,octal,hex",
5609 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611 This defines what bases Vim will consider for numbers when using the
5612 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5613 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005614 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005616 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005617 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005619 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 considered to be hexadecimal. Example: Using CTRL-X on
5621 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005622 bin If included, numbers starting with "0b" or "0B" will be
5623 considered to be binary. Example: Using CTRL-X on
5624 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005625 unsigned If included, numbers are recognized as unsigned. Thus a
5626 leading dash or negative sign won't be considered as part of
5627 the number. Examples:
5628 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5629 (without "unsigned" it would become "9-2021").
5630 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5631 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005632 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5633 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 Numbers which simply begin with a digit in the range 1-9 are always
5635 considered decimal. This also happens for numbers that are not
5636 recognized as octal or hex.
5637
5638 *'number'* *'nu'* *'nonumber'* *'nonu'*
5639'number' 'nu' boolean (default off)
5640 local to window
5641 Print the line number in front of each line. When the 'n' option is
5642 excluded from 'cpoptions' a wrapped line will not use the column of
5643 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005644 The 'numberwidth' option can be used to set the room used for the line
5645 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 When a long, wrapped line doesn't start with the first character, '-'
5647 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005648 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5649 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005650 *number_relativenumber*
5651 The 'relativenumber' option changes the displayed number to be
5652 relative to the cursor. Together with 'number' there are these
5653 four combinations (cursor in line 3):
5654
Bram Moolenaar3848e002016-03-19 18:42:29 +01005655 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005656 'nornu' 'nornu' 'rnu' 'rnu'
5657
5658 |apple | 1 apple | 2 apple | 2 apple
5659 |pear | 2 pear | 1 pear | 1 pear
5660 |nobody | 3 nobody | 0 nobody |3 nobody
5661 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005663 *'numberwidth'* *'nuw'*
5664'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5665 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005666 {only available when compiled with the |+linebreak|
5667 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005668 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005669 when the 'number' or 'relativenumber' option is set or printing lines
5670 with a line number. Since one space is always between the number and
5671 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005672 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005673 fit the highest line number in the buffer respectively the number of
5674 rows in the window, depending on whether 'number' or 'relativenumber'
5675 is set. Thus with the Vim default of 4 there is room for a line number
5676 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005677 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005678 NOTE: This option is set to the Vi default value when 'compatible' is
5679 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005680
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005681 *'omnifunc'* *'ofu'*
5682'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005683 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005684 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005685 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005686 This option specifies a function to be used for Insert mode omni
5687 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005688 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005689 invoked and what it should return. The value can be the name of a
5690 function, a |lambda| or a |Funcref|. See |option-value-function| for
5691 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005692 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005693 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005694 This option cannot be set from a |modeline| or in the |sandbox|, for
5695 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005696
5697
Bram Moolenaar02467872007-05-06 13:22:01 +00005698 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005699'opendevice' 'odev' boolean (default off)
5700 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005701 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005702 Enable reading and writing from devices. This may get Vim stuck on a
5703 device that can be opened but doesn't actually do the I/O. Therefore
5704 it is off by default.
5705 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5706 result in editing a device.
5707
5708
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005709 *'operatorfunc'* *'opfunc'*
5710'operatorfunc' 'opfunc' string (default: empty)
5711 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005712 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005713 See |:map-operator| for more info and an example. The value can be
5714 the name of a function, a |lambda| or a |Funcref|. See
5715 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005716
5717 This option cannot be set from a |modeline| or in the |sandbox|, for
5718 security reasons.
5719
5720
Bram Moolenaar251e1912011-06-19 05:09:16 +02005721 *'osfiletype'* *'oft'*
5722'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005724 This option was supported on RISC OS, which has been removed.
5725
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005727 *'packpath'* *'pp'*
5728'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005729 Directories used to find packages. See |packages|.
5730
5731
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005733'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 global
5735 Specifies the nroff macros that separate paragraphs. These are pairs
5736 of two letters (see |object-motions|).
5737
5738 *'paste'* *'nopaste'*
5739'paste' boolean (default off)
5740 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005741 Put Vim in Paste mode. This is useful if you want to cut or copy
5742 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 unexpected effects.
5744 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005745 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 knows about pasting and will mostly do the right thing without 'paste'
5747 being set. The same is true for a terminal where Vim handles the
5748 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005749 This option is reset when starting the GUI. Thus if you set it in
5750 your .vimrc it will work in a terminal, but not in the GUI. Setting
5751 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5752 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 When the 'paste' option is switched on (also when it was already on):
5754 - mapping in Insert mode and Command-line mode is disabled
5755 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005757 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005758 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 - 'revins' is reset
5760 - 'ruler' is reset
5761 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005762 - 'smarttab' is reset
5763 - 'softtabstop' is set to 0
5764 - 'textwidth' is set to 0
5765 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005766 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005769 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005770 - 'indentexpr'
5771 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005772 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 NOTE: When you start editing another file while the 'paste' option is
5774 on, settings from the modelines or autocommands may change the
5775 settings again, causing trouble when pasting text. You might want to
5776 set the 'paste' option again.
5777 When the 'paste' option is reset the mentioned options are restored to
5778 the value before the moment 'paste' was switched from off to on.
5779 Resetting 'paste' before ever setting it does not have any effect.
5780 Since mapping doesn't work while 'paste' is active, you need to use
5781 the 'pastetoggle' option to toggle the 'paste' option with some key.
5782
5783 *'pastetoggle'* *'pt'*
5784'pastetoggle' 'pt' string (default "")
5785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 When non-empty, specifies the key sequence that toggles the 'paste'
5787 option. This is like specifying a mapping: >
5788 :map {keys} :set invpaste<CR>
5789< Where {keys} is the value of 'pastetoggle'.
5790 The difference is that it will work even when 'paste' is set.
5791 'pastetoggle' works in Insert mode and Normal mode, but not in
5792 Command-line mode.
5793 Mappings are checked first, thus overrule 'pastetoggle'. However,
5794 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5795 this: >
5796 :map <F10> :set paste<CR>
5797 :map <F11> :set nopaste<CR>
5798 :imap <F10> <C-O>:set paste<CR>
5799 :imap <F11> <nop>
5800 :set pastetoggle=<F11>
5801< This will make <F10> start paste mode and <F11> stop paste mode.
5802 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5803 mode everything is inserted literally, except the 'pastetoggle' key
5804 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005805 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806
5807 *'pex'* *'patchexpr'*
5808'patchexpr' 'pex' string (default "")
5809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810 {not available when compiled without the |+diff|
5811 feature}
5812 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005813 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814
Bram Moolenaardbc28022014-07-26 13:40:44 +02005815 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816'patchmode' 'pm' string (default "")
5817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 When non-empty the oldest version of a file is kept. This can be used
5819 to keep the original version of a file if you are changing files in a
5820 source distribution. Only the first time that a file is written a
5821 copy of the original file will be kept. The name of the copy is the
5822 name of the original file with the string in the 'patchmode' option
5823 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005824 ".orig" or ".org". 'backupdir' must not be empty for this to work
5825 (Detail: The backup file is renamed to the patchmode file after the
5826 new file has been successfully written, that's why it must be possible
5827 to write a backup file). If there was no file to be backed up, an
5828 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 When the 'backupskip' pattern matches, a patchmode file is not made.
5830 Using 'patchmode' for compressed files appends the extension at the
5831 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5832 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005833 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005834
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005835 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 other systems: ".,,")
5838 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005840 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5841 provided that the file being searched for has a relative path (not
5842 starting with "/", "./" or "../"). The directories in the 'path'
5843 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 - Use commas to separate directory names: >
5845 :set path=.,/usr/local/include,/usr/include
5846< - Spaces can also be used to separate directory names (for backwards
5847 compatibility with version 3.0). To have a space in a directory
5848 name, precede it with an extra backslash, and escape the space: >
5849 :set path=.,/dir/with\\\ space
5850< - To include a comma in a directory name precede it with an extra
5851 backslash: >
5852 :set path=.,/dir/with\\,comma
5853< - To search relative to the directory of the current file, use: >
5854 :set path=.
5855< - To search in the current directory use an empty string between two
5856 commas: >
5857 :set path=,,
5858< - A directory name may end in a ':' or '/'.
5859 - Environment variables are expanded |:set_env|.
5860 - When using |netrw.vim| URLs can be used. For example, adding
5861 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005862 - Search upwards and downwards in a directory tree using "*", "**" and
5863 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 {not available when compiled without the |+path_extra| feature}
5865 - Careful with '\' characters, type two to get one in the option: >
5866 :set path=.,c:\\include
5867< Or just use '/' instead: >
5868 :set path=.,c:/include
5869< Don't forget "." or files won't even be found in the same directory as
5870 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005871 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 it is something like 256 or 1024 characters.
5873 You can check if all the include files are found, using the value of
5874 'path', see |:checkpath|.
5875 The use of |:set+=| and |:set-=| is preferred when adding or removing
5876 directories from the list. This avoids problems when a future version
5877 uses another default. To remove the current directory use: >
5878 :set path-=
5879< To add the current directory use: >
5880 :set path+=
5881< To use an environment variable, you probably need to replace the
5882 separator. Here is an example to append $INCL, in which directory
5883 names are separated with a semi-colon: >
5884 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5885< Replace the ';' with a ':' or whatever separator is used. Note that
5886 this doesn't work when $INCL contains a comma or white space.
5887
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005888 *'perldll'*
5889'perldll' string (default depends on the build)
5890 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005891 {only available when compiled with the |+perl/dyn|
5892 feature}
5893 Specifies the name of the Perl shared library. The default is
5894 DYNAMIC_PERL_DLL, which was specified at compile time.
5895 Environment variables are expanded |:set_env|.
5896 This option cannot be set from a |modeline| or in the |sandbox|, for
5897 security reasons.
5898
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5900'preserveindent' 'pi' boolean (default off)
5901 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 When changing the indent of the current line, preserve as much of the
5903 indent structure as possible. Normally the indent is replaced by a
5904 series of tabs followed by spaces as required (unless |'expandtab'| is
5905 enabled, in which case only spaces are used). Enabling this option
5906 means the indent will preserve as many existing characters as possible
5907 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005908 'expandtab' does not apply to the preserved white space, a Tab remains
5909 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 NOTE: When using ">>" multiple times the resulting indent is a mix of
5911 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005912 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 Also see 'copyindent'.
5914 Use |:retab| to clean up white space.
5915
5916 *'previewheight'* *'pvh'*
5917'previewheight' 'pvh' number (default 12)
5918 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005919 {not available when compiled without the |+quickfix|
5920 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005922 commands. Used for |CTRL-W_}| when no count is given. Not used when
5923 'previewpopup' is set.
5924
5925 *'previewpopup'* *'pvp'*
5926'previewpopup' 'pvp' string (default empty)
5927 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005928 {not available when compiled without the |+textprop|
5929 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005930 When not empty a popup window is used for commands that would open a
5931 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005932 Not used for the insert completion info, add "popup" to
5933 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934
5935 *'previewwindow'* *'nopreviewwindow'*
5936 *'pvw'* *'nopvw'* *E590*
5937'previewwindow' 'pvw' boolean (default off)
5938 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005939 {not available when compiled without the |+quickfix|
5940 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005941 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 set. It's normally not set directly, but by using one of the commands
5943 |:ptag|, |:pedit|, etc.
5944
5945 *'printdevice'* *'pdev'*
5946'printdevice' 'pdev' string (default empty)
5947 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948 {only available when compiled with the |+printer|
5949 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005950 The name of the printer to be used for |:hardcopy|.
5951 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005952 This option cannot be set from a |modeline| or in the |sandbox|, for
5953 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954
Bram Moolenaar8299df92004-07-10 09:47:34 +00005955 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005956'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958 {only available when compiled with the |+printer|
5959 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005960 Sets the character encoding used when printing.
5961 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962
5963 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005964'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 {only available when compiled with the |+printer|
5967 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005968 Expression used to print the PostScript produced with |:hardcopy|.
5969 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005970 This option cannot be set from a |modeline| or in the |sandbox|, for
5971 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972
Bram Moolenaar8299df92004-07-10 09:47:34 +00005973 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974'printfont' 'pfn' string (default "courier")
5975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 {only available when compiled with the |+printer|
5977 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005978 The name of the font that will be used for |:hardcopy|.
5979 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980
5981 *'printheader'* *'pheader'*
5982'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984 {only available when compiled with the |+printer|
5985 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005986 The format of the header produced in |:hardcopy| output.
5987 See |pheader-option|.
5988
5989 *'printmbcharset'* *'pmbcs'*
5990'printmbcharset' 'pmbcs' string (default "")
5991 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005992 {only available when compiled with the |+printer|
5993 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005994 The CJK character set to be used for CJK output from |:hardcopy|.
5995 See |pmbcs-option|.
5996
5997 *'printmbfont'* *'pmbfn'*
5998'printmbfont' 'pmbfn' string (default "")
5999 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006000 {only available when compiled with the |+printer|
6001 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006002 List of font names to be used for CJK output from |:hardcopy|.
6003 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004
6005 *'printoptions'* *'popt'*
6006'printoptions' 'popt' string (default "")
6007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006009 List of items that control the format of the output of |:hardcopy|.
6010 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006012 *'prompt'* *'noprompt'*
6013'prompt' boolean (default on)
6014 global
6015 When on a ":" prompt is used in Ex mode.
6016
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006017 *'pumheight'* *'ph'*
6018'pumheight' 'ph' number (default 0)
6019 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006020 Determines the maximum number of items to show in the popup menu for
6021 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006022 |ins-completion-menu|.
6023
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006024 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006025'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006026 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006027 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006028 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006029
Bram Moolenaard94464e2015-11-02 15:28:18 +01006030 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006031'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006032 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006033 {only available when compiled with the |+python/dyn|
6034 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006035 Specifies the name of the Python 2.x shared library. The default is
6036 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006037 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006038 This option cannot be set from a |modeline| or in the |sandbox|, for
6039 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006040
Bram Moolenaar94073162018-01-31 21:49:05 +01006041 *'pythonhome'*
6042'pythonhome' string (default "")
6043 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006044 {only available when compiled with the |+python/dyn|
6045 feature}
6046 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6047 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6048 which was specified at compile time, will be used for the Python 2.x
6049 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 Moolenaarb4ff5182015-11-10 21:15:48 +01006054 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006055'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006056 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006057 {only available when compiled with the |+python3/dyn|
6058 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006059 Specifies the name of the Python 3 shared library. The default is
6060 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006061 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006062 This option cannot be set from a |modeline| or in the |sandbox|, for
6063 security reasons.
6064
Bram Moolenaar94073162018-01-31 21:49:05 +01006065 *'pythonthreehome'*
6066'pythonthreehome' string (default "")
6067 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006068 {only available when compiled with the |+python3/dyn|
6069 feature}
6070 Specifies the name of the Python 3 home directory. When
6071 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6072 PYTHON3_HOME, which was specified at compile time, will be used for
6073 the Python 3 home directory.
6074 Environment variables are expanded |:set_env|.
6075 This option cannot be set from a |modeline| or in the |sandbox|, for
6076 security reasons.
6077
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006078 *'pyxversion'* *'pyx'*
6079'pyxversion' 'pyx' number (default depends on the build)
6080 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006081 {only available when compiled with the |+python| or
6082 the |+python3| feature}
6083 Specifies the python version used for pyx* functions and commands
6084 |python_x|. The default value is as follows:
6085
6086 Compiled with Default ~
6087 |+python| and |+python3| 0
6088 only |+python| 2
6089 only |+python3| 3
6090
6091 Available values are 0, 2 and 3.
6092 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6093 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6094 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6095 to 2 if Python 2 is available.
6096 See also: |has-pythonx|
6097
6098 If Vim is compiled with only |+python| or |+python3| setting
6099 'pyxversion' has no effect. The pyx* functions and commands are
6100 always the same as the compiled version.
6101
6102 This option cannot be set from a |modeline| or in the |sandbox|, for
6103 security reasons.
6104
Bram Moolenaar858ba062020-05-31 23:11:59 +02006105 *'quickfixtextfunc'* *'qftf'*
6106'quickfixtextfunc' 'qftf' string (default "")
6107 global
6108 {only available when compiled with the |+quickfix|
6109 feature}
6110 This option specifies a function to be used to get the text to display
6111 in the quickfix and location list windows. This can be used to
6112 customize the information displayed in the quickfix or location window
6113 for each entry in the corresponding quickfix or location list. See
6114 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006115 function and an example. The value can be the name of a function, a
6116 |lambda| or a |Funcref|. See |option-value-function| for more
6117 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006118
6119 This option cannot be set from a |modeline| or in the |sandbox|, for
6120 security reasons.
6121
Bram Moolenaar677ee682005-01-27 14:41:15 +00006122 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006123'quoteescape' 'qe' string (default "\")
6124 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006125 The characters that are used to escape quotes in a string. Used for
6126 objects like a', a" and a` |a'|.
6127 When one of the characters in this option is found inside a string,
6128 the following character will be skipped. The default value makes the
6129 text "foo\"bar\\" considered to be one string.
6130
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6132'readonly' 'ro' boolean (default off)
6133 local to buffer
6134 If on, writes fail unless you use a '!'. Protects you from
6135 accidentally overwriting a file. Default on when Vim is started
6136 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006137 When using ":w!" the 'readonly' option is reset for the current
6138 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006139 When using the ":view" command the 'readonly' option is set for the
6140 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006141 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006143 *'redrawtime'* *'rdt'*
6144'redrawtime' 'rdt' number (default 2000)
6145 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006146 {only available when compiled with the |+reltime|
6147 feature}
6148 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006149 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006150 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006151 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006152 matches will be highlighted.
6153 For syntax highlighting the time applies per window. When over the
6154 limit syntax highlighting is disabled until |CTRL-L| is used.
6155 This is used to avoid that Vim hangs when using a very complicated
6156 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006157
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006158 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006159'regexpengine' 're' number (default 0)
6160 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006161 This selects the default regexp engine. |two-engines|
6162 The possible values are:
6163 0 automatic selection
6164 1 old engine
6165 2 NFA engine
6166 Note that when using the NFA engine and the pattern contains something
6167 that is not supported the pattern will not match. This is only useful
6168 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006169 Using automatic selection enables Vim to switch the engine, if the
6170 default engine becomes too costly. E.g., when the NFA engine uses too
6171 many states. This should prevent Vim from hanging on a combination of
6172 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006173
Bram Moolenaar64486672010-05-16 15:46:46 +02006174 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6175'relativenumber' 'rnu' boolean (default off)
6176 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006177 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006178 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006179 precede some vertical motion commands (e.g. j k + -) with, without
6180 having to calculate it yourself. Especially useful in combination with
6181 other commands (e.g. y d c < > gq gw =).
6182 When the 'n' option is excluded from 'cpoptions' a wrapped
6183 line will not use the column of line numbers (this is the default when
6184 'compatible' isn't set).
6185 The 'numberwidth' option can be used to set the room used for the line
6186 number.
6187 When a long, wrapped line doesn't start with the first character, '-'
6188 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006189 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6190 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006191
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006192 The number in front of the cursor line also depends on the value of
6193 'number', see |number_relativenumber| for all combinations of the two
6194 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006195
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 *'remap'* *'noremap'*
6197'remap' boolean (default on)
6198 global
6199 Allows for mappings to work recursively. If you do not want this for
6200 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006201 NOTE: To avoid portability problems with Vim scripts, always keep
6202 this option at the default "on". Only switch it off when working with
6203 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006205 *'renderoptions'* *'rop'*
6206'renderoptions' 'rop' string (default: empty)
6207 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006208 {only available when compiled with GUI and DIRECTX on
6209 MS-Windows}
6210 Select a text renderer and set its options. The options depend on the
6211 renderer.
6212
6213 Syntax: >
6214 set rop=type:{renderer}(,{name}:{value})*
6215<
6216 Currently, only one optional renderer is available.
6217
6218 render behavior ~
6219 directx Vim will draw text using DirectX (DirectWrite). It makes
6220 drawn glyphs more beautiful than default GDI.
6221 It requires 'encoding' is "utf-8", and only works on
6222 MS-Windows Vista or newer version.
6223
6224 Options:
6225 name meaning type value ~
6226 gamma gamma float 1.0 - 2.2 (maybe)
6227 contrast enhancedContrast float (unknown)
6228 level clearTypeLevel float (unknown)
6229 geom pixelGeometry int 0 - 2 (see below)
6230 renmode renderingMode int 0 - 6 (see below)
6231 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006232 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006233
Bram Moolenaar92467d32017-12-05 13:22:16 +01006234 See this URL for detail (except for scrlines):
6235 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006236
6237 For geom: structure of a device pixel.
6238 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6239 1 - DWRITE_PIXEL_GEOMETRY_RGB
6240 2 - DWRITE_PIXEL_GEOMETRY_BGR
6241
6242 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006243 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006244
6245 For renmode: method of rendering glyphs.
6246 0 - DWRITE_RENDERING_MODE_DEFAULT
6247 1 - DWRITE_RENDERING_MODE_ALIASED
6248 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6249 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6250 4 - DWRITE_RENDERING_MODE_NATURAL
6251 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6252 6 - DWRITE_RENDERING_MODE_OUTLINE
6253
6254 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006255 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006256
6257 For taamode: antialiasing mode used for drawing text.
6258 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6259 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6260 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6261 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6262
6263 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006264 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6265
Bram Moolenaara338adc2018-01-31 20:51:47 +01006266 For scrlines:
6267 This was used for optimizing scrolling behavior, however this
6268 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006269
6270 Example: >
6271 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006272 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006273 set rop=type:directx
6274<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006275 If select a raster font (Courier, Terminal or FixedSys which
6276 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006277 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006278
6279 NOTE: It is known that some fonts and options combination
6280 causes trouble on drawing glyphs.
6281
Bram Moolenaar92467d32017-12-05 13:22:16 +01006282 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006283 special made fonts (True-Type fonts which includes only
6284 bitmap glyphs).
6285 - 'taamode:3' will not work with some vector fonts.
6286
6287 NOTE: With this option, you can display colored emoji
6288 (emoticon) in Windows 8.1 or later. To display colored emoji,
6289 there are some conditions which you should notice.
6290
6291 - If your font includes non-colored emoji already, it will
6292 be used.
6293 - If your font doesn't have emoji, the system chooses an
6294 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6295 will be used.
6296 - When this alternative font didn't have fixed width glyph,
6297 emoji might be rendered beyond the bounding box of drawing
6298 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006299
6300 Other render types are currently not supported.
6301
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 *'report'*
6303'report' number (default 2)
6304 global
6305 Threshold for reporting number of lines changed. When the number of
6306 changed lines is more than 'report' a message will be given for most
6307 ":" commands. If you want it always, set 'report' to 0.
6308 For the ":substitute" command the number of substitutions is used
6309 instead of the number of lines.
6310
6311 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6312'restorescreen' 'rs' boolean (default on)
6313 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006314 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 When set, the screen contents is restored when exiting Vim. This also
6316 happens when executing external commands.
6317
6318 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6319 options in your .vimrc. To disable restoring:
6320 set t_ti= t_te=
6321 To enable restoring (for an xterm):
6322 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6323 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6324
6325 *'revins'* *'ri'* *'norevins'* *'nori'*
6326'revins' 'ri' boolean (default off)
6327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 {only available when compiled with the |+rightleft|
6329 feature}
6330 Inserting characters in Insert mode will work backwards. See "typing
6331 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6332 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006333 NOTE: This option is reset when 'compatible' is set.
6334 This option is reset when 'paste' is set and restored when 'paste' is
6335 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336
6337 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6338'rightleft' 'rl' boolean (default off)
6339 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 {only available when compiled with the |+rightleft|
6341 feature}
6342 When on, display orientation becomes right-to-left, i.e., characters
6343 that are stored in the file appear from the right to the left.
6344 Using this option, it is possible to edit files for languages that
6345 are written from the right to the left such as Hebrew and Arabic.
6346 This option is per window, so it is possible to edit mixed files
6347 simultaneously, or to view the same file in both ways (this is
6348 useful whenever you have a mixed text file with both right-to-left
6349 and left-to-right strings so that both sets are displayed properly
6350 in different windows). Also see |rileft.txt|.
6351
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006352 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353'rightleftcmd' 'rlc' string (default "search")
6354 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 {only available when compiled with the |+rightleft|
6356 feature}
6357 Each word in this option enables the command line editing to work in
6358 right-to-left mode for a group of commands:
6359
6360 search "/" and "?" commands
6361
6362 This is useful for languages such as Hebrew, Arabic and Farsi.
6363 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6364
Bram Moolenaard94464e2015-11-02 15:28:18 +01006365 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006366'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006367 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006368 {only available when compiled with the |+ruby/dyn|
6369 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006370 Specifies the name of the Ruby shared library. The default is
6371 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006372 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006373 This option cannot be set from a |modeline| or in the |sandbox|, for
6374 security reasons.
6375
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006377'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 {not available when compiled without the
6380 |+cmdline_info| feature}
6381 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006382 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 text in the file is shown on the far right:
6384 Top first line is visible
6385 Bot last line is visible
6386 All first and last line are visible
6387 45% relative position in the file
6388 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006389 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006391 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 this option takes precedence over 'ruler' and 'rulerformat'
6393 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006394 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 the text column (byte number) and the screen column are shown,
6396 separated with a dash.
6397 For an empty line "0-1" is shown.
6398 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006399 This option is reset when 'paste' is set and restored when 'paste' is
6400 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 If you don't want to see the ruler all the time but want to know where
6402 you are, use "g CTRL-G" |g_CTRL-G|.
6403 NOTE: This option is reset when 'compatible' is set.
6404
6405 *'rulerformat'* *'ruf'*
6406'rulerformat' 'ruf' string (default empty)
6407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 {not available when compiled without the |+statusline|
6409 feature}
6410 When this option is not empty, it determines the content of the ruler
6411 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006412 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006413 This option cannot be set in a modeline when 'modelineexpr' is off.
6414
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 The default ruler width is 17 characters. To make the ruler 15
6416 characters wide, put "%15(" at the start and "%)" at the end.
6417 Example: >
6418 :set rulerformat=%15(%c%V\ %p%%%)
6419<
6420 *'runtimepath'* *'rtp'* *vimfiles*
6421'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006422 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 $VIM/vimfiles,
6424 $VIMRUNTIME,
6425 $VIM/vimfiles/after,
6426 $HOME/.vim/after"
6427 Amiga: "home:vimfiles,
6428 $VIM/vimfiles,
6429 $VIMRUNTIME,
6430 $VIM/vimfiles/after,
6431 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006432 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 $VIM/vimfiles,
6434 $VIMRUNTIME,
6435 $VIM/vimfiles/after,
6436 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006437 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 $VIMRUNTIME,
6439 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006440 Haiku: "$BE_USER_SETTINGS/vim,
6441 $VIM/vimfiles,
6442 $VIMRUNTIME,
6443 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006444 $BE_USER_SETTINGS/vim/after"
6445 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 $VIM/vimfiles,
6447 $VIMRUNTIME,
6448 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006449 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 This is a list of directories which will be searched for runtime
6452 files:
6453 filetype.vim filetypes by file name |new-filetype|
6454 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006455 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 colors/ color scheme files |:colorscheme|
6457 compiler/ compiler files |:compiler|
6458 doc/ documentation |write-local-help|
6459 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006460 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 indent/ indent scripts |indent-expression|
6462 keymap/ key mapping files |mbyte-keymap|
6463 lang/ menu translations |:menutrans|
6464 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006465 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 plugin/ plugin scripts |write-plugin|
6467 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006468 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 syntax/ syntax files |mysyntaxfile|
6470 tutor/ files for vimtutor |tutor|
6471
6472 And any other file searched for with the |:runtime| command.
6473
6474 The defaults for most systems are setup to search five locations:
6475 1. In your home directory, for your personal preferences.
6476 2. In a system-wide Vim directory, for preferences from the system
6477 administrator.
6478 3. In $VIMRUNTIME, for files distributed with Vim.
6479 *after-directory*
6480 4. In the "after" directory in the system-wide Vim directory. This is
6481 for the system administrator to overrule or add to the distributed
6482 defaults (rarely needed)
6483 5. In the "after" directory in your home directory. This is for
6484 personal preferences to overrule or add to the distributed defaults
6485 or system-wide settings (rarely needed).
6486
Bram Moolenaard0796902016-09-16 20:02:31 +02006487 More entries are added when using |packages|. If it gets very long
6488 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6489 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006490
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6492 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006493 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 wildcards.
6495 See |:runtime|.
6496 Example: >
6497 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6498< This will use the directory "~/vimruntime" first (containing your
6499 personal Vim runtime files), then "/mygroup/vim" (shared between a
6500 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6501 files).
6502 You probably should always include $VIMRUNTIME somewhere, to use the
6503 distributed runtime files. You can put a directory before $VIMRUNTIME
6504 to find files which replace a distributed runtime files. You can put
6505 a directory after $VIMRUNTIME to find files which add to distributed
6506 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006507 When Vim is started with |--clean| the home directory entries are not
6508 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 This option cannot be set from a |modeline| or in the |sandbox|, for
6510 security reasons.
6511
6512 *'scroll'* *'scr'*
6513'scroll' 'scr' number (default: half the window height)
6514 local to window
6515 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6516 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006517 changes. This may happen when enabling the |status-line| or
6518 'tabline' option after setting the 'scroll' option.
6519 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006520 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006521 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522
6523 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6524'scrollbind' 'scb' boolean (default off)
6525 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 See also |scroll-binding|. When this option is set, the current
6527 window scrolls as other scrollbind windows (windows that also have
6528 this option set) scroll. This option is useful for viewing the
6529 differences between two versions of a file, see 'diff'.
6530 See |'scrollopt'| for options that determine how this option should be
6531 interpreted.
6532 This option is mostly reset when splitting a window to edit another
6533 file. This means that ":split | edit file" results in two windows
6534 with scroll-binding, but ":split file" does not.
6535
Bram Moolenaarae20f342019-11-05 21:09:23 +01006536 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6537'scrollfocus' 'scf' boolean (default off)
6538 global
6539 {only for MS-Windows GUI}
6540 When using the scroll wheel and this option is set, the window under
6541 the mouse pointer is scrolled. With this option off the current
6542 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006543 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006544
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 *'scrolljump'* *'sj'*
6546'scrolljump' 'sj' number (default 1)
6547 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 Minimal number of lines to scroll when the cursor gets off the
6549 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6550 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006551 When set to a negative number from -1 to -100 this is used as the
6552 percentage of the window height. Thus -50 scrolls half the window
6553 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 NOTE: This option is set to 1 when 'compatible' is set.
6555
6556 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006557'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006558 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 Minimal number of screen lines to keep above and below the cursor.
6560 This will make some context visible around where you are working. If
6561 you set it to a very large value (999) the cursor line will always be
6562 in the middle of the window (except at the start or end of the file or
6563 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006564 After using the local value, go back the global value with one of
6565 these two: >
6566 setlocal scrolloff<
6567 setlocal scrolloff=-1
6568< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 NOTE: This option is set to 0 when 'compatible' is set.
6570
6571 *'scrollopt'* *'sbo'*
6572'scrollopt' 'sbo' string (default "ver,jump")
6573 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006575 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6576 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 The following words are available:
6578 ver Bind vertical scrolling for 'scrollbind' windows
6579 hor Bind horizontal scrolling for 'scrollbind' windows
6580 jump Applies to the offset between two windows for vertical
6581 scrolling. This offset is the difference in the first
6582 displayed line of the bound windows. When moving
6583 around in a window, another 'scrollbind' window may
6584 reach a position before the start or after the end of
6585 the buffer. The offset is not changed though, when
6586 moving back the 'scrollbind' window will try to scroll
6587 to the desired position when possible.
6588 When now making that window the current one, two
6589 things can be done with the relative offset:
6590 1. When "jump" is not included, the relative offset is
6591 adjusted for the scroll position in the new current
6592 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006593 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 2. When "jump" is included, the other windows are
6595 scrolled to keep the same relative offset. When
6596 going back to the other window, it still uses the
6597 same relative offset.
6598 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006599 When 'diff' mode is active there always is vertical scroll binding,
6600 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601
6602 *'sections'* *'sect'*
6603'sections' 'sect' string (default "SHNHH HUnhsh")
6604 global
6605 Specifies the nroff macros that separate sections. These are pairs of
6606 two letters (See |object-motions|). The default makes a section start
6607 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6608
6609 *'secure'* *'nosecure'* *E523*
6610'secure' boolean (default off)
6611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 When on, ":autocmd", shell and write commands are not allowed in
6613 ".vimrc" and ".exrc" in the current directory and map commands are
6614 displayed. Switch it off only if you know that you will not run into
6615 problems, or when the 'exrc' option is off. On Unix this option is
6616 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006617 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 'secure' at the end of your ~/.vimrc then.
6619 This option cannot be set from a |modeline| or in the |sandbox|, for
6620 security reasons.
6621
6622 *'selection'* *'sel'*
6623'selection' 'sel' string (default "inclusive")
6624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 This option defines the behavior of the selection. It is only used
6626 in Visual and Select mode.
6627 Possible values:
6628 value past line inclusive ~
6629 old no yes
6630 inclusive yes yes
6631 exclusive yes no
6632 "past line" means that the cursor is allowed to be positioned one
6633 character past the line.
6634 "inclusive" means that the last character of the selection is included
6635 in an operation. For example, when "x" is used to delete the
6636 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006637 When "old" is used and 'virtualedit' allows the cursor to move past
6638 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 Note that when "exclusive" is used and selecting from the end
6640 backwards, you cannot include the last character of a line, when
6641 starting in Normal mode and 'virtualedit' empty.
6642
6643 The 'selection' option is set by the |:behave| command.
6644
6645 *'selectmode'* *'slm'*
6646'selectmode' 'slm' string (default "")
6647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 This is a comma separated list of words, which specifies when to start
6649 Select mode instead of Visual mode, when a selection is started.
6650 Possible values:
6651 mouse when using the mouse
6652 key when using shifted special keys
6653 cmd when using "v", "V" or CTRL-V
6654 See |Select-mode|.
6655 The 'selectmode' option is set by the |:behave| command.
6656
6657 *'sessionoptions'* *'ssop'*
6658'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006659 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006661 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 feature}
6663 Changes the effect of the |:mksession| command. It is a comma
6664 separated list of words. Each word enables saving and restoring
6665 something:
6666 word save and restore ~
6667 blank empty windows
6668 buffers hidden and unloaded buffers, not just those in windows
6669 curdir the current directory
6670 folds manually created folds, opened/closed folds and local
6671 fold options
6672 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006673 and contain at least one lowercase letter. Only
6674 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 help the help window
6676 localoptions options and mappings local to a window or buffer (not
6677 global values for local options)
6678 options all options and mappings (also global values for local
6679 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006680 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 resize size of the Vim window: 'lines' and 'columns'
6682 sesdir the directory in which the session file is located
6683 will become the current directory (useful with
6684 projects accessed over a network from different
6685 systems)
6686 slash backslashes in file names replaced with forward
6687 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006688 tabpages all tab pages; without this only the current tab page
6689 is restored, so that you can make a session for each
6690 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006691 terminal include terminal windows where the command can be
6692 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 unix with Unix end-of-line format (single <NL>), even when
6694 on Windows or DOS
6695 winpos position of the whole Vim window
6696 winsize window sizes
6697
6698 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006699 When neither "curdir" nor "sesdir" is included, file names are stored
6700 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006701 If you leave out "options" many things won't work well after restoring
6702 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 "slash" and "unix" are useful on Windows when sharing session files
6704 with Unix. The Unix version of Vim cannot source dos format scripts,
6705 but the Windows version of Vim can source unix format scripts.
6706
6707 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006708'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 global
6710 Name of the shell to use for ! and :! commands. When changing the
6711 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6712 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006713 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 See |option-backslash| about including spaces and backslashes.
6715 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006716
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006717 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006718 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6720< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006721 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006723 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006725 Example with escaped space (Vim will do this when initializing the
6726 option from $SHELL): >
6727 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006728< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006729 backslashes are consumed by `:set`.
6730
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 Under MS-Windows, when the executable ends in ".com" it must be
6732 included. Thus setting the shell to "command.com" or "4dos.com"
6733 works, but "command" and "4dos" do not work for all commands (e.g.,
6734 filtering).
6735 For unknown reasons, when using "4dos.com" the current directory is
6736 changed to "C:\". To avoid this set 'shell' like this: >
6737 :set shell=command.com\ /c\ 4dos
6738< This option cannot be set from a |modeline| or in the |sandbox|, for
6739 security reasons.
6740
6741 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006742'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006743 Win32, when 'shell' contains "powershell":
6744 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006745 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006748 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6749 For MS-Windows, the default is set according to the value of 'shell',
6750 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006751 On Unix it can have more than one flag. Each white space separated
6752 part is passed as an argument to the shell command.
6753 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006754 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 This option cannot be set from a |modeline| or in the |sandbox|, for
6756 security reasons.
6757
6758 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006759'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6760 "2>&1| tee", or
6761 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 {not available when compiled without the |+quickfix|
6764 feature}
6765 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006766 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 including spaces and backslashes.
6768 The name of the temporary file can be represented by "%s" if necessary
6769 (the file name is appended automatically if no %s appears in the value
6770 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006771 For the Amiga the default is ">". For MS-Windows using powershell the
6772 default is "2>&1 | Out-File -Encoding default", otherwise the default
6773 is ">%s 2>&1". The output is directly saved in a file and not echoed
6774 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006775 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 in a file and echoed to the screen. If the 'shell' option is "csh" or
6777 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006778 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006779 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6780 means that stderr is also included. Before using the 'shell' option a
6781 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006782 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6783 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 The initialization of this option is done after reading the ".vimrc"
6785 and the other initializations, so that when the 'shell' option is set
6786 there, the 'shellpipe' option changes automatically, unless it was
6787 explicitly set before.
6788 When 'shellpipe' is set to an empty string, no redirection of the
6789 ":make" output will be done. This is useful if you use a 'makeprg'
6790 that writes to 'makeef' by itself. If you want no piping, but do
6791 want to include the 'makeef', set 'shellpipe' to a single space.
6792 Don't forget to precede the space with a backslash: ":set sp=\ ".
6793 In the future pipes may be used for filtering and this option will
6794 become obsolete (at least for Unix).
6795 This option cannot be set from a |modeline| or in the |sandbox|, for
6796 security reasons.
6797
6798 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006799'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 Quoting character(s), put around the command passed to the shell, for
6802 the "!" and ":!" commands. The redirection is kept outside of the
6803 quoting. See 'shellxquote' to include the redirection. It's
6804 probably not useful to set both options.
6805 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006806 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006807 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 This option cannot be set from a |modeline| or in the |sandbox|, for
6809 security reasons.
6810
6811 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006812'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6813 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 String to be used to put the output of a filter command in a temporary
6816 file. See also |:!|. See |option-backslash| about including spaces
6817 and backslashes.
6818 The name of the temporary file can be represented by "%s" if necessary
6819 (the file name is appended automatically if no %s appears in the value
6820 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006821 The default is ">". For Unix, if the 'shell' option is "csh" or
6822 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006823 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006824 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6825 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006826 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6827 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006828 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6829 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 The initialization of this option is done after reading the ".vimrc"
6831 and the other initializations, so that when the 'shell' option is set
6832 there, the 'shellredir' option changes automatically unless it was
6833 explicitly set before.
6834 In the future pipes may be used for filtering and this option will
6835 become obsolete (at least for Unix).
6836 This option cannot be set from a |modeline| or in the |sandbox|, for
6837 security reasons.
6838
6839 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6840'shellslash' 'ssl' boolean (default off)
6841 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006842 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006844 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006845 powershell.exe. Backward slashes can still be typed, but they are
6846 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 Note that setting or resetting this option has no effect for some
6848 existing file names, thus this option needs to be set before opening
6849 any file for best results. This might change in the future.
6850 'shellslash' only works when a backslash can be used as a path
6851 separator. To test if this is so use: >
6852 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006853< Also see 'completeslash'.
6854
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006855 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6856'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6857 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006858 When on, use temp files for shell commands. When off use a pipe.
6859 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006860 Currently a pipe is only supported on Unix and MS-Windows 2K and
6861 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006862 :if has("filterpipe")
6863< The advantage of using a pipe is that nobody can read the temp file
6864 and the 'shell' command does not need to support redirection.
6865 The advantage of using a temp file is that the file type and encoding
6866 can be detected.
6867 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6868 |FilterWritePost| autocommands event are not triggered when
6869 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006870 The `system()` function does not respect this option and always uses
6871 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006872 NOTE: This option is set to the Vim default value when 'compatible'
6873 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006874
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 *'shelltype'* *'st'*
6876'shelltype' 'st' number (default 0)
6877 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006878 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 On the Amiga this option influences the way how the commands work
6880 which use a shell.
6881 0 and 1: always use the shell
6882 2 and 3: use the shell only to filter lines
6883 4 and 5: use shell only for ':sh' command
6884 When not using the shell, the command is executed directly.
6885
6886 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6887 1 and 3: use "shell cmd" to start external commands
6888
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006889 *'shellxescape'* *'sxe'*
6890'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006891 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006892 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006893 When 'shellxquote' is set to "(" then the characters listed in this
6894 option will be escaped with a '^' character. This makes it possible
6895 to execute most external commands with cmd.exe.
6896
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 *'shellxquote'* *'sxq'*
6898'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006899 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006900 for Win32, when 'shell' is
6901 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006902 for Win32, when 'shell' contains "sh"
6903 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 for Unix, when using system(): "\"")
6905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 Quoting character(s), put around the command passed to the shell, for
6907 the "!" and ":!" commands. Includes the redirection. See
6908 'shellquote' to exclude the redirection. It's probably not useful
6909 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006910 When the value is '(' then ')' is appended. When the value is '"('
6911 then ')"' is appended.
6912 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006913 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006914 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6915 pwsh.exe which automatically strips off the first and last quote on a
6916 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6917 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006918 'shell', to reduce the need to set this option by the user. See
6919 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 This option cannot be set from a |modeline| or in the |sandbox|, for
6921 security reasons.
6922
6923 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6924'shiftround' 'sr' boolean (default off)
6925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 Round indent to multiple of 'shiftwidth'. Applies to > and <
6927 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6928 a multiple of 'shiftwidth' (this is Vi compatible).
6929 NOTE: This option is reset when 'compatible' is set.
6930
6931 *'shiftwidth'* *'sw'*
6932'shiftwidth' 'sw' number (default 8)
6933 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006934 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006936 When zero the 'ts' value will be used. Use the |shiftwidth()|
6937 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938
6939 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006940'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6941 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 This option helps to avoid all the |hit-enter| prompts caused by file
6944 messages, for example with CTRL-G, and to avoid some other messages.
6945 It is a list of flags:
6946 flag meaning when present ~
6947 f use "(3 of 5)" instead of "(file 3 of 5)"
6948 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006949 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 m use "[+]" instead of "[Modified]"
6951 n use "[New]" instead of "[New File]"
6952 r use "[RO]" instead of "[readonly]"
6953 w use "[w]" instead of "written" for file write message
6954 and "[a]" instead of "appended" for ':w >> file' command
6955 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6956 "[unix format]" and "[mac]" instead of "[mac format]".
6957 a all of the above abbreviations
6958
6959 o overwrite message for writing a file with subsequent message
6960 for reading a file (useful for ":wn" or when 'autowrite' on)
6961 O message for reading a file overwrites any previous message.
6962 Also for quickfix message (e.g., ":cn").
6963 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006964 hit TOP, continuing at BOTTOM" messages; when using the search
6965 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 t truncate file message at the start if it is too long to fit
6967 on the command-line, "<" will appear in the left most column.
6968 Ignored in Ex mode.
6969 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006970 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 Ignored in Ex mode.
6972 W don't give "written" or "[w]" when writing a file
6973 A don't give the "ATTENTION" message when an existing swap file
6974 is found.
6975 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006976 c don't give |ins-completion-menu| messages. For example,
6977 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6978 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006979 q use "recording" instead of "recording @a"
6980 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006981 was used for the command; note that this also affects messages
6982 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006983 S do not show search count message when searching, e.g.
6984 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985
6986 This gives you the opportunity to avoid that a change between buffers
6987 requires you to hit <Enter>, but still gives as useful a message as
6988 possible for the space available. To get the whole message that you
6989 would have got with 'shm' empty, use ":file!"
6990 Useful values:
6991 shm= No abbreviation of message.
6992 shm=a Abbreviation, but no loss of information.
6993 shm=at Abbreviation, and truncate message when necessary.
6994
6995 NOTE: This option is set to the Vi default value when 'compatible' is
6996 set and to the Vim default value when 'compatible' is reset.
6997
6998 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6999'shortname' 'sn' boolean (default off)
7000 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 Filenames are assumed to be 8 characters plus one extension of 3
7002 characters. Multiple dots in file names are not allowed. When this
7003 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007004 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007006 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007
7008 *'showbreak'* *'sbr'* *E595*
7009'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007010 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007011 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 feature}
7013 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007014 values are "> " or "+++ ": >
7015 :set showbreak=>\
7016< Note the backslash to escape the trailing space. It's easier like
7017 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007018 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007019< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 comma (in a future version the comma might be used to separate the
7021 part that is shown at the end and at the start of a line).
7022 The characters are highlighted according to the '@' flag in
7023 'highlight'.
7024 Note that tabs after the showbreak will be displayed differently.
7025 If you want the 'showbreak' to appear in between line numbers, add the
7026 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007027 A window-local value overrules a global value. If the global value is
7028 set and you want no value in the current window use NONE: >
7029 :setlocal showbreak=NONE
7030<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007032'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7033 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 {not available when compiled without the
7036 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007037 Show (partial) command in the last line of the screen. Set this
7038 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039 In Visual mode the size of the selected area is shown:
7040 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007041 If the number of bytes is different it is also displayed: "2-6"
7042 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007044 - When selecting a block, the size in screen characters:
7045 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 NOTE: This option is set to the Vi default value when 'compatible' is
7047 set and to the Vim default value when 'compatible' is reset.
7048
7049 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7050'showfulltag' 'sft' boolean (default off)
7051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 When completing a word in insert mode (see |ins-completion|) from the
7053 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007054 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 matched a C function, you can see a template for what arguments are
7056 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007057 Note that this doesn't work well together with having "longest" in
7058 'completeopt', because the completion from the search pattern may not
7059 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060
7061 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7062'showmatch' 'sm' boolean (default off)
7063 global
7064 When a bracket is inserted, briefly jump to the matching one. The
7065 jump is only done if the match can be seen on the screen. The time to
7066 show the match can be set with 'matchtime'.
7067 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007068 seen or not).
7069 This option is reset when 'paste' is set and restored when 'paste' is
7070 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 When the 'm' flag is not included in 'cpoptions', typing a character
7072 will immediately move the cursor back to where it belongs.
7073 See the "sm" field in 'guicursor' for setting the cursor shape and
7074 blinking when showing the match.
7075 The 'matchpairs' option can be used to specify the characters to show
7076 matches for. 'rightleft' and 'revins' are used to look for opposite
7077 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007078 Also see the matchparen plugin for highlighting the match when moving
7079 around |pi_paren.txt|.
7080 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081
7082 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7083'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7084 global
7085 If in Insert, Replace or Visual mode put a message on the last line.
7086 Use the 'M' flag in 'highlight' to set the type of highlighting for
7087 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007088 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 doesn't mean XIM is really active, especially when 'imactivatekey' is
7090 not set.
7091 NOTE: This option is set to the Vi default value when 'compatible' is
7092 set and to the Vim default value when 'compatible' is reset.
7093
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007094 *'showtabline'* *'stal'*
7095'showtabline' 'stal' number (default 1)
7096 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007097 The value of this option specifies when the line with tab page labels
7098 will be displayed:
7099 0: never
7100 1: only if there are at least two tab pages
7101 2: always
7102 This is both for the GUI and non-GUI implementation of the tab pages
7103 line.
7104 See |tab-page| for more information about tab pages.
7105
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 *'sidescroll'* *'ss'*
7107'sidescroll' 'ss' number (default 0)
7108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 The minimal number of columns to scroll horizontally. Used only when
7110 the 'wrap' option is off and the cursor is moved off of the screen.
7111 When it is zero the cursor will be put in the middle of the screen.
7112 When using a slow terminal set it to a large number or 0. When using
7113 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7114 commands.
7115
7116 *'sidescrolloff'* *'siso'*
7117'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007118 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007120 right of the cursor if 'nowrap' is set. Setting this option to a
7121 value greater than 0 while having |'sidescroll'| also at a non-zero
7122 value makes some context visible in the line you are scrolling in
7123 horizontally (except at beginning of the line). Setting this option
7124 to a large value (like 999) has the effect of keeping the cursor
7125 horizontally centered in the window, as long as one does not come too
7126 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007127 After using the local value, go back the global value with one of
7128 these two: >
7129 setlocal sidescrolloff<
7130 setlocal sidescrolloff=-1
7131< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132
7133 Example: Try this together with 'sidescroll' and 'listchars' as
7134 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007135 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136
7137 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7138 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007139<
7140 *'signcolumn'* *'scl'*
7141'signcolumn' 'scl' string (default "auto")
7142 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007143 {not available when compiled without the |+signs|
7144 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007145 Whether or not to draw the signcolumn. Valid values are:
7146 "auto" only when there is a sign to display
7147 "no" never
7148 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007149 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007150 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151
7152
7153 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7154'smartcase' 'scs' boolean (default off)
7155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 Override the 'ignorecase' option if the search pattern contains upper
7157 case characters. Only used when the search pattern is typed and
7158 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007159 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7161 recalling the search pattern from history and hitting <Enter>.
7162 NOTE: This option is reset when 'compatible' is set.
7163
7164 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7165'smartindent' 'si' boolean (default off)
7166 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 {not available when compiled without the
7168 |+smartindent| feature}
7169 Do smart autoindenting when starting a new line. Works for C-like
7170 programs, but can also be used for other languages. 'cindent' does
7171 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007172 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007173 setting 'si' has no effect. 'indentexpr' is a more advanced
7174 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 Normally 'autoindent' should also be on when using 'smartindent'.
7176 An indent is automatically inserted:
7177 - After a line ending in '{'.
7178 - After a line starting with a keyword from 'cinwords'.
7179 - Before a line starting with '}' (only with the "O" command).
7180 When typing '}' as the first character in a new line, that line is
7181 given the same indent as the matching '{'.
7182 When typing '#' as the first character in a new line, the indent for
7183 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007184 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7186 When using the ">>" command, lines starting with '#' are not shifted
7187 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007188 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007189 This option is reset when 'paste' is set and restored when 'paste' is
7190 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191
7192 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7193'smarttab' 'sta' boolean (default off)
7194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007196 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7197 <BS> will delete a 'shiftwidth' worth of space at the start of the
7198 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007199 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007200 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7201 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007202 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007204 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007205 This option is reset when 'paste' is set and restored when 'paste' is
7206 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207 NOTE: This option is reset when 'compatible' is set.
7208
7209 *'softtabstop'* *'sts'*
7210'softtabstop' 'sts' number (default 0)
7211 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 Number of spaces that a <Tab> counts for while performing editing
7213 operations, like inserting a <Tab> or using <BS>. It "feels" like
7214 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7215 used. This is useful to keep the 'ts' setting at its standard value
7216 of 8, while being able to edit like it is set to 'sts'. However,
7217 commands like "x" still work on the actual characters.
7218 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007219 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007220 'softtabstop' is set to 0 when the 'paste' option is set and restored
7221 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7223 spaces is minimized by using <Tab>s.
7224 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7225 set.
7226 NOTE: This option is set to 0 when 'compatible' is set.
7227
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007228 If Vim is compiled with the |+vartabs| feature then the value of
7229 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7230 anything other than an empty string.
7231
Bram Moolenaar217ad922005-03-20 22:37:15 +00007232 *'spell'* *'nospell'*
7233'spell' boolean (default off)
7234 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007235 {not available when compiled without the |+syntax|
7236 feature}
7237 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007238 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007239
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007240 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007241'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007242 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007243 {not available when compiled without the |+syntax|
7244 feature}
7245 Pattern to locate the end of a sentence. The following word will be
7246 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007247 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007248 When this check is not wanted make this option empty.
7249 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007250 Be careful with special characters, see |option-backslash| about
7251 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007252 To set this option automatically depending on the language, see
7253 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007254
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007255 *'spellfile'* *'spf'*
7256'spellfile' 'spf' string (default empty)
7257 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007258 {not available when compiled without the |+syntax|
7259 feature}
7260 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007261 commands. It must end in ".{encoding}.add". You need to include the
7262 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007263 *E765*
7264 It may also be a comma separated list of names. A count before the
7265 |zg| and |zw| commands can be used to access each. This allows using
7266 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007267 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007268 you: Using the first directory in 'runtimepath' that is writable. If
7269 there is no "spell" directory yet it will be created. For the file
7270 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007271 ignoring the region.
7272 The resulting ".spl" file will be used for spell checking, it does not
7273 have to appear in 'spelllang'.
7274 Normally one file is used for all regions, but you can add the region
7275 name if you want to. However, it will then only be used when
7276 'spellfile' is set to it, for entries in 'spelllang' only files
7277 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007278 This option cannot be set from a |modeline| or in the |sandbox|, for
7279 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007280
Bram Moolenaar217ad922005-03-20 22:37:15 +00007281 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007282'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007283 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007284 {not available when compiled without the |+syntax|
7285 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007286 A comma separated list of word list names. When the 'spell' option is
7287 on spellchecking will be done for these languages. Example: >
7288 set spelllang=en_us,nl,medical
7289< This means US English, Dutch and medical words are recognized. Words
7290 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007291 The word list name must consist of alphanumeric characters, a dash or
7292 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007293 recommended to separate the two letter language name from a
7294 specification. Thus "en-rare" is used for rare English words.
7295 A region name must come last and have the form "_xx", where "xx" is
7296 the two-letter, lower case region name. You can use more than one
7297 region by listing them: "en_us,en_ca" supports both US and Canadian
7298 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007299 Britain. (Note: currently en_au and en_nz dictionaries are older than
7300 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007301 If the name "cjk" is included East Asian characters are excluded from
7302 spell checking. This is useful when editing text that also has Asian
7303 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007304 Note that the "medical" dictionary does not exist, it is just an
7305 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007306 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007307 As a special case the name of a .spl file can be given as-is. The
7308 first "_xx" in the name is removed and used as the region name
7309 (_xx is an underscore, two letters and followed by a non-letter).
7310 This is mainly for testing purposes. You must make sure the correct
7311 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007312 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007313 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7314 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007315 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007316
Bram Moolenaar98692072006-02-04 00:57:42 +00007317 If the |spellfile.vim| plugin is active and you use a language name
7318 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7319 will ask you if you want to download the file.
7320
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007321 After this option has been set successfully, Vim will source the files
7322 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007323 up to the first character that is not an ASCII letter or number and
7324 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007325
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007326 *'spelloptions'* *'spo'*
7327'spelloptions' 'spo' string (default "")
7328 local to buffer
7329 {not available when compiled without the |+syntax|
7330 feature}
7331 A comma separated list of options for spell checking:
7332 camel When a word is CamelCased, assume "Cased" is a
7333 separate word: every upper-case character in a word
7334 that comes after a lower case character indicates the
7335 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007336
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007337 *'spellsuggest'* *'sps'*
7338'spellsuggest' 'sps' string (default "best")
7339 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007340 {not available when compiled without the |+syntax|
7341 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007342 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007343 the |spellsuggest()| function. This is a comma-separated list of
7344 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007345
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007346 best Internal method that works best for English. Finds
7347 changes like "fast" and uses a bit of sound-a-like
7348 scoring to improve the ordering.
7349
7350 double Internal method that uses two methods and mixes the
7351 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007352 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007353 word. That only works when the language specifies
7354 sound folding. Can be slow and doesn't always give
7355 better results.
7356
7357 fast Internal method that only checks for simple changes:
7358 character inserts/deletes/swaps. Works well for
7359 simple typing mistakes.
7360
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007361 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007362 Not used for |spellsuggest()|. The number of
7363 suggestions is never more than the value of 'lines'
7364 minus two.
7365
Bram Moolenaar585ee072022-01-29 11:22:17 +00007366 timeout:{millisec} Limit the time searching for suggestions to
7367 {millisec} milli seconds. Applies to the following
7368 methods. When omitted the limit is 5000. When
7369 negative there is no limit. {only works when built
7370 with the +reltime feature}
7371
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007372 file:{filename} Read file {filename}, which must have two columns,
7373 separated by a slash. The first column contains the
7374 bad word, the second column the suggested good word.
7375 Example:
7376 theribal/terrible ~
7377 Use this for common mistakes that do not appear at the
7378 top of the suggestion list with the internal methods.
7379 Lines without a slash are ignored, use this for
7380 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007381 The word in the second column must be correct,
7382 otherwise it will not be used. Add the word to an
7383 ".add" file if it is currently flagged as a spelling
7384 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007385 The file is used for all languages.
7386
7387 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7388 trouble with spaces. |v:val| holds the badly spelled
7389 word. The expression must evaluate to a List of
7390 Lists, each with a suggestion and a score.
7391 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007392 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007393 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007394 internal methods use. A lower score is better.
7395 This may invoke |spellsuggest()| if you temporarily
7396 set 'spellsuggest' to exclude the "expr:" part.
7397 Errors are silently ignored, unless you set the
7398 'verbose' option to a non-zero value.
7399
7400 Only one of "best", "double" or "fast" may be used. The others may
7401 appear several times in any order. Example: >
7402 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7403<
7404 This option cannot be set from a |modeline| or in the |sandbox|, for
7405 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007406
7407
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7409'splitbelow' 'sb' boolean (default off)
7410 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411 When on, splitting a window will put the new window below the current
7412 one. |:split|
7413
7414 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7415'splitright' 'spr' boolean (default off)
7416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 When on, splitting a window will put the new window right of the
7418 current one. |:vsplit|
7419
7420 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7421'startofline' 'sol' boolean (default on)
7422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007424 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007425 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007426 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427 with a linewise operator, with "%" with a count and to buffer changing
7428 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7429 only has a line number, e.g., ":25" or ":+".
7430 In case of buffer changing commands the cursor is placed at the column
7431 where it was the last time the buffer was edited.
7432 NOTE: This option is set when 'compatible' is set.
7433
Bram Moolenaar00654022011-02-25 14:42:19 +01007434 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007436 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007437 {not available when compiled without the |+statusline|
7438 feature}
7439 When nonempty, this option determines the content of the status line.
7440 Also see |status-line|.
7441
7442 The option consists of printf style '%' items interspersed with
7443 normal text. Each status line item is of the form:
7444 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007445 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007446 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447
Bram Moolenaar238a5642006-02-21 22:12:05 +00007448 When the option starts with "%!" then it is used as an expression,
7449 evaluated and the result is used as the option value. Example: >
7450 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007451< The *g:statusline_winid* variable will be set to the |window-ID| of the
7452 window that the status line belongs to.
7453 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007454 Note that the "%!" expression is evaluated in the context of the
7455 current window and buffer, while %{} items are evaluated in the
7456 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007457
7458 When there is error while evaluating the option then it will be made
7459 empty to avoid further errors. Otherwise screen updating would loop.
7460
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 Note that the only effect of 'ruler' when this option is set (and
7462 'laststatus' is 2) is controlling the output of |CTRL-G|.
7463
7464 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007465 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007467 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 minwid Minimum width of the item, padding as set by '-' & '0'.
7469 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007470 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 on the left for text items. Numeric items will be
7472 shifted down to maxwid-2 digits followed by '>'number
7473 where number is the amount of missing digits, much like
7474 an exponential notation.
7475 item A one letter code as described below.
7476
7477 Following is a description of the possible statusline items. The
7478 second character in "item" is the type:
7479 N for number
7480 S for string
7481 F for flags as described below
7482 - not applicable
7483
7484 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007485 f S Path to the file in the buffer, as typed or relative to current
7486 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 F S Full path to the file in the buffer.
7488 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007489 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007491 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007493 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007495 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007497 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007499 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7501 being used: "<keymap>"
7502 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007503 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504 B N As above, in hexadecimal.
7505 o N Byte number in file of byte under cursor, first byte is 1.
7506 Mnemonic: Offset from start of file (with one added)
7507 {not available when compiled without |+byte_offset| feature}
7508 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007509 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 l N Line number.
7511 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007512 c N Column number (byte index).
7513 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007514 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 p N Percentage through file in lines as in |CTRL-G|.
7516 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007517 percentage described for 'ruler'. Always 3 in length, unless
7518 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007519 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007521 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007522 Note that there is no '%' before the closing '}'. The
7523 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007524 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007525 {% - This is almost same as { except the result of the expression is
7526 re-evaluated as a statusline format string. Thus if the
7527 return value of expr contains % items they will get expanded.
7528 The expression can contain the } character, the end of
7529 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007530 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007531 func! Stl_filename() abort
7532 return "%t"
7533 endfunc
7534< `stl=%{Stl_filename()}` results in `"%t"`
7535 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007536 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 ( - Start of item group. Can be used for setting the width and
7538 alignment of a section. Must be followed by %) somewhere.
7539 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007540 T N For 'tabline': start of tab page N label. Use %T after the last
7541 label. This information is used for mouse clicks.
7542 X N For 'tabline': start of close tab N label. Use %X after the
7543 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7544 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 < - Where to truncate line if too long. Default is at the start.
7546 No width fields allowed.
7547 = - Separation point between left and right aligned items.
7548 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007549 # - Set highlight group. The name must follow and then a # again.
7550 Thus use %#HLname# for highlight group HLname. The same
7551 highlighting is used, also for the statusline of non-current
7552 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007554 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 The difference between User{N} and StatusLine will be applied
7556 to StatusLineNC for the statusline of non-current windows.
7557 The number N must be between 1 and 9. See |hl-User1..9|
7558
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007559 When displaying a flag, Vim removes the leading comma, if any, when
7560 that flag comes right after plaintext. This will make a nice display
7561 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562
Bram Moolenaar582fd852005-03-28 20:58:01 +00007563 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 not set) and a minwid is not set for the group, the whole group will
7565 become empty. This will make a group like the following disappear
7566 completely from the statusline when none of the flags are set. >
7567 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007568< Beware that an expression is evaluated each and every time the status
7569 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007570 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007571 While evaluating %{} the current buffer and current window will be set
7572 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007573 currently being drawn. The expression will evaluate in this context.
7574 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7575 real current buffer and "g:actual_curwin" to the |window-ID| of the
7576 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007577
Bram Moolenaar30b65812012-07-12 22:01:11 +02007578 The 'statusline' option will be evaluated in the |sandbox| if set from
7579 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007580 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007581
7582 It is not allowed to change text or jump to another window while
7583 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584
7585 If the statusline is not updated when you want it (e.g., after setting
7586 a variable that's used in an expression), you can force an update by
7587 setting an option without changing its value. Example: >
7588 :let &ro = &ro
7589
7590< A result of all digits is regarded a number for display purposes.
7591 Otherwise the result is taken as flag text and applied to the rules
7592 described above.
7593
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007594 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007596 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597
7598 Examples:
7599 Emulate standard status line with 'ruler' set >
7600 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7601< Similar, but add ASCII value of char under the cursor (like "ga") >
7602 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7603< Display byte count and byte value, modified flag in red. >
7604 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7605 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7606< Display a ,GZ flag if a compressed file is loaded >
7607 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7608< In the |:autocmd|'s: >
7609 :let b:gzflag = 1
7610< And: >
7611 :unlet b:gzflag
7612< And define this function: >
7613 :function VarExists(var, val)
7614 : if exists(a:var) | return a:val | else | return '' | endif
7615 :endfunction
7616<
7617 *'suffixes'* *'su'*
7618'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 Files with these suffixes get a lower priority when multiple files
7621 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007622 suffixes. Spaces after the comma are ignored. A dot is also seen as
7623 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 separator, precede it with a backslash (see |option-backslash| about
7625 including spaces and backslashes).
7626 See 'wildignore' for completely ignoring files.
7627 The use of |:set+=| and |:set-=| is preferred when adding or removing
7628 suffixes from the list. This avoids problems when a future version
7629 uses another default.
7630
7631 *'suffixesadd'* *'sua'*
7632'suffixesadd' 'sua' string (default "")
7633 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634 {not available when compiled without the
7635 |+file_in_path| feature}
7636 Comma separated list of suffixes, which are used when searching for a
7637 file for the "gf", "[I", etc. commands. Example: >
7638 :set suffixesadd=.java
7639<
7640 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7641'swapfile' 'swf' boolean (default on)
7642 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007643 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 swapfile is not wanted for a specific buffer. For example, with
7645 confidential information that even root must not be able to access.
7646 Careful: All text will be in memory:
7647 - Don't use this for big files.
7648 - Recovery will be impossible!
7649 A swapfile will only be present when |'updatecount'| is non-zero and
7650 'swapfile' is set.
7651 When 'swapfile' is reset, the swap file for the current buffer is
7652 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7653 non-zero, a swap file is immediately created.
7654 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007655 If you want to open a new buffer without creating a swap file for it,
7656 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007657 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658
7659 This option is used together with 'bufhidden' and 'buftype' to
7660 specify special kinds of buffers. See |special-buffers|.
7661
7662 *'swapsync'* *'sws'*
7663'swapsync' 'sws' string (default "fsync")
7664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007666 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 When this option is empty parts of the swap file may be in memory and
7668 not written to disk. When the system crashes you may lose more work.
7669 On Unix the system does a sync now and then without Vim asking for it,
7670 so the disadvantage of setting this option off is small. On some
7671 systems the swap file will not be written at all. For a unix system
7672 setting it to "sync" will use the sync() call instead of the default
7673 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007674 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675
7676 *'switchbuf'* *'swb'*
7677'switchbuf' 'swb' string (default "")
7678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007680 Mostly for |quickfix| commands some values are also used for other
7681 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 Possible values (comma separated list):
7683 useopen If included, jump to the first open window that
7684 contains the specified buffer (if there is one).
7685 Otherwise: Do not examine other windows.
7686 This setting is checked with |quickfix| commands, when
7687 jumping to errors (":cc", ":cn", "cp", etc.). It is
7688 also used in all buffer related split commands, for
7689 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007690 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007691 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007693 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007694 Otherwise: do not split, use current window (when used
7695 in the quickfix window: the previously used window or
7696 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007697 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007698 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007699 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007700 uselast If included, jump to the previously used window when
7701 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007703 *'synmaxcol'* *'smc'*
7704'synmaxcol' 'smc' number (default 3000)
7705 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007706 {not available when compiled without the |+syntax|
7707 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007708 Maximum column in which to search for syntax items. In long lines the
7709 text after this column is not highlighted and following lines may not
7710 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007711 This helps to avoid very slow redrawing for an XML file that is one
7712 long line.
7713 Set to zero to remove the limit.
7714
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 *'syntax'* *'syn'*
7716'syntax' 'syn' string (default empty)
7717 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 {not available when compiled without the |+syntax|
7719 feature}
7720 When this option is set, the syntax with this name is loaded, unless
7721 syntax highlighting has been switched off with ":syntax off".
7722 Otherwise this option does not always reflect the current syntax (the
7723 b:current_syntax variable does).
7724 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007725 not automatically recognized. Example, in an IDL file:
7726 /* vim: set syntax=idl : */ ~
7727 When a dot appears in the value then this separates two filetype
7728 names. Example:
7729 /* vim: set syntax=c.doxygen : */ ~
7730 This will use the "c" syntax first, then the "doxygen" syntax.
7731 Note that the second one must be prepared to be loaded as an addition,
7732 otherwise it will be skipped. More than one dot may appear.
7733 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 :set syntax=OFF
7735< To switch syntax highlighting on according to the current value of the
7736 'filetype' option: >
7737 :set syntax=ON
7738< What actually happens when setting the 'syntax' option is that the
7739 Syntax autocommand event is triggered with the value as argument.
7740 This option is not copied to another buffer, independent of the 's' or
7741 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007742 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007744 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007745'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007746 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007747 When nonempty, this option determines the content of the tab pages
7748 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007749 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007750
7751 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007752 option and only when there is no GUI tab line. When 'e' is in
7753 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007754 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007755
7756 The value is evaluated like with 'statusline'. You can use
7757 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007758 the text to be displayed. Use "%1T" for the first label, "%2T" for
7759 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007760
Bram Moolenaare12bab32019-01-08 22:02:56 +01007761 When changing something that is used in 'tabline' that does not
7762 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007763 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007764
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007765 Keep in mind that only one of the tab pages is the current one, others
7766 are invisible and you can't jump to their windows.
7767
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007768
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007769 *'tabpagemax'* *'tpm'*
7770'tabpagemax' 'tpm' number (default 10)
7771 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007772 Maximum number of tab pages to be opened by the |-p| command line
7773 argument or the ":tab all" command. |tabpage|
7774
7775
7776 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777'tabstop' 'ts' number (default 8)
7778 local to buffer
7779 Number of spaces that a <Tab> in the file counts for. Also see
7780 |:retab| command, and 'softtabstop' option.
7781
7782 Note: Setting 'tabstop' to any other value than 8 can make your file
7783 appear wrong in many places (e.g., when printing it).
7784
7785 There are four main ways to use tabs in Vim:
7786 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7787 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007788 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 behave like a tab appears every 4 (or 3) characters.
7790 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7791 'expandtab'. This way you will always insert spaces. The
7792 formatting will never be messed up when 'tabstop' is changed.
7793 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007794 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795 works when using Vim to edit the file.
7796 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7797 'noexpandtab'. This should then work (for initial indents only)
7798 for any tabstop setting that people use. It might be nice to have
7799 tabs after the first non-blank inserted as spaces if you do this
7800 though. Otherwise aligned comments will be wrong when 'tabstop' is
7801 changed.
7802
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007803 If Vim is compiled with the |+vartabs| feature then the value of
7804 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7805 than an empty string.
7806
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7808'tagbsearch' 'tbs' boolean (default on)
7809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007810 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007811 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 searching makes searching for a tag a LOT faster, but a linear search
7813 will find more tags if the tags file wasn't properly sorted.
7814 Vim normally assumes that your tags files are sorted, or indicate that
7815 they are not sorted. Only when this is not the case does the
7816 'tagbsearch' option need to be switched off.
7817
7818 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007819 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 certain files, or retry all files with a linear search. When
7821 'tagbsearch' is off, only a linear search is done.
7822
7823 Linear searching is done anyway, for one file, when Vim finds a line
7824 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007825 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826< [The whitespace before and after the '0' must be a single <Tab>]
7827
7828 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007829 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 instead of a normal tag name, a retry is done with a linear search.
7831 Tags in unsorted tags files, and matches with different case will only
7832 be found in the retry.
7833
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007834 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007835 linear search can be avoided when case is ignored. Use a value of '2'
7836 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7837 sorted with the -f switch to "sort" in most unices, as in the command:
7838 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7839 (at least 5.5) the --sort=foldcase switch can be used for this as
7840 well. Note that case must be folded to uppercase for this to work.
7841
7842 By default, tag searches are case-sensitive. Case is ignored when
7843 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7844 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007845 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7846 'tagcase' is "smart", and the pattern contains only lowercase
7847 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848
7849 When 'tagbsearch' is off, tags searching is slower when a full match
7850 exists, but faster when no full match exists. Tags in unsorted tags
7851 files may only be found with 'tagbsearch' off.
7852 When the tags file is not sorted, or sorted in a wrong way (not on
7853 ASCII byte value), 'tagbsearch' should be off, or the line given above
7854 must be included in the tags file.
7855 This option doesn't affect commands that find all matching tags (e.g.,
7856 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007858 *'tagcase'* *'tc'*
7859'tagcase' 'tc' string (default "followic")
7860 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007861 This option specifies how case is handled when searching the tags
7862 file:
7863 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007864 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007865 ignore Ignore case
7866 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007867 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007868 NOTE: This option is set to the Vi default value when 'compatible' is
7869 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007870
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007871 *'tagfunc'* *'tfu'*
7872'tagfunc' 'tfu' string (default: empty)
7873 local to buffer
7874 {not available when compiled without the |+eval|
7875 feature}
7876 This option specifies a function to be used to perform tag searches.
7877 The function gets the tag pattern and should return a List of matching
7878 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007879 function and an example. The value can be the name of a function, a
7880 |lambda| or a |Funcref|. See |option-value-function| for more
7881 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007882
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 *'taglength'* *'tl'*
7884'taglength' 'tl' number (default 0)
7885 global
7886 If non-zero, tags are significant up to this number of characters.
7887
7888 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7889'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7890 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007891 If on and using a tags file in another directory, file names in that
7892 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 NOTE: This option is set to the Vi default value when 'compatible' is
7894 set and to the Vim default value when 'compatible' is reset.
7895
7896 *'tags'* *'tag'* *E433*
7897'tags' 'tag' string (default "./tags,tags", when compiled with
7898 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7899 global or local to buffer |global-local|
7900 Filenames for the tag command, separated by spaces or commas. To
7901 include a space or comma in a file name, precede it with a backslash
7902 (see |option-backslash| about including spaces and backslashes).
7903 When a file name starts with "./", the '.' is replaced with the path
7904 of the current file. But only when the 'd' flag is not included in
7905 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7906 |tags-option|.
7907 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007908 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7909 find all files named "tags" below "/lib". The filename itself cannot
7910 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7911 files called "tags?". {not available when compiled without the
7912 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007913 The |tagfiles()| function can be used to get a list of the file names
7914 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7916 files are also supported. They are automatically recognized. The
7917 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7918 differences are ignored (MS-Windows). |emacs-tags|
7919 The use of |:set+=| and |:set-=| is preferred when adding or removing
7920 file names from the list. This avoids problems when a future version
7921 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922
7923 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7924'tagstack' 'tgst' boolean (default on)
7925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 When on, the |tagstack| is used normally. When off, a ":tag" or
7927 ":tselect" command with an argument will not push the tag onto the
7928 tagstack. A following ":tag" without an argument, a ":pop" command or
7929 any other command that uses the tagstack will use the unmodified
7930 tagstack, but does change the pointer to the active entry.
7931 Resetting this option is useful when using a ":tag" command in a
7932 mapping which should not change the tagstack.
7933
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007934 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007935'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007936 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007937 {only available when compiled with the |+tcl/dyn|
7938 feature}
7939 Specifies the name of the Tcl shared library. The default is
7940 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007941 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007942 This option cannot be set from a |modeline| or in the |sandbox|, for
7943 security reasons.
7944
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 *'term'* *E529* *E530* *E531*
7946'term' string (default is $TERM, if that fails:
7947 in the GUI: "builtin_gui"
7948 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007949 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 on Unix: "ansi"
7952 on VMS: "ansi"
7953 on Win 32: "win32")
7954 global
7955 Name of the terminal. Used for choosing the terminal control
7956 characters. Environment variables are expanded |:set_env|.
7957 For example: >
7958 :set term=$TERM
7959< See |termcap|.
7960
7961 *'termbidi'* *'tbidi'*
7962 *'notermbidi'* *'notbidi'*
7963'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 {only available when compiled with the |+arabic|
7966 feature}
7967 The terminal is in charge of Bi-directionality of text (as specified
7968 by Unicode). The terminal is also expected to do the required shaping
7969 that some languages (such as Arabic) require.
7970 Setting this option implies that 'rightleft' will not be set when
7971 'arabic' is set and the value of 'arabicshape' will be ignored.
7972 Note that setting 'termbidi' has the immediate effect that
7973 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7974 This option is reset when the GUI is started.
7975 For further details see |arabic.txt|.
7976
7977 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007978'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980 Encoding used for the terminal. This specifies what character
7981 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007982 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007983 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007984 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007985 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7987 Any attempts to set a different value will be rejected, and an error
7988 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007989 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 because the Win32 system always passes Unicode characters.
7991 When empty, the same encoding is used as for the 'encoding' option.
7992 This is the normal value.
7993 Not all combinations for 'termencoding' and 'encoding' are valid. See
7994 |encoding-table|.
7995 The value for this option must be supported by internal conversions or
7996 iconv(). When this is not possible no conversion will be done and you
7997 will probably experience problems with non-ASCII characters.
7998 Example: You are working with the locale set to euc-jp (Japanese) and
7999 want to edit a UTF-8 file: >
8000 :let &termencoding = &encoding
8001 :set encoding=utf-8
8002< You need to do this when your system has no locale support for UTF-8.
8003
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008004 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008005'termguicolors' 'tgc' boolean (default off)
8006 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008007 {not available when compiled without the
8008 |+termguicolors| feature}
8009 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008010 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008011
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008012 Requires a ISO-8613-3 compatible terminal. If setting this option
8013 does not work (produces a colorless UI) reading |xterm-true-color|
8014 might help.
8015
8016 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8017 is required. Use this check to find out: >
8018 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008019< This requires Vim to be built with the |+vtp| feature.
8020
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008021 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008022 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008023
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008024 *'termwinkey'* *'twk'*
8025'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008026 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008027 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008028 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008029 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008030 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008031< The string must be one key stroke but can be multiple bytes.
8032 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008033 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008034 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008035
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008036 *'termwinscroll'* *'twsl'*
8037'termwinscroll' 'twsl' number (default 10000)
8038 local to buffer
8039 {not available when compiled without the
8040 |+terminal| feature}
8041 Number of scrollback lines to keep. When going over this limit the
8042 first 10% of the scrollback lines are deleted. This is just to reduce
8043 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008044 Also used as a limit for text sent to the terminal in one write,
8045 multiplied by the number of columns times 3 (average number of bytes
8046 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008047
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008048 *'termwinsize'* *'tws'*
8049'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008050 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008051 Size used when opening the |terminal| window. Format:
8052 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008053 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008054 - When set with a "x" (e.g., "24x80") the terminal size is not
8055 adjusted to the window size. If the window is smaller only the
8056 top-left part is displayed.
8057 - When set with a "*" (e.g., "10*50") the terminal size follows the
8058 window size, but will not be smaller than the specified rows and/or
8059 columns.
8060 - When rows is zero then use the height of the window.
8061 - When columns is zero then use the width of the window.
8062 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008063 - Can be overruled in the |term_start()| options with "term_rows" and
8064 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008065
8066 Examples:
8067 "30x0" uses 30 rows and the current window width.
8068 "20*0" uses at least 20 rows and the current window width.
8069 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008070 Note that the command running in the terminal window may still change
8071 the size of the terminal. In that case the Vim window will be
8072 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008073
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008074 *'termwintype'* *'twt'*
8075'termwintype' 'twt' string (default "")
8076 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008077 {only available when compiled with the |terminal|
8078 feature on MS-Windows}
8079 Specify the virtual console (pty) used when opening the terminal
8080 window.
8081
8082 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008083 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008084 "winpty" use winpty, fail if not supported
8085 "conpty" use |ConPTY|, fail if not supported
8086
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008087 |ConPTY| support depends on the platform. Windows 10 October 2018
8088 Update is the first version that supports ConPTY, however it is still
8089 considered unstable. ConPTY might become stable in the next release
8090 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008091 supported then you cannot open a terminal window.
8092
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093 *'terse'* *'noterse'*
8094'terse' boolean (default off)
8095 global
8096 When set: Add 's' flag to 'shortmess' option (this makes the message
8097 for a search that hits the start or end of the file not being
8098 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8099 shortens a lot of messages}
8100
8101 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8102'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 This option is obsolete. Use 'fileformats'.
8105 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8106 set to the default value for the current system. When 'textauto' is
8107 reset, 'fileformats' is made empty.
8108 NOTE: This option is set to the Vi default value when 'compatible' is
8109 set and to the Vim default value when 'compatible' is reset.
8110
8111 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008112'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 others: default off)
8114 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 This option is obsolete. Use 'fileformat'.
8116 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8117 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8118 "unix".
8119
8120 *'textwidth'* *'tw'*
8121'textwidth' 'tw' number (default 0)
8122 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 Maximum width of text that is being inserted. A longer line will be
8124 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008125 this.
8126 'textwidth' is set to 0 when the 'paste' option is set and restored
8127 when 'paste' is reset.
8128 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008130 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 NOTE: This option is set to 0 when 'compatible' is set.
8132
8133 *'thesaurus'* *'tsr'*
8134'thesaurus' 'tsr' string (default "")
8135 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008136 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008137 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8138 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008139
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008140 This option is not used if 'thesaurusfunc' is set, either for the
8141 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008142
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008143 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008145 name. See |option-backslash| about using backslashes. The use of
8146 |:set+=| and |:set-=| is preferred when adding or removing directories
8147 from the list. This avoids problems when a future version uses
8148 another default. Backticks cannot be used in this option for security
8149 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008151 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008152'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008153 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008154 {not available when compiled without the |+eval|
8155 feature}
8156 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008157 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008158 The value can be the name of a function, a |lambda| or a |Funcref|.
8159 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008160
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008161 This option cannot be set from a |modeline| or in the |sandbox|, for
8162 security reasons.
8163
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8165'tildeop' 'top' boolean (default off)
8166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 When on: The tilde command "~" behaves like an operator.
8168 NOTE: This option is reset when 'compatible' is set.
8169
8170 *'timeout'* *'to'* *'notimeout'* *'noto'*
8171'timeout' 'to' boolean (default on)
8172 global
8173 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008174'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176 These two options together determine the behavior when part of a
8177 mapped key sequence or keyboard code has been received:
8178
8179 'timeout' 'ttimeout' action ~
8180 off off do not time out
8181 on on or off time out on :mappings and key codes
8182 off on time out on key codes
8183
8184 If both options are off, Vim will wait until either the complete
8185 mapping or key sequence has been received, or it is clear that there
8186 is no mapping or key sequence for the received characters. For
8187 example: if you have mapped "vl" and Vim has received 'v', the next
8188 character is needed to see if the 'v' is followed by an 'l'.
8189 When one of the options is on, Vim will wait for about 1 second for
8190 the next character to arrive. After that the already received
8191 characters are interpreted as single characters. The waiting time can
8192 be changed with the 'timeoutlen' option.
8193 On slow terminals or very busy systems timing out may cause
8194 malfunctioning cursor keys. If both options are off, Vim waits
8195 forever after an entered <Esc> if there are key codes that start
8196 with <Esc>. You will have to type <Esc> twice. If you do not have
8197 problems with key codes, but would like to have :mapped key
8198 sequences not timing out in 1 second, set the 'ttimeout' option and
8199 reset the 'timeout' option.
8200
8201 NOTE: 'ttimeout' is reset when 'compatible' is set.
8202
8203 *'timeoutlen'* *'tm'*
8204'timeoutlen' 'tm' number (default 1000)
8205 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008206
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008208'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210 The time in milliseconds that is waited for a key code or mapped key
8211 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8212 when part of a command has been typed.
8213 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8214 different timeout value for key codes is desired set 'ttimeoutlen' to
8215 a non-negative number.
8216
8217 ttimeoutlen mapping delay key code delay ~
8218 < 0 'timeoutlen' 'timeoutlen'
8219 >= 0 'timeoutlen' 'ttimeoutlen'
8220
8221 The timeout only happens when the 'timeout' and 'ttimeout' options
8222 tell so. A useful setting would be >
8223 :set timeout timeoutlen=3000 ttimeoutlen=100
8224< (time out on mapping after three seconds, time out on key codes after
8225 a tenth of a second).
8226
8227 *'title'* *'notitle'*
8228'title' boolean (default off, on when title can be restored)
8229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 When on, the title of the window will be set to the value of
8231 'titlestring' (if it is not empty), or to:
8232 filename [+=-] (path) - VIM
8233 Where:
8234 filename the name of the file being edited
8235 - indicates the file cannot be modified, 'ma' off
8236 + indicates the file was modified
8237 = indicates the file is read-only
8238 =+ indicates the file is read-only and modified
8239 (path) is the path of the file being edited
8240 - VIM the server name |v:servername| or "VIM"
8241 Only works if the terminal supports setting window titles
8242 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008243 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8245 *X11*
8246 When Vim was compiled with HAVE_X11 defined, the original title will
8247 be restored if possible. The output of ":version" will include "+X11"
8248 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8249 works for the icon name |'icon'|.
8250 But: When Vim was started with the |-X| argument, restoring the title
8251 will not work (except in the GUI).
8252 If the title cannot be restored, it is set to the value of 'titleold'.
8253 You might want to restore the title outside of Vim then.
8254 When using an xterm from a remote machine you can use this command:
8255 rsh machine_name xterm -display $DISPLAY &
8256 then the WINDOWID environment variable should be inherited and the
8257 title of the window should change back to what it should be after
8258 exiting Vim.
8259
8260 *'titlelen'*
8261'titlelen' number (default 85)
8262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008264 title. When the title is longer, only the end of the path name is
8265 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 Using a percentage makes this adapt to the width of the window. But
8267 it won't work perfectly, because the actual number of characters
8268 available also depends on the font used and other things in the title
8269 bar. When 'titlelen' is zero the full path is used. Otherwise,
8270 values from 1 to 30000 percent can be used.
8271 'titlelen' is also used for the 'titlestring' option.
8272
8273 *'titleold'*
8274'titleold' string (default "Thanks for flying Vim")
8275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 This option will be used for the window title when exiting Vim if the
8277 original title cannot be restored. Only happens if 'title' is on or
8278 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008279 This option cannot be set from a |modeline| or in the |sandbox|, for
8280 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008281 *'titlestring'*
8282'titlestring' string (default "")
8283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 When this option is not empty, it will be used for the title of the
8285 window. This happens only when the 'title' option is on.
8286 Only works if the terminal supports setting window titles (currently
8287 Amiga console, Win32 console, all GUI versions and terminals with a
8288 non-empty 't_ts' option).
8289 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008290 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008291
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 When this option contains printf-style '%' items, they will be
8293 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008294 This option cannot be set in a modeline when 'modelineexpr' is off.
8295
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 Example: >
8297 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8298 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8299< The value of 'titlelen' is used to align items in the middle or right
8300 of the available space.
8301 Some people prefer to have the file name first: >
8302 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8303< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008304 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305 separating space only when needed.
8306 NOTE: Use of special characters in 'titlestring' may cause the display
8307 to be garbled (e.g., when it contains a CR or NL character).
8308 {not available when compiled without the |+statusline| feature}
8309
8310 *'toolbar'* *'tb'*
8311'toolbar' 'tb' string (default "icons,tooltips")
8312 global
8313 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8314 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008315 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 possible values are:
8317 icons Toolbar buttons are shown with icons.
8318 text Toolbar buttons shown with text.
8319 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008320 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 tooltips Tooltips are active for toolbar buttons.
8322 Tooltips refer to the popup help text which appears after the mouse
8323 cursor is placed over a toolbar button for a brief moment.
8324
8325 If you want the toolbar to be shown with icons as well as text, do the
8326 following: >
8327 :set tb=icons,text
8328< Motif and Athena cannot display icons and text at the same time. They
8329 will show icons if both are requested.
8330
8331 If none of the strings specified in 'toolbar' are valid or if
8332 'toolbar' is empty, this option is ignored. If you want to disable
8333 the toolbar, you need to set the 'guioptions' option. For example: >
8334 :set guioptions-=T
8335< Also see |gui-toolbar|.
8336
8337 *'toolbariconsize'* *'tbis'*
8338'toolbariconsize' 'tbis' string (default "small")
8339 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008340 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008342 tiny Use tiny icons.
8343 small Use small icons (default).
8344 medium Use medium-sized icons.
8345 large Use large icons.
8346 huge Use even larger icons.
8347 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008349 the current theme. Common dimensions are giant=48x48, huge=32x32,
8350 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351
8352 If 'toolbariconsize' is empty, the global default size as determined
8353 by user preferences or the current theme is used.
8354
8355 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8356'ttybuiltin' 'tbi' boolean (default on)
8357 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 When on, the builtin termcaps are searched before the external ones.
8359 When off the builtin termcaps are searched after the external ones.
8360 When this option is changed, you should set the 'term' option next for
8361 the change to take effect, for example: >
8362 :set notbi term=$TERM
8363< See also |termcap|.
8364 Rationale: The default for this option is "on", because the builtin
8365 termcap entries are generally better (many systems contain faulty
8366 xterm entries...).
8367
8368 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8369'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8370 sun-cmd, screen, rxvt, dtterm or
8371 iris-ansi; also on when running Vim in
8372 a DOS console)
8373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374 Indicates a fast terminal connection. More characters will be sent to
8375 the screen for redrawing, instead of using insert/delete line
8376 commands. Improves smoothness of redrawing when there are multiple
8377 windows and the terminal does not support a scrolling region.
8378 Also enables the extra writing of characters at the end of each screen
8379 line for lines that wrap. This helps when using copy/paste with the
8380 mouse in an xterm and other terminals.
8381
8382 *'ttymouse'* *'ttym'*
8383'ttymouse' 'ttym' string (default depends on 'term')
8384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385 {only in Unix and VMS, doesn't work in the GUI; not
8386 available when compiled without |+mouse|}
8387 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008388 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 *xterm-mouse*
8390 xterm xterm-like mouse handling. The mouse generates
8391 "<Esc>[Mscr", where "scr" is three bytes:
8392 "s" = button state
8393 "c" = column plus 33
8394 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008395 This only works up to 223 columns! See "dec",
8396 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008397 xterm2 Works like "xterm", but with the xterm reporting the
8398 mouse position while the mouse is dragged. This works
8399 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008400 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 work. See below for how Vim detects this
8402 automatically.
8403 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008404 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008406 for the row and column. No other mouse events are
8407 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008408 *dec-mouse*
8409 dec DEC terminal mouse handling. The mouse generates a
8410 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008411 This is also available for an Xterm, if it was
8412 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 *jsbterm-mouse*
8414 jsbterm JSB term mouse handling.
8415 *pterm-mouse*
8416 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008417 *urxvt-mouse*
8418 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008419 The mouse works only if the terminal supports this
8420 encoding style, but it does not have 223 columns limit
8421 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008422 *sgr-mouse*
8423 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008424 mouse reporting. The mouse works even in columns
8425 beyond 223. This option is backward compatible with
8426 "xterm2" because it can also decode "xterm2" style
8427 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428
8429 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008430 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8431 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8433 recognized, if enabled at compile time. DEC terminal mouse codes
8434 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008435 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8436 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008438 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8439 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8440 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008441 Additionally, if vim is compiled with the |+termresponse| feature and
8442 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008443 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008445 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8446 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8447 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008448 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8449 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 :set t_RV=
8451<
8452 *'ttyscroll'* *'tsl'*
8453'ttyscroll' 'tsl' number (default 999)
8454 global
8455 Maximum number of lines to scroll the screen. If there are more lines
8456 to scroll the window is redrawn. For terminals where scrolling is
8457 very slow and redrawing is not slow this can be set to a small number,
8458 e.g., 3, to speed up displaying.
8459
8460 *'ttytype'* *'tty'*
8461'ttytype' 'tty' string (default from $TERM)
8462 global
8463 Alias for 'term', see above.
8464
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008465 *'undodir'* *'udir'*
8466'undodir' 'udir' string (default ".")
8467 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008468 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008469 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008470 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008471 "." means using the directory of the file. The undo file name for
8472 "file.txt" is ".file.txt.un~".
8473 For other directories the file name is the full path of the edited
8474 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008475 When writing: The first directory that exists is used. "." always
8476 works, no directories after "." will be used for writing.
8477 When reading all entries are tried to find an undo file. The first
8478 undo file that exists is used. When it cannot be read an error is
8479 given, no further entry is used.
8480 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008481 This option cannot be set from a |modeline| or in the |sandbox|, for
8482 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008483
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008484 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008485'undofile' 'udf' boolean (default off)
8486 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008487 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008488 When on, Vim automatically saves undo history to an undo file when
8489 writing a buffer to a file, and restores undo history from the same
8490 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008491 The directory where the undo file is stored is specified by 'undodir'.
8492 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008493 The undo file is not read when 'undoreload' causes the buffer from
8494 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008495 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008496 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008497
Bram Moolenaar071d4272004-06-13 20:20:40 +00008498 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008499'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008500 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008502 is kept in memory, higher numbers will cause more memory to be used.
8503 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8505 itself: >
8506 set ul=0
8507< But you can also get Vi compatibility by including the 'u' flag in
8508 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008509 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008510 Set to -1 for no undo at all. You might want to do this only for the
8511 current buffer: >
8512 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008514
8515 The local value is set to -123456 when the global value is to be used.
8516
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008517 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008519 *'undoreload'* *'ur'*
8520'undoreload' 'ur' number (default 10000)
8521 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008522 Save the whole buffer for undo when reloading it. This applies to the
8523 ":e!" command and reloading for when the buffer changed outside of
8524 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008525 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008526 of lines is smaller than the value of this option.
8527 Set this option to zero to disable undo for a reload.
8528
8529 When saving undo for a reload, any undo file is not read.
8530
8531 Note that this causes the whole buffer to be stored in memory. Set
8532 this option to a lower value if you run out of memory.
8533
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 *'updatecount'* *'uc'*
8535'updatecount' 'uc' number (default: 200)
8536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008537 After typing this many characters the swap file will be written to
8538 disk. When zero, no swap file will be created at all (see chapter on
8539 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8540 Vim with the "-n" option, see |startup|. When editing in readonly
8541 mode this option will be initialized to 10000.
8542 The swapfile can be disabled per buffer with |'swapfile'|.
8543 When 'updatecount' is set from zero to non-zero, swap files are
8544 created for all buffers that have 'swapfile' set. When 'updatecount'
8545 is set to zero, existing swap files are not deleted.
8546 Also see |'swapsync'|.
8547 This option has no meaning in buffers where |'buftype'| is "nofile"
8548 or "nowrite".
8549
8550 *'updatetime'* *'ut'*
8551'updatetime' 'ut' number (default 4000)
8552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 If this many milliseconds nothing is typed the swap file will be
8554 written to disk (see |crash-recovery|). Also used for the
8555 |CursorHold| autocommand event.
8556
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008557 *'varsofttabstop'* *'vsts'*
8558'varsofttabstop' 'vsts' string (default "")
8559 local to buffer
8560 {only available when compiled with the |+vartabs|
8561 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008562 A list of the number of spaces that a <Tab> counts for while editing,
8563 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8564 width <Tab>s are being inserted, while in fact a mixture of spaces
8565 and <Tab>s is used. Tab widths are separated with commas, with the
8566 final value applying to all subsequent tabs.
8567
8568 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008569 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008570 to use the following: >
8571 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008572< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8573 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008574
8575 Note that the value of |'softtabstop'| will be ignored while
8576 'varsofttabstop' is set.
8577
8578 *'vartabstop'* *'vts'*
8579'vartabstop' 'vts' string (default "")
8580 local to buffer
8581 {only available when compiled with the |+vartabs|
8582 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008583 A list of the number of spaces that a <Tab> in the file counts for,
8584 separated by commas. Each value corresponds to one tab, with the
8585 final value applying to all subsequent tabs. For example: >
8586 :set vartabstop=4,20,10,8
8587< This will make the first tab 4 spaces wide, the second 20 spaces,
8588 the third 10 spaces, and all following tabs 8 spaces.
8589
8590 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8591 is set.
8592
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 *'verbose'* *'vbs'*
8594'verbose' 'vbs' number (default 0)
8595 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 When bigger than zero, Vim will give messages about what it is doing.
8597 Currently, these messages are given:
8598 >= 1 When the viminfo file is read or written.
8599 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008600 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008601 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 >= 8 Files for which a group of autocommands is executed.
8603 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008604 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 >= 12 Every executed function.
8606 >= 13 When an exception is thrown, caught, finished, or discarded.
8607 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008608 >= 15 Every executed Ex command from a script (truncated at 200
8609 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008610 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611
8612 This option can also be set with the "-V" argument. See |-V|.
8613 This option is also set by the |:verbose| command.
8614
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008615 When the 'verbosefile' option is set then the verbose messages are not
8616 displayed.
8617
8618 *'verbosefile'* *'vfile'*
8619'verbosefile' 'vfile' string (default empty)
8620 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008621 When not empty all messages are written in a file with this name.
8622 When the file exists messages are appended.
8623 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008624 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008625 Setting 'verbosefile' to a new value is like making it empty first.
8626 The difference with |:redir| is that verbose messages are not
8627 displayed when 'verbosefile' is set.
8628
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008630'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 "$VIM/vimfiles/view",
8632 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008633 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008634 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008636 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 feature}
8638 Name of the directory where to store files for |:mkview|.
8639 This option cannot be set from a |modeline| or in the |sandbox|, for
8640 security reasons.
8641
8642 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008643'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008645 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 feature}
8647 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008648 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 word save and restore ~
8650 cursor cursor position in file and in window
8651 folds manually created folds, opened/closed folds and local
8652 fold options
8653 options options and mappings local to a window or buffer (not
8654 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008655 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 slash backslashes in file names replaced with forward
8657 slashes
8658 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008659 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008660 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008662 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008664 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665
8666 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008667'viminfo' 'vi' string (Vi default: "", Vim default for
8668 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008669 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8670 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008672 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673 feature}
8674 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008675 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8676 "NONE".
8677 The string should be a comma separated list of parameters, each
8678 consisting of a single character identifying the particular parameter,
8679 followed by a number or string which specifies the value of that
8680 parameter. If a particular character is left out, then the default
8681 value is used for that parameter. The following is a list of the
8682 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008684 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 ! When included, save and restore global variables that start
8686 with an uppercase letter, and don't contain a lowercase
8687 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008688 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008689 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008690 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 " Maximum number of lines saved for each register. Old name of
8692 the '<' item, with the disadvantage that you need to put a
8693 backslash before the ", otherwise it will be recognized as the
8694 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008695 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 % When included, save and restore the buffer list. If Vim is
8697 started with a file name argument, the buffer list is not
8698 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008699 buffer list is restored from the viminfo file. Quickfix
8700 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8701 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008702 When followed by a number, the number specifies the maximum
8703 number of buffers that are stored. Without a number all
8704 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008705 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 ' Maximum number of previously edited files for which the marks
8707 are remembered. This parameter must always be included when
8708 'viminfo' is non-empty.
8709 Including this item also means that the |jumplist| and the
8710 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008711 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008713 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714 patterns are also saved. When not included, the value of
8715 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008716 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008718 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008719 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 < Maximum number of lines saved for each register. If zero then
8721 registers are not saved. When not included, all lines are
8722 saved. '"' is the old name for this item.
8723 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008724 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008725 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008726 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008727 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 c When included, convert the text in the viminfo file from the
8729 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008730 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008731 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 f Whether file marks need to be stored. If zero, file marks ('0
8733 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008734 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008736 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737 h Disable the effect of 'hlsearch' when loading the viminfo
8738 file. When not included, it depends on whether ":nohlsearch"
8739 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008740 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008742 the 'n'. Must be at the end of the option! If the
8743 'viminfofile' option is set, that file name overrides the one
8744 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008745 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008746 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 r Removable media. The argument is a string (up to the next
8748 ','). This parameter can be given several times. Each
8749 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008750 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8752 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8753 ignored. Maximum length of each 'r' argument is 50
8754 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008755 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 s Maximum size of an item in Kbyte. If zero then registers are
8757 not saved. Currently only applies to registers. The default
8758 "s10" will exclude registers with more than 10 Kbyte of text.
8759 Also see the '<' item above: line count limit.
8760
8761 Example: >
8762 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8763<
8764 '50 Marks will be remembered for the last 50 files you
8765 edited.
8766 <1000 Contents of registers (up to 1000 lines each) will be
8767 remembered.
8768 s100 Registers with more than 100 Kbyte text are skipped.
8769 :0 Command-line history will not be saved.
8770 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8771 no / Since '/' is not specified, the default will be used,
8772 that is, save all of the search history, and also the
8773 previous search and substitute patterns.
8774 no % The buffer list will not be saved nor read back.
8775 no h 'hlsearch' highlighting will be restored.
8776
8777 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8778 load the contents of the file, this is not done automatically.
8779
8780 This option cannot be set from a |modeline| or in the |sandbox|, for
8781 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008782 NOTE: This option is set to the Vim default value when 'compatible'
8783 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008785 *'viminfofile'* *'vif'*
8786'viminfofile' 'vif' string (default: "")
8787 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008788 {not available when compiled without the |+viminfo|
8789 feature}
8790 When non-empty, overrides the file name used for viminfo.
8791 When equal to "NONE" no viminfo file will be read or written.
8792 This option can be set with the |-i| command line flag. The |--clean|
8793 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008794 This option cannot be set from a |modeline| or in the |sandbox|, for
8795 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008796
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 *'virtualedit'* *'ve'*
8798'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008799 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 A comma separated list of these words:
8801 block Allow virtual editing in Visual block mode.
8802 insert Allow virtual editing in Insert mode.
8803 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008804 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008805 none When used as the local value, do not allow virtual
8806 editing even when the global value is set. When used
8807 as the global value, "none" is the same as "".
8808 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008809
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008811 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 of the line. Useful for selecting a rectangle in Visual mode and
8813 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008814 "onemore" is not the same, it will only allow moving the cursor just
8815 after the last character of the line. This makes some commands more
8816 consistent. Previously the cursor was always past the end of the line
8817 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008818 break some plugins or Vim scripts. For example because |l| can move
8819 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008820 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008821 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008822 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008823 It doesn't make sense to combine "all" with "onemore", but you will
8824 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008825 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008826 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008827
8828 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8829'visualbell' 'vb' boolean (default off)
8830 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008831 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008833 use: >
8834 :set vb t_vb=
8835< If you want a short flash, you can use this on many terminals: >
8836 :set vb t_vb=[?5h$<100>[?5l
8837< Here $<100> specifies the time, you can use a smaller or bigger value
8838 to get a shorter or longer flash.
8839
8840 Note: Vim will limit the bell to once per half a second. This avoids
8841 having to wait for the flashing to finish when there are lots of
8842 bells, e.g. on key repeat. This also happens without 'visualbell'
8843 set.
8844
Bram Moolenaar071d4272004-06-13 20:20:40 +00008845 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8846 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8847 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008848
8849 Note: When the GUI starts, 't_vb' is reset to its default value. You
8850 might want to set it again in your |gvimrc|.
8851
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 Does not work on the Amiga, you always get a screen flash.
8853 Also see 'errorbells'.
8854
8855 *'warn'* *'nowarn'*
8856'warn' boolean (default on)
8857 global
8858 Give a warning message when a shell command is used while the buffer
8859 has been changed.
8860
8861 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8862'weirdinvert' 'wiv' boolean (default off)
8863 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008864 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008865 It is provided for backwards compatibility with version 4.x.
8866 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8867 vice versa. Has no effect when the GUI is running.
8868
8869 *'whichwrap'* *'ww'*
8870'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 Allow specified keys that move the cursor left/right to move to the
8873 previous/next line when the cursor is on the first/last character in
8874 the line. Concatenate characters to allow this for these keys:
8875 char key mode ~
8876 b <BS> Normal and Visual
8877 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008878 h "h" Normal and Visual (not recommended)
8879 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880 < <Left> Normal and Visual
8881 > <Right> Normal and Visual
8882 ~ "~" Normal
8883 [ <Left> Insert and Replace
8884 ] <Right> Insert and Replace
8885 For example: >
8886 :set ww=<,>,[,]
8887< allows wrap only when cursor keys are used.
8888 When the movement keys are used in combination with a delete or change
8889 operator, the <EOL> also counts for a character. This makes "3h"
8890 different from "3dh" when the cursor crosses the end of a line. This
8891 is also true for "x" and "X", because they do the same as "dl" and
8892 "dh". If you use this, you may also want to use the mapping
8893 ":map <BS> X" to make backspace delete the character in front of the
8894 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008895 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008896 line (not an empty line) then it will not move to the next line. This
8897 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 NOTE: This option is set to the Vi default value when 'compatible' is
8899 set and to the Vim default value when 'compatible' is reset.
8900
8901 *'wildchar'* *'wc'*
8902'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008904 Character you have to type to start wildcard expansion in the
8905 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008906 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008907 The character is not recognized when used inside a macro. See
8908 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008909 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008911 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008912< NOTE: This option is set to the Vi default value when 'compatible' is
8913 set and to the Vim default value when 'compatible' is reset.
8914
8915 *'wildcharm'* *'wcm'*
8916'wildcharm' 'wcm' number (default: none (0))
8917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008919 recognized when used inside a macro. You can find "spare" command-line
8920 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 you'll never actually type 'wildcharm', just use it in mappings that
8922 automatically invoke completion mode, e.g.: >
8923 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008924 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925< Then after typing :ss you can use CTRL-P & CTRL-N.
8926
8927 *'wildignore'* *'wig'*
8928'wildignore' 'wig' string (default "")
8929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 {not available when compiled without the |+wildignore|
8931 feature}
8932 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008933 patterns is ignored when expanding |wildcards|, completing file or
8934 directory names, and influences the result of |expand()|, |glob()| and
8935 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008936 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8937 Also see 'suffixes'.
8938 Example: >
8939 :set wildignore=*.o,*.obj
8940< The use of |:set+=| and |:set-=| is preferred when adding or removing
8941 a pattern from the list. This avoids problems when a future version
8942 uses another default.
8943
Bram Moolenaar94950a92010-12-02 16:01:29 +01008944
Bram Moolenaar81af9252010-12-10 20:35:50 +01008945 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008946'wildignorecase' 'wic' boolean (default off)
8947 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008948 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008949 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008950 Does not apply when the shell is used to expand wildcards, which
8951 happens when there are special characters.
8952
8953
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008955'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 {not available if compiled without the |+wildmenu|
8958 feature}
8959 When 'wildmenu' is on, command-line completion operates in an enhanced
8960 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8961 the possible matches are shown just above the command line, with the
8962 first match highlighted (overwriting the status line, if there is
8963 one). Keys that show the previous/next match, such as <Tab> or
8964 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8965 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8966 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008967 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 If there are more matches than can fit in the line, a ">" is shown on
8969 the right and/or a "<" is shown on the left. The status line scrolls
8970 as needed.
8971 The "wildmenu" mode is abandoned when a key is hit that is not used
8972 for selecting a completion.
8973 While the "wildmenu" is active the following keys have special
8974 meanings:
8975
8976 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8977 <Down> - in filename/menu name completion: move into a
8978 subdirectory or submenu.
8979 <CR> - in menu completion, when the cursor is just after a
8980 dot: move into a submenu.
8981 <Up> - in filename/menu name completion: move up into
8982 parent directory or parent menu.
8983
8984 This makes the menus accessible from the console |console-menus|.
8985
8986 If you prefer the <Left> and <Right> keys to move the cursor instead
8987 of selecting a different match, use this: >
8988 :cnoremap <Left> <Space><BS><Left>
8989 :cnoremap <Right> <Space><BS><Right>
8990<
8991 The "WildMenu" highlighting is used for displaying the current match
8992 |hl-WildMenu|.
8993
8994 *'wildmode'* *'wim'*
8995'wildmode' 'wim' string (Vim default: "full")
8996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008997 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008998 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008999 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009000 first part specifies the behavior for the first use of 'wildchar',
9001 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009002
9003 Each part consists of a colon separated list consisting of the
9004 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 "" Complete only the first match.
9006 "full" Complete the next full match. After the last match,
9007 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009008 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009009 "longest" Complete till longest common string. If this doesn't
9010 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009012 "lastused" When completing buffer names and more than one buffer
9013 matches, sort buffers by time last used (other than
9014 the current buffer).
9015 When there is only a single match, it is fully completed in all cases.
9016
9017 Examples of useful colon-separated values:
9018 "longest:full" Like "longest", but also start 'wildmenu' if it is
9019 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009020 "list:full" When more than one match, list all matches and
9021 complete first match.
9022 "list:longest" When more than one match, list all matches and
9023 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009024 "list:lastused" When more than one buffer matches, list all matches
9025 and sort buffers by time last used (other than the
9026 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009027
9028 Examples: >
9029 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009030< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 :set wildmode=longest,full
9032< Complete longest common string, then each full match >
9033 :set wildmode=list:full
9034< List all matches and complete each full match >
9035 :set wildmode=list,full
9036< List all matches without completing, then each full match >
9037 :set wildmode=longest,list
9038< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009039 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009040
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009041 *'wildoptions'* *'wop'*
9042'wildoptions' 'wop' string (default "")
9043 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009044 {not available when compiled without the |+wildignore|
9045 feature}
9046 A list of words that change how command line completion is done.
9047 Currently only one word is allowed:
9048 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009049 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009050 is displayed per line. Often used tag kinds are:
9051 d #define
9052 f function
9053 Also see |cmdline-completion|.
9054
Bram Moolenaar071d4272004-06-13 20:20:40 +00009055 *'winaltkeys'* *'wak'*
9056'winaltkeys' 'wak' string (default "menu")
9057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 {only used in Win32, Motif, GTK and Photon GUI}
9059 Some GUI versions allow the access to menu entries by using the ALT
9060 key in combination with a character that appears underlined in the
9061 menu. This conflicts with the use of the ALT key for mappings and
9062 entering special characters. This option tells what to do:
9063 no Don't use ALT keys for menus. ALT key combinations can be
9064 mapped, but there is no automatic handling. This can then be
9065 done with the |:simalt| command.
9066 yes ALT key handling is done by the windowing system. ALT key
9067 combinations cannot be mapped.
9068 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009069 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070 keys can be mapped.
9071 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9072 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009073 This option is not used for <F10>; on Win32 and with GTK <F10> will
9074 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009076 *'wincolor'* *'wcr'*
9077'wincolor' 'wcr' string (default empty)
9078 local to window
9079 Highlight group name to use for this window instead of the Normal
9080 color |hl-Normal|.
9081
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009082 *'window'* *'wi'*
9083'window' 'wi' number (default screen height - 1)
9084 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009085 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9086 window and the value is smaller than 'lines' minus one. The screen
9087 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009088 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9089 in a much smarter way, taking care of wrapping lines.
9090 When resizing the Vim window, the value is smaller than 1 or more than
9091 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009092 Note: Do not confuse this with the height of the Vim window, use
9093 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009094
Bram Moolenaar071d4272004-06-13 20:20:40 +00009095 *'winheight'* *'wh'* *E591*
9096'winheight' 'wh' number (default 1)
9097 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009098 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009099 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009100 focus goes to a window that is smaller, its size is increased, at the
9101 cost of the height of other windows.
9102 Set 'winheight' to a small number for normal editing.
9103 Set it to 999 to make the current window fill most of the screen.
9104 Other windows will be only 'winminheight' high. This has the drawback
9105 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9106 to create only two windows, set the option after startup is done,
9107 using the |VimEnter| event: >
9108 au VimEnter * set winheight=999
9109< Minimum value is 1.
9110 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009111 height of the current window.
9112 'winheight' applies to the current window. Use 'winminheight' to set
9113 the minimal height for other windows.
9114
9115 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9116'winfixheight' 'wfh' boolean (default off)
9117 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009119 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9120 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121 The height may be changed anyway when running out of room.
9122
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009123 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9124'winfixwidth' 'wfw' boolean (default off)
9125 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009126 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009127 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009128 The width may be changed anyway when running out of room.
9129
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 *'winminheight'* *'wmh'*
9131'winminheight' 'wmh' number (default 1)
9132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009133 The minimal height of a window, when it's not the current window.
9134 This is a hard minimum, windows will never become smaller.
9135 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9136 status bar) if necessary. They will return to at least one line when
9137 they become active (since the cursor has to have somewhere to go.)
9138 Use 'winheight' to set the minimal height of the current window.
9139 This option is only checked when making a window smaller. Don't use a
9140 large number, it will cause errors when opening more than a few
9141 windows. A value of 0 to 3 is reasonable.
9142
9143 *'winminwidth'* *'wmw'*
9144'winminwidth' 'wmw' number (default 1)
9145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146 The minimal width of a window, when it's not the current window.
9147 This is a hard minimum, windows will never become smaller.
9148 When set to zero, windows may be "squashed" to zero columns (i.e. just
9149 a vertical separator) if necessary. They will return to at least one
9150 line when they become active (since the cursor has to have somewhere
9151 to go.)
9152 Use 'winwidth' to set the minimal width of the current window.
9153 This option is only checked when making a window smaller. Don't use a
9154 large number, it will cause errors when opening more than a few
9155 windows. A value of 0 to 12 is reasonable.
9156
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009157 *'winptydll'*
9158'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9159 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009160 {only available when compiled with the |terminal|
9161 feature on MS-Windows}
9162 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009163 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009164 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009165 a fallback.
9166 Environment variables are expanded |:set_env|.
9167 This option cannot be set from a |modeline| or in the |sandbox|, for
9168 security reasons.
9169
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170 *'winwidth'* *'wiw'* *E592*
9171'winwidth' 'wiw' number (default 20)
9172 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 Minimal number of columns for the current window. This is not a hard
9174 minimum, Vim will use fewer columns if there is not enough room. If
9175 the current window is smaller, its size is increased, at the cost of
9176 the width of other windows. Set it to 999 to make the current window
9177 always fill the screen. Set it to a small number for normal editing.
9178 The width is not adjusted after one of the commands to change the
9179 width of the current window.
9180 'winwidth' applies to the current window. Use 'winminwidth' to set
9181 the minimal width for other windows.
9182
9183 *'wrap'* *'nowrap'*
9184'wrap' boolean (default on)
9185 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009186 This option changes how text is displayed. It doesn't change the text
9187 in the buffer, see 'textwidth' for that.
9188 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009189 displaying continues on the next line. When off lines will not wrap
9190 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009191 moved to a part that is not shown, the screen will scroll
9192 horizontally.
9193 The line will be broken in the middle of a word if necessary. See
9194 'linebreak' to get the break at a word boundary.
9195 To make scrolling horizontally a bit more useful, try this: >
9196 :set sidescroll=5
9197 :set listchars+=precedes:<,extends:>
9198< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009199 This option can't be set from a |modeline| when the 'diff' option is
9200 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009201
9202 *'wrapmargin'* *'wm'*
9203'wrapmargin' 'wm' number (default 0)
9204 local to buffer
9205 Number of characters from the right window border where wrapping
9206 starts. When typing text beyond this limit, an <EOL> will be inserted
9207 and inserting continues on the next line.
9208 Options that add a margin, such as 'number' and 'foldcolumn', cause
9209 the text width to be further reduced. This is Vi compatible.
9210 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009211 This option is set to 0 when 'paste' is set and restored when 'paste'
9212 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009213 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009214
9215 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9216'wrapscan' 'ws' boolean (default on) *E384* *E385*
9217 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009218 Searches wrap around the end of the file. Also applies to |]s| and
9219 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009220
9221 *'write'* *'nowrite'*
9222'write' boolean (default on)
9223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 Allows writing files. When not set, writing a file is not allowed.
9225 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009226 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009227 argument. Filtering text is still possible, even though this requires
9228 writing a temporary file.
9229
9230 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9231'writeany' 'wa' boolean (default off)
9232 global
9233 Allows writing to any file with no need for "!" override.
9234
9235 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9236'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9237 otherwise)
9238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239 Make a backup before overwriting a file. The backup is removed after
9240 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009241 also on.
9242 WARNING: Switching this option off means that when Vim fails to write
9243 your buffer correctly and then, for whatever reason, Vim exits, you
9244 lose both the original file and what you were writing. Only reset
9245 this option if your file system is almost full and it makes the write
9246 fail (and make sure not to exit Vim until the write was successful).
9247 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009249 Depending on 'backupcopy' the backup is a new file or the original
9250 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009251 NOTE: This option is set to the default value when 'compatible' is
9252 set.
9253
9254 *'writedelay'* *'wd'*
9255'writedelay' 'wd' number (default 0)
9256 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009257 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009258 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009259 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009260
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009261 *'xtermcodes'* *'noxtermcodes'*
9262'xtermcodes' boolean (default on)
9263 global
9264 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009265 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009266 key codes and number of colors from the terminal. This takes care of
9267 various configuration options of the terminal that cannot be obtained
9268 from the termlib/terminfo entry, see |xterm-codes|.
9269 A side effect may be that t_Co changes and Vim will redraw the
9270 display.
9271
9272
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009273 vim:tw=78:ts=8:noet:ft=help:norl: