blob: 1d3f76864b2f70a714c549c3333ee803d31d914e [file] [log] [blame]
Bram Moolenaar9da17d72022-02-09 21:50:44 +00001*options.txt* For Vim version 8.2. Last change: 2022 Feb 08
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.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000803 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200804
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
806'arabic' 'arab' boolean (default off)
807 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 {only available when compiled with the |+arabic|
809 feature}
810 This option can be set to start editing Arabic text.
811 Setting this option will:
812 - Set the 'rightleft' option, unless 'termbidi' is set.
813 - Set the 'arabicshape' option, unless 'termbidi' is set.
814 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
815 between typing English and Arabic key mapping.
816 - Set the 'delcombine' option
817 Note that 'encoding' must be "utf-8" for working with Arabic text.
818
819 Resetting this option will:
820 - Reset the 'rightleft' option.
821 - Disable the use of 'keymap' (without changing its value).
822 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200823 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100824 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825 Also see |arabic.txt|.
826
827 *'arabicshape'* *'arshape'*
828 *'noarabicshape'* *'noarshape'*
829'arabicshape' 'arshape' boolean (default on)
830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 {only available when compiled with the |+arabic|
832 feature}
833 When on and 'termbidi' is off, the required visual character
834 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200835 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 one which encompasses:
837 a) the changing/morphing of characters based on their location
838 within a word (initial, medial, final and stand-alone).
839 b) the enabling of the ability to compose characters
840 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100841 When disabled the display shows each character's true stand-alone
842 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 Arabic is a complex language which requires other settings, for
844 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100845 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846
847 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
848'autoindent' 'ai' boolean (default off)
849 local to buffer
850 Copy indent from current line when starting a new line (typing <CR>
851 in Insert mode or when using the "o" or "O" command). If you do not
852 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000853 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
854 to another line has the same effect, unless the 'I' flag is included
855 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000856 When autoindent is on, formatting (with the "gq" command or when you
857 reach 'textwidth' in Insert mode) uses the indentation of the first
858 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 When 'smartindent' or 'cindent' is on the indent is changed in
860 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200861 The 'autoindent' option is reset when the 'paste' option is set and
862 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863
864 *'autoread'* *'ar'* *'noautoread'* *'noar'*
865'autoread' 'ar' boolean (default off)
866 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 When a file has been detected to have been changed outside of Vim and
868 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200869 When the file has been deleted this is not done, so you have the text
870 from before it was deleted. When it appears again then it is read.
871 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 If this option has a local value, use this command to switch back to
873 using the global value: >
874 :set autoread<
875<
876 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
877'autowrite' 'aw' boolean (default off)
878 global
879 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000880 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000881 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
882 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000883 to another file.
884 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000885 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 Note that for some commands the 'autowrite' option is not used, see
887 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200888 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200889 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890
891 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
892'autowriteall' 'awa' boolean (default off)
893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
895 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
896 Setting this option also implies that Vim behaves like 'autowrite' has
897 been set.
898
899 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200900'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 When set to "dark", Vim will try to use colors that look good on a
903 dark background. When set to "light", Vim will try to use colors that
904 look good on a light background. Any other value is illegal.
905 Vim tries to set the default value according to the terminal used.
906 This will not always be correct.
907 Setting this option does not change the background color, it tells Vim
908 what the background color looks like. For changing the background
909 color, see |:hi-normal|.
910
911 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000912 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000913 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100914 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 setting 'background' will cause the color scheme to be reloaded. If
916 the color scheme adjusts to the value of 'background' this will work.
917 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100918 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000919
920 When setting 'background' to the default value with: >
921 :set background&
922< Vim will guess the value. In the GUI this should work correctly,
923 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200924 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200925 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200927 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200928 color from the terminal. If the returned RGB value is dark/light and
929 'background' is not dark/light, 'background' will be set and the
930 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200931 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100932 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200933
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 When starting the GUI, the default value for 'background' will be
935 "light". When the value is not set in the .gvimrc, and Vim detects
936 that the background is actually quite dark, 'background' is set to
937 "dark". But this happens only AFTER the .gvimrc file has been read
938 (because the window needs to be opened to find the actual background
939 color). To get around this, force the GUI window to be opened by
940 putting a ":gui" command in the .gvimrc file, before where the value
941 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200942
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100943 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200944 For other systems "dark" is used when 'term' is "linux",
945 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
946 background. Otherwise the default is "light".
947
Bram Moolenaarc572da52017-08-27 16:52:01 +0200948 The |:terminal| command and the |term_start()| function use the
949 'background' value to decide whether the terminal window will start
950 with a white or black background.
951
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952 Normally this option would be set in the .vimrc file. Possibly
953 depending on the terminal name. Example: >
954 :if &term == "pcterm"
955 : set background=dark
956 :endif
957< When this option is set, the default settings for the highlight groups
958 will change. To use other settings, place ":highlight" commands AFTER
959 the setting of the 'background' option.
960 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
961 to select the colors for syntax highlighting. After changing this
962 option, you must load syntax.vim again to see the result. This can be
963 done with ":syntax on".
964
965 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200966'backspace' 'bs' string (default "", set to "indent,eol,start"
967 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
970 mode. This is a list of items, separated by commas. Each item allows
971 a way to backspace over something:
972 value effect ~
973 indent allow backspacing over autoindent
974 eol allow backspacing over line breaks (join lines)
975 start allow backspacing over the start of insert; CTRL-W and CTRL-U
976 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200977 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
978 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979
980 When the value is empty, Vi compatible backspacing is used.
981
982 For backwards compatibility with version 5.4 and earlier:
983 value effect ~
984 0 same as ":set backspace=" (Vi compatible)
985 1 same as ":set backspace=indent,eol"
986 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200987 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988
989 See |:fixdel| if your <BS> or <Del> key does not do what you want.
990 NOTE: This option is set to "" when 'compatible' is set.
991
992 *'backup'* *'bk'* *'nobackup'* *'nobk'*
993'backup' 'bk' boolean (default off)
994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 Make a backup before overwriting a file. Leave it around after the
996 file has been successfully written. If you do not want to keep the
997 backup file, but you do want a backup while the file is being
998 written, reset this option and set the 'writebackup' option (this is
999 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001000 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001001 |backup-table| for more explanations.
1002 When the 'backupskip' pattern matches, a backup is not made anyway.
1003 When 'patchmode' is set, the backup may be renamed to become the
1004 oldest version of a file.
1005 NOTE: This option is reset when 'compatible' is set.
1006
1007 *'backupcopy'* *'bkc'*
1008'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001009 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 When writing a file and a backup is made, this option tells how it's
1011 done. This is a comma separated list of words.
1012
1013 The main values are:
1014 "yes" make a copy of the file and overwrite the original one
1015 "no" rename the file and write a new one
1016 "auto" one of the previous, what works best
1017
1018 Extra values that can be combined with the ones above are:
1019 "breaksymlink" always break symlinks when writing
1020 "breakhardlink" always break hardlinks when writing
1021
1022 Making a copy and overwriting the original file:
1023 - Takes extra time to copy the file.
1024 + When the file has special attributes, is a (hard/symbolic) link or
1025 has a resource fork, all this is preserved.
1026 - When the file is a link the backup will have the name of the link,
1027 not of the real file.
1028
1029 Renaming the file and writing a new one:
1030 + It's fast.
1031 - Sometimes not all attributes of the file can be copied to the new
1032 file.
1033 - When the file is a link the new file will not be a link.
1034
1035 The "auto" value is the middle way: When Vim sees that renaming file
1036 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001037 the file is not a link) that is used. When problems are expected, a
1038 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039
1040 The "breaksymlink" and "breakhardlink" values can be used in
1041 combination with any of "yes", "no" and "auto". When included, they
1042 force Vim to always break either symbolic or hard links by doing
1043 exactly what the "no" option does, renaming the original file to
1044 become the backup and writing a new file in its place. This can be
1045 useful for example in source trees where all the files are symbolic or
1046 hard links and any changes should stay in the local source tree, not
1047 be propagated back to the original source.
1048 *crontab*
1049 One situation where "no" and "auto" will cause problems: A program
1050 that opens a file, invokes Vim to edit that file, and then tests if
1051 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001052 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 example.
1054
1055 When a copy is made, the original file is truncated and then filled
1056 with the new text. This means that protection bits, owner and
1057 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001058 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059 group of the backup is set to the group of the original file. If this
1060 fails, the protection bits for the group are made the same as for
1061 others.
1062
1063 When the file is renamed this is the other way around: The backup has
1064 the same attributes of the original file, and the newly written file
1065 is owned by the current user. When the file was a (hard/symbolic)
1066 link, the new file will not! That's why the "auto" value doesn't
1067 rename when the file is a link. The owner and group of the newly
1068 written file will be set to the same ones as the original file, but
1069 the system may refuse to do this. In that case the "auto" value will
1070 again not rename the file.
1071
Bram Moolenaar036986f2017-03-16 17:41:02 +01001072 NOTE: This option is set to the Vi default value when 'compatible' is
1073 set and to the Vim default value when 'compatible' is reset.
1074
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 *'backupdir'* *'bdir'*
1076'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001077 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 for Unix: ".,~/tmp,~/")
1079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 List of directories for the backup file, separated with commas.
1081 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001082 where this is possible. The directory must exist, Vim will not
1083 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001084 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085 impossible!). Writing may fail because of this.
1086 - A directory "." means to put the backup file in the same directory
1087 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001088 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1089 the backup file relative to where the edited file is. The leading
1090 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 ("." inside a directory name has no special meaning).
1092 - Spaces after the comma are ignored, other spaces are considered part
1093 of the directory name. To have a space at the start of a directory
1094 name, precede it with a backslash.
1095 - To include a comma in a directory name precede it with a backslash.
1096 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001097 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001098 the backup file name will be built from the complete path to the
1099 file with all path separators changed to percent '%' signs. This
1100 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001101 On Win32, it is also possible to end with "\\". However, When a
1102 separating comma is following, you must use "//", since "\\" will
1103 include the comma in the file name. Therefore it is recommended to
1104 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 - Environment variables are expanded |:set_env|.
1106 - Careful with '\' characters, type one before a space, type two to
1107 get one in the option (see |option-backslash|), for example: >
1108 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1109< - For backwards compatibility with Vim version 3.0 a '>' at the start
1110 of the option is removed.
1111 See also 'backup' and 'writebackup' options.
1112 If you want to hide your backup files on Unix, consider this value: >
1113 :set backupdir=./.backup,~/.backup,.,/tmp
1114< You must create a ".backup" directory in each directory and in your
1115 home directory for this to work properly.
1116 The use of |:set+=| and |:set-=| is preferred when adding or removing
1117 directories from the list. This avoids problems when a future version
1118 uses another default.
1119 This option cannot be set from a |modeline| or in the |sandbox|, for
1120 security reasons.
1121
1122 *'backupext'* *'bex'* *E589*
1123'backupext' 'bex' string (default "~", for VMS: "_")
1124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 String which is appended to a file name to make the name of the
1126 backup file. The default is quite unusual, because this avoids
1127 accidentally overwriting existing files with a backup file. You might
1128 prefer using ".bak", but make sure that you don't have files with
1129 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001130 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001132 If you like to keep a lot of backups, you could use a BufWritePre
1133 autocommand to change 'backupext' just before writing the file to
1134 include a timestamp. >
1135 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1136< Use 'backupdir' to put the backup in a different directory.
1137
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001139'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1140 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1141 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143 {not available when compiled without the |+wildignore|
1144 feature}
1145 A list of file patterns. When one of the patterns matches with the
1146 name of the file which is written, no backup file is created. Both
1147 the specified file name and the full path name of the file are used.
1148 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1149 Watch out for special characters, see |option-backslash|.
1150 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001151 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001152
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001153 WARNING: Not having a backup file means that when Vim fails to write
1154 your buffer correctly and then, for whatever reason, Vim exits, you
1155 lose both the original file and what you were writing. Only disable
1156 backups if you don't care about losing the file.
1157
Bram Moolenaar02467872007-05-06 13:22:01 +00001158 Note that environment variables are not expanded. If you want to use
1159 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001160 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001161
1162< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001163 backup would be made by renaming the original file crontab won't see
1164 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165
1166 *'balloondelay'* *'bdlay'*
1167'balloondelay' 'bdlay' number (default: 600)
1168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 {only available when compiled with the |+balloon_eval|
1170 feature}
1171 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1172
1173 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1174'ballooneval' 'beval' boolean (default off)
1175 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001177 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001178 Switch on the |balloon-eval| functionality for the GUI.
1179
1180 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1181 *'nobevalterm'*
1182'balloonevalterm' 'bevalterm' boolean (default off)
1183 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001184 {only available when compiled with the
1185 |+balloon_eval_term| feature}
1186 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001188 *'balloonexpr'* *'bexpr'*
1189'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001190 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001191 {only available when compiled with the |+balloon_eval|
1192 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001193 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001194 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1195 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001196
1197 v:beval_bufnr number of the buffer in which balloon is going to show
1198 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001199 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001200 v:beval_lnum line number
1201 v:beval_col column number (byte index)
1202 v:beval_text word under or after the mouse pointer
1203
Bram Moolenaar54775062019-07-31 21:07:14 +02001204 Instead of showing a balloon, which is limited to plain text, consider
1205 using a popup window, see |popup_beval_example|. A popup window can
1206 use highlighting and show a border.
1207
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001208 The evaluation of the expression must not have side effects!
1209 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001210 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001211 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001212 \', column ' . v:beval_col .
1213 \ ' of file ' . bufname(v:beval_bufnr) .
1214 \ ' on word "' . v:beval_text . '"'
1215 endfunction
1216 set bexpr=MyBalloonExpr()
1217 set ballooneval
1218<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001219 Also see |balloon_show()|, it can be used if the content of the balloon
1220 is to be fetched asynchronously. In that case evaluating
1221 'balloonexpr' should result in an empty string. If you get a balloon
1222 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001223
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001224 NOTE: The balloon is displayed only if the cursor is on a text
1225 character. If the result of evaluating 'balloonexpr' is not empty,
1226 Vim does not try to send a message to an external debugger (Netbeans
1227 or Sun Workshop).
1228
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001229 If the expression starts with s: or |<SID>|, then it is replaced with
1230 the script ID (|local-function|). Example: >
1231 set bexpr=s:MyBalloonExpr()
1232 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001233< Otherwise, the expression is evaluated in the context of the script
1234 where the option was set, thus script-local items are available.
1235
Bram Moolenaar30b65812012-07-12 22:01:11 +02001236 The expression will be evaluated in the |sandbox| when set from a
1237 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001238 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001239
1240 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001241 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001242
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001243 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001244 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001245< When they are supported "\n" characters will start a new line. If the
1246 expression evaluates to a |List| this is equal to using each List item
1247 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001248 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001249
Bram Moolenaar165bc692015-07-21 17:53:25 +02001250 *'belloff'* *'bo'*
1251'belloff' 'bo' string (default "")
1252 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001253 Specifies for which events the bell will not be rung. It is a comma
1254 separated list of items. For each item that is present, the bell
1255 will be silenced. This is most useful to specify specific events in
1256 insert mode to be silenced.
1257
1258 item meaning when present ~
1259 all All events.
1260 backspace When hitting <BS> or <Del> and deleting results in an
1261 error.
1262 cursor Fail to move around using the cursor keys or
1263 <PageUp>/<PageDown> in |Insert-mode|.
1264 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1265 |i_CTRL-X_CTRL-T|.
1266 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1267 |i_CTRL-E|.
1268 ctrlg Unknown Char after <C-G> in Insert mode.
1269 error Other Error occurred (e.g. try to join last line)
1270 (mostly used in |Normal-mode| or |Cmdline-mode|).
1271 esc hitting <Esc> in |Normal-mode|.
1272 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001273 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001274 insertmode Pressing <Esc> in 'insertmode'.
1275 lang Calling the beep module for Lua/Mzscheme/TCL.
1276 mess No output available for |g<|.
1277 showmatch Error occurred for 'showmatch' function.
1278 operator Empty region error |cpo-E|.
1279 register Unknown register after <C-R> in |Insert-mode|.
1280 shell Bell from shell output |:!|.
1281 spell Error happened on spell suggest.
1282 wildmode More matches in |cmdline-completion| available
1283 (depends on the 'wildmode' setting).
1284
Bram Moolenaar036986f2017-03-16 17:41:02 +01001285 This is most useful to fine tune when in Insert mode the bell should
1286 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001287 indicate that an error occurred. It can be silenced by adding the
1288 "error" keyword.
1289
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1291'binary' 'bin' boolean (default off)
1292 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293 This option should be set before editing a binary file. You can also
1294 use the |-b| Vim argument. When this option is switched on a few
1295 options will be changed (also when it already was on):
1296 'textwidth' will be set to 0
1297 'wrapmargin' will be set to 0
1298 'modeline' will be off
1299 'expandtab' will be off
1300 Also, 'fileformat' and 'fileformats' options will not be used, the
1301 file is read and written like 'fileformat' was "unix" (a single <NL>
1302 separates lines).
1303 The 'fileencoding' and 'fileencodings' options will not be used, the
1304 file is read without conversion.
1305 NOTE: When you start editing a(nother) file while the 'bin' option is
1306 on, settings from autocommands may change the settings again (e.g.,
1307 'textwidth'), causing trouble when editing. You might want to set
1308 'bin' again when the file has been loaded.
1309 The previous values of these options are remembered and restored when
1310 'bin' is switched from on to off. Each buffer has its own set of
1311 saved option values.
1312 To edit a file with 'binary' set you can use the |++bin| argument.
1313 This avoids you have to do ":set bin", which would have effect for all
1314 files you edit.
1315 When writing a file the <EOL> for the last line is only written if
1316 there was one in the original file (normally Vim appends an <EOL> to
1317 the last line if there is none; this would make the file longer). See
1318 the 'endofline' option.
1319
1320 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1321'bioskey' 'biosk' boolean (default on)
1322 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001323 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001324 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325
1326 *'bomb'* *'nobomb'*
1327'bomb' boolean (default off)
1328 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 When writing a file and the following conditions are met, a BOM (Byte
1330 Order Mark) is prepended to the file:
1331 - this option is on
1332 - the 'binary' option is off
1333 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1334 endian variants.
1335 Some applications use the BOM to recognize the encoding of the file.
1336 Often used for UCS-2 files on MS-Windows. For other applications it
1337 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001338 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1340 check for the presence of the BOM is done and 'bomb' set accordingly.
1341 Unless 'binary' is set, it is removed from the first line, so that you
1342 don't see it when editing. When you don't change the options, the BOM
1343 will be restored when writing the file.
1344
1345 *'breakat'* *'brk'*
1346'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1347 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001348 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349 feature}
1350 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001351 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1352 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001354 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001355'breakindent' 'bri' boolean (default off)
1356 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001357 {not available when compiled without the |+linebreak|
1358 feature}
1359 Every wrapped line will continue visually indented (same amount of
1360 space as the beginning of that line), thus preserving horizontal blocks
1361 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001362 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001363
1364 *'breakindentopt'* *'briopt'*
1365'breakindentopt' 'briopt' string (default empty)
1366 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001367 {not available when compiled without the |+linebreak|
1368 feature}
1369 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001370 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001371 min:{n} Minimum text width that will be kept after
1372 applying 'breakindent', even if the resulting
1373 text should normally be narrower. This prevents
1374 text indented almost to the right window border
1375 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001376 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001377 shift:{n} After applying 'breakindent', the wrapped line's
1378 beginning will be shifted by the given number of
1379 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001380 indentation (negative) or emphasizing the line
1381 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001382 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001383 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001384 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001385 numbered or bulleted list (using the
1386 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001387 list:-1 Uses the length of a match with 'formatlistpat'
1388 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001389 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001390
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001392'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001394 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001396 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001397 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 buffer Use the directory of the related buffer.
1399 current Use the current directory.
1400 {path} Use the specified directory
1401
1402 *'bufhidden'* *'bh'*
1403'bufhidden' 'bh' string (default: "")
1404 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 This option specifies what happens when a buffer is no longer
1406 displayed in a window:
1407 <empty> follow the global 'hidden' option
1408 hide hide the buffer (don't unload it), also when 'hidden'
1409 is not set
1410 unload unload the buffer, also when 'hidden' is set or using
1411 |:hide|
1412 delete delete the buffer from the buffer list, also when
1413 'hidden' is set or using |:hide|, like using
1414 |:bdelete|
1415 wipe wipe out the buffer from the buffer list, also when
1416 'hidden' is set or using |:hide|, like using
1417 |:bwipeout|
1418
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001419 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001420 are lost without a warning. Also, these values may break autocommands
1421 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422 This option is used together with 'buftype' and 'swapfile' to specify
1423 special kinds of buffers. See |special-buffers|.
1424
1425 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1426'buflisted' 'bl' boolean (default: on)
1427 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 When this option is set, the buffer shows up in the buffer list. If
1429 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1430 This option is reset by Vim for buffers that are only used to remember
1431 a file name or marks. Vim sets it when starting to edit a buffer.
1432 But not when moving to a buffer with ":buffer".
1433
1434 *'buftype'* *'bt'* *E382*
1435'buftype' 'bt' string (default: "")
1436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 The value of this option specifies the type of a buffer:
1438 <empty> normal buffer
1439 nofile buffer which is not related to a file and will not be
1440 written
1441 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001442 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001443 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001445 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 help help buffer (you are not supposed to set this
1447 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001448 terminal buffer for a |terminal| (you are not supposed to set
1449 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001450 prompt buffer where only the last line can be edited, meant
1451 to be used by a plugin, see |prompt-buffer|
1452 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001453 popup buffer used in a popup window, see |popup|.
1454 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455
1456 This option is used together with 'bufhidden' and 'swapfile' to
1457 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001458 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459
1460 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001461 One such effect is that Vim will not check the timestamp of the file,
1462 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463
Bram Moolenaar280f1262006-01-30 00:14:18 +00001464 A "quickfix" buffer is only used for the error list and the location
1465 list. This value is set by the |:cwindow| and |:lwindow| commands and
1466 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467
1468 "nofile" and "nowrite" buffers are similar:
1469 both: The buffer is not to be written to disk, ":w" doesn't
1470 work (":w filename" does work though).
1471 both: The buffer is never considered to be |'modified'|.
1472 There is no warning when the changes will be lost, for
1473 example when you quit Vim.
1474 both: A swap file is only created when using too much memory
1475 (when 'swapfile' has been reset there is never a swap
1476 file).
1477 nofile only: The buffer name is fixed, it is not handled like a
1478 file name. It is not modified in response to a |:cd|
1479 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001480 both: When using ":e bufname" and already editing "bufname"
1481 the buffer is made empty and autocommands are
1482 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001483 *E676*
1484 "acwrite" implies that the buffer name is not related to a file, like
1485 "nofile", but it will be written. Thus, in contrast to "nofile" and
1486 "nowrite", ":w" does work and a modified buffer can't be abandoned
1487 without saving. For writing there must be matching |BufWriteCmd|,
1488 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489
1490 *'casemap'* *'cmp'*
1491'casemap' 'cmp' string (default: "internal,keepascii")
1492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493 Specifies details about changing the case of letters. It may contain
1494 these words, separated by a comma:
1495 internal Use internal case mapping functions, the current
1496 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001497 matters when 'encoding' is a Unicode encoding,
1498 "latin1" or "iso-8859-15". When "internal" is
1499 omitted, the towupper() and towlower() system library
1500 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1502 case mapping, the current locale is not effective.
1503 This probably only matters for Turkish.
1504
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001505 *'cdhome'* *'cdh'*
1506'cdhome' 'cdh' boolean (default: off)
1507 global
1508 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1509 current working directory to the |$HOME| directory like in Unix.
1510 When off, those commands just print the current directory name.
1511 On Unix this option has no effect.
1512 NOTE: This option is reset when 'compatible' is set.
1513
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514 *'cdpath'* *'cd'* *E344* *E346*
1515'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 {not available when compiled without the
1518 |+file_in_path| feature}
1519 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001520 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1521 searched for has a relative path, not an absolute part starting with
1522 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001523 The 'cdpath' option's value has the same form and semantics as
1524 |'path'|. Also see |file-searching|.
1525 The default value is taken from $CDPATH, with a "," prepended to look
1526 in the current directory first.
1527 If the default value taken from $CDPATH is not what you want, include
1528 a modified version of the following command in your vimrc file to
1529 override it: >
1530 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1531< This option cannot be set from a |modeline| or in the |sandbox|, for
1532 security reasons.
1533 (parts of 'cdpath' can be passed to the shell to expand file names).
1534
1535 *'cedit'*
1536'cedit' string (Vi default: "", Vim default: CTRL-F)
1537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 The key used in Command-line Mode to open the command-line window.
1539 The default is CTRL-F when 'compatible' is off.
1540 Only non-printable keys are allowed.
1541 The key can be specified as a single character, but it is difficult to
1542 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001543 :exe "set cedit=\<C-Y>"
1544 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545< |Nvi| also has this option, but it only uses the first character.
1546 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001547 NOTE: This option is set to the Vim default value when 'compatible'
1548 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549
1550 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1551'charconvert' 'ccv' string (default "")
1552 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001553 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 An expression that is used for character encoding conversion. It is
1555 evaluated when a file that is to be read or has been written has a
1556 different encoding from what is desired.
1557 'charconvert' is not used when the internal iconv() function is
1558 supported and is able to do the conversion. Using iconv() is
1559 preferred, because it is much faster.
1560 'charconvert' is not used when reading stdin |--|, because there is no
1561 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001562 The expression must return zero, false or an empty string for success,
1563 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 The possible encoding names encountered are in 'encoding'.
1565 Additionally, names given in 'fileencodings' and 'fileencoding' are
1566 used.
1567 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1568 is done internally by Vim, 'charconvert' is not used for this.
1569 'charconvert' is also used to convert the viminfo file, if the 'c'
1570 flag is present in 'viminfo'. Also used for Unicode conversion.
1571 Example: >
1572 set charconvert=CharConvert()
1573 fun CharConvert()
1574 system("recode "
1575 \ . v:charconvert_from . ".." . v:charconvert_to
1576 \ . " <" . v:fname_in . " >" v:fname_out)
1577 return v:shell_error
1578 endfun
1579< The related Vim variables are:
1580 v:charconvert_from name of the current encoding
1581 v:charconvert_to name of the desired encoding
1582 v:fname_in name of the input file
1583 v:fname_out name of the output file
1584 Note that v:fname_in and v:fname_out will never be the same.
1585 Note that v:charconvert_from and v:charconvert_to may be different
1586 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001587
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 Encryption is not done by Vim when using 'charconvert'. If you want
1589 to encrypt the file after conversion, 'charconvert' should take care
1590 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001591
1592 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1593 replaced with the script ID (|local-function|). Example: >
1594 set charconvert=s:MyConvert()
1595 set charconvert=<SID>SomeConvert()
1596< Otherwise the expression is evaluated in the context of the script
1597 where the option was set, thus script-local items are available.
1598
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 This option cannot be set from a |modeline| or in the |sandbox|, for
1600 security reasons.
1601
1602 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1603'cindent' 'cin' boolean (default off)
1604 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 {not available when compiled without the |+cindent|
1606 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001607 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 that trigger reindenting in insert mode and 'cinoptions' to set your
1609 preferred indent style.
1610 If 'indentexpr' is not empty, it overrules 'cindent'.
1611 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1612 the "=" operator indents using this algorithm rather than calling an
1613 external program.
1614 See |C-indenting|.
1615 When you don't like the way 'cindent' works, try the 'smartindent'
1616 option or 'indentexpr'.
1617 This option is not used when 'paste' is set.
1618 NOTE: This option is reset when 'compatible' is set.
1619
1620 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001621'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623 {not available when compiled without the |+cindent|
1624 feature}
1625 A list of keys that, when typed in Insert mode, cause reindenting of
1626 the current line. Only used if 'cindent' is on and 'indentexpr' is
1627 empty.
1628 For the format of this option see |cinkeys-format|.
1629 See |C-indenting|.
1630
1631 *'cinoptions'* *'cino'*
1632'cinoptions' 'cino' string (default "")
1633 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 {not available when compiled without the |+cindent|
1635 feature}
1636 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1637 program. See |cinoptions-values| for the values of this option, and
1638 |C-indenting| for info on C indenting in general.
1639
1640
1641 *'cinwords'* *'cinw'*
1642'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1643 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 {not available when compiled without both the
1645 |+cindent| and the |+smartindent| features}
1646 These keywords start an extra indent in the next line when
1647 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1648 an appropriate place (inside {}).
1649 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1650 matter, include the keyword both the uppercase and lowercase:
1651 "if,If,IF".
1652
1653 *'clipboard'* *'cb'*
1654'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1655 for X-windows, "" otherwise)
1656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 {only in GUI versions or when the |+xterm_clipboard|
1658 feature is included}
1659 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001660 Note: if one of the items is "exclude:", then you can't add an item
1661 after that. Therefore do append an item with += but use ^= to
1662 prepend, e.g.: >
1663 set clipboard^=unnamed
1664< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001666 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 unnamed When included, Vim will use the clipboard register '*'
1668 for all yank, delete, change and put operations which
1669 would normally go to the unnamed register. When a
1670 register is explicitly specified, it will always be
1671 used regardless of whether "unnamed" is in 'clipboard'
1672 or not. The clipboard register can always be
1673 explicitly accessed using the "* notation. Also see
1674 |gui-clipboard|.
1675
Bram Moolenaar30b65812012-07-12 22:01:11 +02001676 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001677 unnamedplus A variant of the "unnamed" flag which uses the
1678 clipboard register '+' (|quoteplus|) instead of
1679 register '*' for all yank, delete, change and put
1680 operations which would normally go to the unnamed
1681 register. When "unnamed" is also included to the
1682 option, yank operations (but not delete, change or
1683 put) will additionally copy the text into register
1684 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001685 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001686 Availability can be checked with: >
1687 if has('unnamedplus')
1688<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001689 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690 autoselect Works like the 'a' flag in 'guioptions': If present,
1691 then whenever Visual mode is started, or the Visual
1692 area extended, Vim tries to become the owner of the
1693 windowing system's global selection or put the
1694 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001695 register "*. See |'go-a'| and |quotestar| for details.
1696 When the GUI is active, the 'a' flag in 'guioptions'
1697 is used, when the GUI is not active, this "autoselect"
1698 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 Also applies to the modeless selection.
1700
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001701 *clipboard-autoselectplus*
1702 autoselectplus Like "autoselect" but using the + register instead of
1703 the * register. Compare to the 'P' flag in
1704 'guioptions'.
1705
1706 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 autoselectml Like "autoselect", but for the modeless selection
1708 only. Compare to the 'A' flag in 'guioptions'.
1709
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001710 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001711 html When the clipboard contains HTML, use this when
1712 pasting. When putting text on the clipboard, mark it
1713 as HTML. This works to copy rendered HTML from
1714 Firefox, paste it as raw HTML in Vim, select the HTML
1715 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001716 You probably want to add this only temporarily,
1717 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001718 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001719
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001720 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 exclude:{pattern}
1722 Defines a pattern that is matched against the name of
1723 the terminal 'term'. If there is a match, no
1724 connection will be made to the X server. This is
1725 useful in this situation:
1726 - Running Vim in a console.
1727 - $DISPLAY is set to start applications on another
1728 display.
1729 - You do not want to connect to the X server in the
1730 console, but do want this in a terminal emulator.
1731 To never connect to the X server use: >
1732 exclude:.*
1733< This has the same effect as using the |-X| argument.
1734 Note that when there is no connection to the X server
1735 the window title won't be restored and the clipboard
1736 cannot be accessed.
1737 The value of 'magic' is ignored, {pattern} is
1738 interpreted as if 'magic' was on.
1739 The rest of the option value will be used for
1740 {pattern}, this must be the last entry.
1741
1742 *'cmdheight'* *'ch'*
1743'cmdheight' 'ch' number (default 1)
1744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 Number of screen lines to use for the command-line. Helps avoiding
1746 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001747 The value of this option is stored with the tab page, so that each tab
1748 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749
1750 *'cmdwinheight'* *'cwh'*
1751'cmdwinheight' 'cwh' number (default 7)
1752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 Number of screen lines to use for the command-line window. |cmdwin|
1754
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001755 *'colorcolumn'* *'cc'*
1756'colorcolumn' 'cc' string (default "")
1757 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001758 {not available when compiled without the |+syntax|
1759 feature}
1760 'colorcolumn' is a comma separated list of screen columns that are
1761 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1762 text. Will make screen redrawing slower.
1763 The screen column can be an absolute number, or a number preceded with
1764 '+' or '-', which is added to or subtracted from 'textwidth'. >
1765
1766 :set cc=+1 " highlight column after 'textwidth'
1767 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1768 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1769<
1770 When 'textwidth' is zero then the items with '-' and '+' are not used.
1771 A maximum of 256 columns are highlighted.
1772
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 *'columns'* *'co'* *E594*
1774'columns' 'co' number (default 80 or terminal width)
1775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001777 initialization and does not have to be set by hand. Also see
1778 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 When Vim is running in the GUI or in a resizable window, setting this
1780 option will cause the window size to be changed. When you only want
1781 to use the size for the GUI, put the command in your |gvimrc| file.
1782 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001783 number of columns of the display, the display may be messed up. For
1784 the GUI it is always possible and Vim limits the number of columns to
1785 what fits on the screen. You can use this command to get the widest
1786 window possible: >
1787 :set columns=9999
1788< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789
1790 *'comments'* *'com'* *E524* *E525*
1791'comments' 'com' string (default
1792 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1793 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 A comma separated list of strings that can start a comment line. See
1795 |format-comments|. See |option-backslash| about using backslashes to
1796 insert a space.
1797
1798 *'commentstring'* *'cms'* *E537*
1799'commentstring' 'cms' string (default "/*%s*/")
1800 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 {not available when compiled without the |+folding|
1802 feature}
1803 A template for a comment. The "%s" in the value is replaced with the
1804 comment text. Currently only used to add markers for folding, see
1805 |fold-marker|.
1806
1807 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001808'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001809 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 This option has the effect of making Vim either more Vi-compatible, or
1812 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001813
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001815 other options are also changed as a side effect.
1816 NOTE: Setting or resetting this option can have a lot of unexpected
1817 effects: Mappings are interpreted in another way, undo behaves
1818 differently, etc. If you set this option in your vimrc file, you
1819 should probably put it at the very start.
1820
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 By default this option is on and the Vi defaults are used for the
1822 options. This default was chosen for those people who want to use Vim
1823 just like Vi, and don't even (want to) know about the 'compatible'
1824 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001825 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001826 this option is switched off, and all options that have not been
1827 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001828 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001829 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001830 happen for the system-wide vimrc or gvimrc file, nor for a file given
1831 with the |-u| argument). Also see |compatible-default| and
1832 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 You can also set this option with the "-C" argument, and reset it with
1834 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001835 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836
Bram Moolenaar214641f2017-03-05 17:04:09 +01001837 When this option is set, numerous other options are set to make Vim as
1838 Vi-compatible as possible. When this option is unset, various options
1839 are set to make Vim more useful. The table below lists all the
1840 options affected.
1841 The {?} column indicates when the options are affected:
1842 + Means that the option is set to the value given in {set value} when
1843 'compatible' is set.
1844 & Means that the option is set to the value given in {set value} when
1845 'compatible' is set AND is set to its Vim default value when
1846 'compatible' is unset.
1847 - Means the option is NOT changed when setting 'compatible' but IS
1848 set to its Vim default when 'compatible' is unset.
1849 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850
Bram Moolenaar036986f2017-03-16 17:41:02 +01001851 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001852
1853 'allowrevins' + off no CTRL-_ command
1854 'antialias' + off don't use antialiased fonts
1855 'arabic' + off reset arabic-related options
1856 'arabicshape' + on correct character shapes
1857 'backspace' + "" normal backspace
1858 'backup' + off no backup file
1859 'backupcopy' & Unix: "yes" backup file is a copy
1860 else: "auto" copy or rename backup file
1861 'balloonexpr' + "" text to show in evaluation balloon
1862 'breakindent' + off don't indent when wrapping lines
1863 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001864 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001865 'cindent' + off no C code indentation
1866 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1867 'copyindent' + off don't copy indent structure
1868 'cpoptions' & (all flags) Vi-compatible flags
1869 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001870 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001871 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001872 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001873 'cscopeverbose' + off see |cscopeverbose|
1874 'delcombine' + off unicode: delete whole char combination
1875 'digraph' + off no digraphs
1876 'esckeys' & off no <Esc>-keys in Insert mode
1877 'expandtab' + off tabs not expanded to spaces
1878 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001879 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001880 'formatexpr' + "" use 'formatprg' for auto-formatting
1881 'formatoptions' & "vt" Vi compatible formatting
1882 'gdefault' + off no default 'g' flag for ":s"
1883 'history' & 0 no commandline history
1884 'hkmap' + off no Hebrew keyboard mapping
1885 'hkmapp' + off no phonetic Hebrew keyboard mapping
1886 'hlsearch' + off no highlighting of search matches
1887 'incsearch' + off no incremental searching
1888 'indentexpr' + "" no indenting by expression
1889 'insertmode' + off do not start in Insert mode
1890 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001892 'joinspaces' + on insert 2 spaces after period
1893 'modeline' & off no modelines
1894 'more' & off no pauses in listings
1895 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1896 'numberwidth' & 8 min number of columns for line number
1897 'preserveindent'+ off don't preserve current indent structure
1898 when changing it
1899 'revins' + off no reverse insert
1900 'ruler' + off no ruler
1901 'scrolljump' + 1 no jump scroll
1902 'scrolloff' + 0 no scroll offset
1903 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1904 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001905 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001906 'showcmd' & off command characters not shown
1907 'showmode' & off current mode not shown
1908 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1909 'smartcase' + off no automatic ignore case switch
1910 'smartindent' + off no smart indentation
1911 'smarttab' + off no smart tab size
1912 'softtabstop' + 0 tabs are always 'tabstop' positions
1913 'startofline' + on goto startofline with some commands
1914 'tagcase' & "followic" 'ignorecase' when searching tags file
1915 'tagrelative' & off tag file names are not relative
1916 'termguicolors' + off don't use highlight-(guifg|guibg)
1917 'textauto' & off no automatic textmode detection
1918 'textwidth' + 0 no automatic line wrap
1919 'tildeop' + off tilde is not an operator
1920 'ttimeout' + off no terminal timeout
1921 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001922 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001923 'virtualedit' + "" cursor can only be placed on characters
1924 'whichwrap' & "" left-right movements don't wrap
1925 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001927 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928
1929 *'complete'* *'cpt'* *E535*
1930'complete' 'cpt' string (default: ".,w,b,u,t,i")
1931 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 This option specifies how keyword completion |ins-completion| works
1933 when CTRL-P or CTRL-N are used. It is also used for whole-line
1934 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1935 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001936 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 w scan buffers from other windows
1938 b scan other loaded buffers that are in the buffer list
1939 u scan the unloaded buffers that are in the buffer list
1940 U scan the buffers that are not in the buffer list
1941 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001942 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 k{dict} scan the file {dict}. Several "k" flags can be given,
1944 patterns are valid too. For example: >
1945 :set cpt=k/usr/dict/*,k~/spanish
1946< s scan the files given with the 'thesaurus' option
1947 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1948 are valid too.
1949 i scan current and included files
1950 d scan current and included files for defined name or macro
1951 |i_CTRL-X_CTRL-D|
1952 ] tag completion
1953 t same as "]"
1954
1955 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1956 not executed, this may lead to unexpected completions from some files
1957 (gzipped files for example). Unloaded buffers are not scanned for
1958 whole-line completion.
1959
1960 The default is ".,w,b,u,t,i", which means to scan:
1961 1. the current buffer
1962 2. buffers in other windows
1963 3. other loaded buffers
1964 4. unloaded buffers
1965 5. tags
1966 6. included files
1967
1968 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001969 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1970 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001972 *'completefunc'* *'cfu'*
1973'completefunc' 'cfu' string (default: empty)
1974 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001975 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001976 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001977 This option specifies a function to be used for Insert mode completion
1978 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001979 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001980 invoked and what it should return. The value can be the name of a
1981 function, a |lambda| or a |Funcref|. See |option-value-function| for
1982 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001983 This option cannot be set from a |modeline| or in the |sandbox|, for
1984 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001985
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001986 *'completeslash'* *'csl'*
1987'completeslash' 'csl' string (default: "")
1988 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001989 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001990 When this option is set it overrules 'shellslash' for completion:
1991 - When this option is set to "slash", a forward slash is used for path
1992 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001993 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001994 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001995 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001996 - When this option is empty, same character is used as for
1997 'shellslash'.
1998 For Insert mode completion the buffer-local value is used. For
1999 command line completion the global value is used.
2000
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002001 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002002'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002003 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002004 A comma separated list of options for Insert mode completion
2005 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002006
2007 menu Use a popup menu to show the possible completions. The
2008 menu is only shown when there is more than one match and
2009 sufficient colors are available. |ins-completion-menu|
2010
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002011 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002012 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002013 match, e.g., what file it comes from.
2014
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002015 longest Only insert the longest common text of the matches. If
2016 the menu is displayed you can use CTRL-L to add more
2017 characters. Whether case is ignored depends on the kind
2018 of completion. For buffer text the 'ignorecase' option is
2019 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002020
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002021 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002022 completion in the preview window. Only works in
2023 combination with "menu" or "menuone".
2024
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002025 popup Show extra information about the currently selected
2026 completion in a popup window. Only works in combination
2027 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002028 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002029 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002030
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002031 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002032 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002033 |CompleteChanged| autocommand to fetch the info and call
2034 |popup_show()| once the popup has been filled.
2035 See the example at |complete-popuphidden|.
2036 {only works when compiled with the |+textprop| feature}
2037
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002038 noinsert Do not insert any text for a match until the user selects
2039 a match from the menu. Only works in combination with
2040 "menu" or "menuone". No effect if "longest" is present.
2041
2042 noselect Do not select a match in the menu, force the user to
2043 select one from the menu. Only works in combination with
2044 "menu" or "menuone".
2045
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002046
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002047 *'completepopup'* *'cpp'*
2048'completepopup' 'cpp' string (default empty)
2049 global
2050 {not available when compiled without the |+textprop|
2051 or |+quickfix| feature}
2052 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002053 properties of the info popup when it is created. If an info popup
2054 window already exists it is closed, so that the option value is
2055 applied when it is created again.
2056 You can also use |popup_findinfo()| and then set properties for an
2057 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002058
2059
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002060 *'concealcursor'* *'cocu'*
2061'concealcursor' 'cocu' string (default: "")
2062 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002063 {not available when compiled without the |+conceal|
2064 feature}
2065 Sets the modes in which text in the cursor line can also be concealed.
2066 When the current mode is listed then concealing happens just like in
2067 other lines.
2068 n Normal mode
2069 v Visual mode
2070 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002071 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002072
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002073 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002074 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002075 are moving around text is concealed, but when starting to insert text
2076 or selecting a Visual area the concealed text is displayed, so that
2077 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002078 Keep in mind that the cursor position is not always where it's
2079 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002080
2081
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002082 *'conceallevel'* *'cole'*
2083'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002084 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002085 {not available when compiled without the |+conceal|
2086 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002087 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2088 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002089
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002090 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002091 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002092 1 Each block of concealed text is replaced with one
2093 character. If the syntax item does not have a custom
2094 replacement character defined (see |:syn-cchar|) the
2095 character defined in 'listchars' is used (default is a
2096 space).
2097 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002098 2 Concealed text is completely hidden unless it has a
2099 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002100 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002101 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002102
Bram Moolenaara7781e02010-07-19 20:13:22 +02002103 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002104 edit and copy the text. This can be changed with the 'concealcursor'
2105 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002106
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2108'confirm' 'cf' boolean (default off)
2109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 When 'confirm' is on, certain operations that would normally
2111 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2112 instead raise a |dialog| asking if you wish to save the current
2113 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2114 If 'confirm' is off you can still activate confirmation for one
2115 command only (this is most useful in mappings) with the |:confirm|
2116 command.
2117 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2118
2119 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2120'conskey' 'consk' boolean (default off)
2121 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002122 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123
2124 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2125'copyindent' 'ci' boolean (default off)
2126 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 Copy the structure of the existing lines indent when autoindenting a
2128 new line. Normally the new indent is reconstructed by a series of
2129 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2130 in which case only spaces are used). Enabling this option makes the
2131 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002132 existing line. 'expandtab' has no effect on these characters, a Tab
2133 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002135 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 Also see 'preserveindent'.
2137
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002138 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139'cpoptions' 'cpo' string (Vim default: "aABceFs",
2140 Vi default: all flags)
2141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002143 this indicates Vi-compatible behavior. This is used for things where
2144 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 'cpoptions' stands for "compatible-options".
2146 Commas can be added for readability.
2147 To avoid problems with flags that are added in the future, use the
2148 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002149
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 NOTE: This option is set to the Vi default value when 'compatible' is
2151 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002152
2153 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2154 is saved, 'cpoptions' is set to the Vim default, and the saved value
2155 is restored at the end of the script. Changes to the value of
2156 'cpoptions' will be applied to the saved value, but keep in mind that
2157 removing a flag that is not present when 'cpoptions' is changed has no
2158 effect. In the |.vimrc| file the value is not restored, thus using
2159 `vim9script` in the |.vimrc| file results in using the Vim default.
2160
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002161 NOTE: This option is set to the POSIX default value at startup when
2162 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002163 variable exists |posix|. This means Vim tries to behave like the
2164 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165
2166 contains behavior ~
2167 *cpo-a*
2168 a When included, a ":read" command with a file name
2169 argument will set the alternate file name for the
2170 current window.
2171 *cpo-A*
2172 A When included, a ":write" command with a file name
2173 argument will set the alternate file name for the
2174 current window.
2175 *cpo-b*
2176 b "\|" in a ":map" command is recognized as the end of
2177 the map command. The '\' is included in the mapping,
2178 the text after the '|' is interpreted as the next
2179 command. Use a CTRL-V instead of a backslash to
2180 include the '|' in the mapping. Applies to all
2181 mapping, abbreviation, menu and autocmd commands.
2182 See also |map_bar|.
2183 *cpo-B*
2184 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002185 abbreviations, user commands and the "to" part of the
2186 menu commands. Remove this flag to be able to use a
2187 backslash like a CTRL-V. For example, the command
2188 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 'B' included: "\^[" (^[ is a real <Esc>)
2190 'B' excluded: "<Esc>" (5 characters)
2191 ('<' excluded in both cases)
2192 *cpo-c*
2193 c Searching continues at the end of any match at the
2194 cursor position, but not further than the start of the
2195 next line. When not present searching continues
2196 one character from the cursor position. With 'c'
2197 "abababababab" only gets three matches when repeating
2198 "/abab", without 'c' there are five matches.
2199 *cpo-C*
2200 C Do not concatenate sourced lines that start with a
2201 backslash. See |line-continuation|.
2202 *cpo-d*
2203 d Using "./" in the 'tags' option doesn't mean to use
2204 the tags file relative to the current file, but the
2205 tags file in the current directory.
2206 *cpo-D*
2207 D Can't use CTRL-K to enter a digraph after Normal mode
2208 commands with a character argument, like |r|, |f| and
2209 |t|.
2210 *cpo-e*
2211 e When executing a register with ":@r", always add a
2212 <CR> to the last line, also when the register is not
2213 linewise. If this flag is not present, the register
2214 is not linewise and the last line does not end in a
2215 <CR>, then the last line is put on the command-line
2216 and can be edited before hitting <CR>.
2217 *cpo-E*
2218 E It is an error when using "y", "d", "c", "g~", "gu" or
2219 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002220 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 This makes "y0" fail in the first column.
2222 *cpo-f*
2223 f When included, a ":read" command with a file name
2224 argument will set the file name for the current buffer,
2225 if the current buffer doesn't have a file name yet.
2226 *cpo-F*
2227 F When included, a ":write" command with a file name
2228 argument will set the file name for the current
2229 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002230 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 *cpo-g*
2232 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002233 *cpo-H*
2234 H When using "I" on a line with only blanks, insert
2235 before the last blank. Without this flag insert after
2236 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 *cpo-i*
2238 i When included, interrupting the reading of a file will
2239 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002240 *cpo-I*
2241 I When moving the cursor up or down just after inserting
2242 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 *cpo-j*
2244 j When joining lines, only add two spaces after a '.',
2245 not after '!' or '?'. Also see 'joinspaces'.
2246 *cpo-J*
2247 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002248 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 white space.
2250 *cpo-k*
2251 k Disable the recognition of raw key codes in
2252 mappings, abbreviations, and the "to" part of menu
2253 commands. For example, if <Key> sends ^[OA (where ^[
2254 is <Esc>), the command ":map X ^[OA" results in X
2255 being mapped to:
2256 'k' included: "^[OA" (3 characters)
2257 'k' excluded: "<Key>" (one key code)
2258 Also see the '<' flag below.
2259 *cpo-K*
2260 K Don't wait for a key code to complete when it is
2261 halfway a mapping. This breaks mapping <F1><F1> when
2262 only part of the second <F1> has been read. It
2263 enables cancelling the mapping by typing <F1><Esc>.
2264 *cpo-l*
2265 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002266 literally, only "\]", "\^", "\-" and "\\" are special.
2267 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2269 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002270 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 *cpo-L*
2272 L When the 'list' option is set, 'wrapmargin',
2273 'textwidth', 'softtabstop' and Virtual Replace mode
2274 (see |gR|) count a <Tab> as two characters, instead of
2275 the normal behavior of a <Tab>.
2276 *cpo-m*
2277 m When included, a showmatch will always wait half a
2278 second. When not included, a showmatch will wait half
2279 a second or until a character is typed. |'showmatch'|
2280 *cpo-M*
2281 M When excluded, "%" matching will take backslashes into
2282 account. Thus in "( \( )" and "\( ( \)" the outer
2283 parenthesis match. When included "%" ignores
2284 backslashes, which is Vi compatible.
2285 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002286 n When included, the column used for 'number' and
2287 'relativenumber' will also be used for text of wrapped
2288 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 *cpo-o*
2290 o Line offset to search command is not remembered for
2291 next search.
2292 *cpo-O*
2293 O Don't complain if a file is being overwritten, even
2294 when it didn't exist when editing it. This is a
2295 protection against a file unexpectedly created by
2296 someone else. Vi didn't complain about this.
2297 *cpo-p*
2298 p Vi compatible Lisp indenting. When not present, a
2299 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002300 *cpo-P*
2301 P When included, a ":write" command that appends to a
2302 file will set the file name for the current buffer, if
2303 the current buffer doesn't have a file name yet and
2304 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002305 *cpo-q*
2306 q When joining multiple lines leave the cursor at the
2307 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308 *cpo-r*
2309 r Redo ("." command) uses "/" to repeat a search
2310 command, instead of the actually used search string.
2311 *cpo-R*
2312 R Remove marks from filtered lines. Without this flag
2313 marks are kept like |:keepmarks| was used.
2314 *cpo-s*
2315 s Set buffer options when entering the buffer for the
2316 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002317 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 set when the buffer is created.
2319 *cpo-S*
2320 S Set buffer options always when entering a buffer
2321 (except 'readonly', 'fileformat', 'filetype' and
2322 'syntax'). This is the (most) Vi compatible setting.
2323 The options are set to the values in the current
2324 buffer. When you change an option and go to another
2325 buffer, the value is copied. Effectively makes the
2326 buffer options global to all buffers.
2327
2328 's' 'S' copy buffer options
2329 no no when buffer created
2330 yes no when buffer first entered (default)
2331 X yes each time when buffer entered (vi comp.)
2332 *cpo-t*
2333 t Search pattern for the tag command is remembered for
2334 "n" command. Otherwise Vim only puts the pattern in
2335 the history for search pattern, but doesn't change the
2336 last used search pattern.
2337 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002338 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 *cpo-v*
2340 v Backspaced characters remain visible on the screen in
2341 Insert mode. Without this flag the characters are
2342 erased from the screen right away. With this flag the
2343 screen newly typed text overwrites backspaced
2344 characters.
2345 *cpo-w*
2346 w When using "cw" on a blank character, only change one
2347 character and not all blanks until the start of the
2348 next word.
2349 *cpo-W*
2350 W Don't overwrite a readonly file. When omitted, ":w!"
2351 overwrites a readonly file, if possible.
2352 *cpo-x*
2353 x <Esc> on the command-line executes the command-line.
2354 The default in Vim is to abandon the command-line,
2355 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002356 *cpo-X*
2357 X When using a count with "R" the replaced text is
2358 deleted only once. Also when repeating "R" with "."
2359 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002361 y A yank command can be redone with ".". Think twice if
2362 you really want to use this, it may break some
2363 plugins, since most people expect "." to only repeat a
2364 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002365 *cpo-Z*
2366 Z When using "w!" while the 'readonly' option is set,
2367 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 *cpo-!*
2369 ! When redoing a filter command, use the last used
2370 external command, whatever it was. Otherwise the last
2371 used -filter- command is used.
2372 *cpo-$*
2373 $ When making a change to one line, don't redisplay the
2374 line, but put a '$' at the end of the changed text.
2375 The changed text will be overwritten when you type the
2376 new text. The line is redisplayed if you type any
2377 command that moves the cursor from the insertion
2378 point.
2379 *cpo-%*
2380 % Vi-compatible matching is done for the "%" command.
2381 Does not recognize "#if", "#endif", etc.
2382 Does not recognize "/*" and "*/".
2383 Parens inside single and double quotes are also
2384 counted, causing a string that contains a paren to
2385 disturb the matching. For example, in a line like
2386 "if (strcmp("foo(", s))" the first paren does not
2387 match the last one. When this flag is not included,
2388 parens inside single and double quotes are treated
2389 specially. When matching a paren outside of quotes,
2390 everything inside quotes is ignored. When matching a
2391 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002392 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002393 This flag is also used for other features, such as
2394 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002395 *cpo--*
2396 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002397 it would go above the first line or below the last
2398 line. Without it the cursor moves to the first or
2399 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002400 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002401 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002402 *cpo-+*
2403 + When included, a ":write file" command will reset the
2404 'modified' flag of the buffer, even though the buffer
2405 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002406 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 * Use ":*" in the same way as ":@". When not included,
2408 ":*" is an alias for ":'<,'>", select the Visual area.
2409 *cpo-<*
2410 < Disable the recognition of special key codes in |<>|
2411 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002412 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 ":map X <Tab>" results in X being mapped to:
2414 '<' included: "<Tab>" (5 characters)
2415 '<' excluded: "^I" (^I is a real <Tab>)
2416 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002417 *cpo->*
2418 > When appending to a register, put a line break before
2419 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002420 *cpo-;*
2421 ; When using |,| or |;| to repeat the last |t| search
2422 and the cursor is right in front of the searched
2423 character, the cursor won't move. When not included,
2424 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002425 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002426
2427 POSIX flags. These are not included in the Vi default value, except
2428 when $VIM_POSIX was set on startup. |posix|
2429
2430 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002431 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002432 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002433 *cpo-&*
2434 & When ":preserve" was used keep the swap file when
2435 exiting normally while this buffer is still loaded.
2436 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002437 *cpo-\*
2438 \ Backslash in a [] range in a search pattern is taken
2439 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002440 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2441 '\' excluded: "/[ \-]" finds <Space> and '-'
2442 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002443 *cpo-/*
2444 / When "%" is used as the replacement string in a |:s|
2445 command, use the previous replacement string. |:s%|
2446 *cpo-{*
2447 { The |{| and |}| commands also stop at a "{" character
2448 at the start of a line.
2449 *cpo-.*
2450 . The ":chdir" and ":cd" commands fail if the current
2451 buffer is modified, unless ! is used. Vim doesn't
2452 need this, since it remembers the full path of an
2453 opened file.
2454 *cpo-bar*
2455 | The value of the $LINES and $COLUMNS environment
2456 variables overrule the terminal size values obtained
2457 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002458
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002460 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002461'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002462 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002463 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002464 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002465 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002466 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002467 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002468 blowfish Blowfish method. Medium strong encryption but it has
2469 an implementation flaw. Requires Vim 7.3 or later,
2470 files can NOT be read by Vim 7.2 and older. This adds
2471 a "seed" to the file, every time you write the file
2472 the encrypted bytes will be different.
2473 *blowfish2*
2474 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002475 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002476 and older. This adds a "seed" to the file, every time
2477 you write the file the encrypted bytes will be
2478 different. The whole undo file is encrypted, not just
2479 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002480 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002481 *E1197* *E1198* *E1199* *E1200* *E1201*
2482 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2483 Code. Medium strong till strong encryption.
2484 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002485 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002486 It adds a seed and a message authentication code (MAC)
2487 to the file. This needs at least a Vim 8.2.3022 to
2488 read the encrypted file.
2489 Encryption of swap files is not supported, therefore
2490 no swap file will be used when xchacha20 encryption is
2491 enabled.
2492 Encryption of undo files is not yet supported,
2493 therefore no undo file will currently be written.
2494 CURRENTLY EXPERIMENTAL: Files written with this method
2495 might have to be read back with the same version of
2496 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002497
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002498 You should use "blowfish2", also to re-encrypt older files.
2499
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002500 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002501 to the detected method of the file being read. Thus if you write it
2502 without changing 'cryptmethod' the same method will be used.
2503 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002504 explicitly write it, you don't get a warning unless there are other
2505 modifications. Also see |:X|.
2506
2507 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002508 the value "blowfish2". When setting the local value to an empty
2509 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002510
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002511 When a new encryption method is added in a later version of Vim, and
2512 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002513 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002514
2515
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 *'cscopepathcomp'* *'cspc'*
2517'cscopepathcomp' 'cspc' number (default 0)
2518 global
2519 {not available when compiled without the |+cscope|
2520 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 Determines how many components of the path to show in a list of tags.
2522 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002523 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524
2525 *'cscopeprg'* *'csprg'*
2526'cscopeprg' 'csprg' string (default "cscope")
2527 global
2528 {not available when compiled without the |+cscope|
2529 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 Specifies the command to execute cscope. See |cscopeprg|.
2531 This option cannot be set from a |modeline| or in the |sandbox|, for
2532 security reasons.
2533
2534 *'cscopequickfix'* *'csqf'*
2535'cscopequickfix' 'csqf' string (default "")
2536 global
2537 {not available when compiled without the |+cscope|
2538 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 Specifies whether to use quickfix window to show cscope results.
2540 See |cscopequickfix|.
2541
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002542 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002543'cscoperelative' 'csre' boolean (default off)
2544 global
2545 {not available when compiled without the |+cscope|
2546 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002547 In the absence of a prefix (-P) for cscope. setting this option enables
2548 to use the basename of cscope.out path as the prefix.
2549 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002550 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002551
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2553'cscopetag' 'cst' boolean (default off)
2554 global
2555 {not available when compiled without the |+cscope|
2556 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 Use cscope for tag commands. See |cscope-options|.
2558 NOTE: This option is reset when 'compatible' is set.
2559
2560 *'cscopetagorder'* *'csto'*
2561'cscopetagorder' 'csto' number (default 0)
2562 global
2563 {not available when compiled without the |+cscope|
2564 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 Determines the order in which ":cstag" performs a search. See
2566 |cscopetagorder|.
2567 NOTE: This option is set to 0 when 'compatible' is set.
2568
2569 *'cscopeverbose'* *'csverb'*
2570 *'nocscopeverbose'* *'nocsverb'*
2571'cscopeverbose' 'csverb' boolean (default off)
2572 global
2573 {not available when compiled without the |+cscope|
2574 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 Give messages when adding a cscope database. See |cscopeverbose|.
2576 NOTE: This option is reset when 'compatible' is set.
2577
Bram Moolenaar860cae12010-06-05 23:22:07 +02002578 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2579'cursorbind' 'crb' boolean (default off)
2580 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002581 When this option is set, as the cursor in the current
2582 window moves other cursorbound windows (windows that also have
2583 this option set) move their cursors to the corresponding line and
2584 column. This option is useful for viewing the
2585 differences between two versions of a file (see 'diff'); in diff mode,
2586 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002587 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002588
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002589
2590 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2591'cursorcolumn' 'cuc' boolean (default off)
2592 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002593 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002594 feature}
2595 Highlight the screen column of the cursor with CursorColumn
2596 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2597 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002598 If you only want the highlighting in the current window you can use
2599 these autocommands: >
2600 au WinLeave * set nocursorline nocursorcolumn
2601 au WinEnter * set cursorline cursorcolumn
2602<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002603
2604 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2605'cursorline' 'cul' boolean (default off)
2606 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002607 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002608 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002609 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2610 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002611 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002612 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002613
2614
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002615 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002616'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002617 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002618 {not available when compiled without the |+syntax|
2619 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002620 Comma separated list of settings for how 'cursorline' is displayed.
2621 Valid values:
2622 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002623 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002624 "screenline" Highlight only the screen line of the cursor with
2625 CursorLine |hl-CursorLine|.
2626 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002627 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002628
2629 Special value:
2630 "both" Alias for the values "line,number".
2631
2632 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002633
2634
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 *'debug'*
2636'debug' string (default "")
2637 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002638 These values can be used:
2639 msg Error messages that would otherwise be omitted will be given
2640 anyway.
2641 throw Error messages that would otherwise be omitted will be given
2642 anyway and also throw an exception and set |v:errmsg|.
2643 beep A message will be given when otherwise only a beep would be
2644 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002645 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002646 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2647 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648
2649 *'define'* *'def'*
2650'define' 'def' string (default "^\s*#\s*define")
2651 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002652 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 pattern, just like for the "/" command. This option is used for the
2654 commands like "[i" and "[d" |include-search|. The 'isident' option is
2655 used to recognize the defined name after the match:
2656 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2657 See |option-backslash| about inserting backslashes to include a space
2658 or backslash.
2659 The default value is for C programs. For C++ this value would be
2660 useful, to include const type declarations: >
2661 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002662< You can also use "\ze" just before the name and continue the pattern
2663 to check what is following. E.g. for Javascript, if a function is
2664 defined with "func_name = function(args)": >
2665 ^\s*\ze\i\+\s*=\s*function(
2666< If the function is defined with "func_name : function() {...": >
2667 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002669 To avoid that use `:let` with a single quote string: >
2670 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002671<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672
2673 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2674'delcombine' 'deco' boolean (default off)
2675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 If editing Unicode and this option is set, backspace and Normal mode
2677 "x" delete each combining character on its own. When it is off (the
2678 default) the character along with its combining characters are
2679 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002680 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681
2682 This is useful for Arabic, Hebrew and many other languages where one
2683 may have combining characters overtop of base characters, and want
2684 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002685 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686
2687 *'dictionary'* *'dict'*
2688'dictionary' 'dict' string (default "")
2689 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 List of file names, separated by commas, that are used to lookup words
2691 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2692 contain a list of words. This can be one word per line, or several
2693 words per line, separated by non-keyword characters (white space is
2694 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002695
2696 When this option is empty or an entry "spell" is present, and spell
2697 checking is enabled, words in the word lists for the currently active
2698 'spelllang' are used. See |spell|.
2699
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002700 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 after a comma are ignored, otherwise spaces are included in the file
2702 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002703 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 Where to find a list of words?
2705 - On FreeBSD, there is the file "/usr/share/dict/words".
2706 - In the Simtel archive, look in the "msdos/linguist" directory.
2707 - In "miscfiles" of the GNU collection.
2708 The use of |:set+=| and |:set-=| is preferred when adding or removing
2709 directories from the list. This avoids problems when a future version
2710 uses another default.
2711 Backticks cannot be used in this option for security reasons.
2712
2713 *'diff'* *'nodiff'*
2714'diff' boolean (default off)
2715 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 {not available when compiled without the |+diff|
2717 feature}
2718 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002719 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720
2721 *'dex'* *'diffexpr'*
2722'diffexpr' 'dex' string (default "")
2723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 {not available when compiled without the |+diff|
2725 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002726 Expression which is evaluated to obtain a diff file (either ed-style
2727 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 This option cannot be set from a |modeline| or in the |sandbox|, for
2729 security reasons.
2730
2731 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002732'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 {not available when compiled without the |+diff|
2735 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002736 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 All are optional. Items must be separated by a comma.
2738
2739 filler Show filler lines, to keep the text
2740 synchronized with a window that has inserted
2741 lines at the same position. Mostly useful
2742 when windows are side-by-side and 'scrollbind'
2743 is set.
2744
2745 context:{n} Use a context of {n} lines between a change
2746 and a fold that contains unchanged lines.
2747 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002748 When using zero the context is actually one,
2749 since folds require a line in between, also
2750 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 See |fold-diff|.
2752
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002753 iblank Ignore changes where lines are all blank. Adds
2754 the "-B" flag to the "diff" command if
2755 'diffexpr' is empty. Check the documentation
2756 of the "diff" command for what this does
2757 exactly.
2758 NOTE: the diff windows will get out of sync,
2759 because no differences between blank lines are
2760 taken into account.
2761
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 icase Ignore changes in case of text. "a" and "A"
2763 are considered the same. Adds the "-i" flag
2764 to the "diff" command if 'diffexpr' is empty.
2765
2766 iwhite Ignore changes in amount of white space. Adds
2767 the "-b" flag to the "diff" command if
2768 'diffexpr' is empty. Check the documentation
2769 of the "diff" command for what this does
2770 exactly. It should ignore adding trailing
2771 white space, but not leading white space.
2772
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002773 iwhiteall Ignore all white space changes. Adds
2774 the "-w" flag to the "diff" command if
2775 'diffexpr' is empty. Check the documentation
2776 of the "diff" command for what this does
2777 exactly.
2778
2779 iwhiteeol Ignore white space changes at end of line.
2780 Adds the "-Z" flag to the "diff" command if
2781 'diffexpr' is empty. Check the documentation
2782 of the "diff" command for what this does
2783 exactly.
2784
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002785 horizontal Start diff mode with horizontal splits (unless
2786 explicitly specified otherwise).
2787
2788 vertical Start diff mode with vertical splits (unless
2789 explicitly specified otherwise).
2790
Bram Moolenaarc8234772019-11-10 21:00:27 +01002791 closeoff When a window is closed where 'diff' is set
2792 and there is only one window remaining in the
2793 same tab page with 'diff' set, execute
2794 `:diffoff` in that window. This undoes a
2795 `:diffsplit` command.
2796
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002797 hiddenoff Do not use diff mode for a buffer when it
2798 becomes hidden.
2799
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002800 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2801 starting diff mode. Without this 2 is used.
2802
Bram Moolenaar4223d432021-02-10 13:18:17 +01002803 followwrap Follow the 'wrap' option and leave as it is.
2804
Bram Moolenaare828b762018-09-10 17:51:58 +02002805 internal Use the internal diff library. This is
2806 ignored when 'diffexpr' is set. *E960*
2807 When running out of memory when writing a
2808 buffer this item will be ignored for diffs
2809 involving that buffer. Set the 'verbose'
2810 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811
Bram Moolenaare828b762018-09-10 17:51:58 +02002812 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002813 Use the indent heuristic for the internal
2814 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002815
2816 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002817 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002818 algorithms are:
2819 myers the default algorithm
2820 minimal spend extra time to generate the
2821 smallest possible diff
2822 patience patience diff algorithm
2823 histogram histogram diff algorithm
2824
2825 Examples: >
2826 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002828 :set diffopt=internal,filler,foldcolumn:3
2829 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830<
2831 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2832'digraph' 'dg' boolean (default off)
2833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 {not available when compiled without the |+digraphs|
2835 feature}
2836 Enable the entering of digraphs in Insert mode with {char1} <BS>
2837 {char2}. See |digraphs|.
2838 NOTE: This option is reset when 'compatible' is set.
2839
2840 *'directory'* *'dir'*
2841'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002842 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 for Unix: ".,~/tmp,/var/tmp,/tmp")
2844 global
2845 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002846 Recommended value: ".,~/vimswap//" - this will put the swap file next
2847 to the edited file if possible, and in your personal swap directory
2848 otherwise. Make sure "~/vimswap//" is only readable for you.
2849
2850 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851 - The swap file will be created in the first directory where this is
2852 possible.
2853 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002854 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 - A directory "." means to put the swap file in the same directory as
2856 the edited file. On Unix, a dot is prepended to the file name, so
2857 it doesn't show in a directory listing. On MS-Windows the "hidden"
2858 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002859 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2860 the swap file relative to where the edited file is. The leading "."
2861 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002862 - For Unix and Win32, if a directory ends in two path separators "//",
2863 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002864 with all path separators replaced by percent '%' signs (including
2865 the colon following the drive letter on Win32). This will ensure
2866 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002867 On Win32, it is also possible to end with "\\". However, When a
2868 separating comma is following, you must use "//", since "\\" will
2869 include the comma in the file name. Therefore it is recommended to
2870 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 - Spaces after the comma are ignored, other spaces are considered part
2872 of the directory name. To have a space at the start of a directory
2873 name, precede it with a backslash.
2874 - To include a comma in a directory name precede it with a backslash.
2875 - A directory name may end in an ':' or '/'.
2876 - Environment variables are expanded |:set_env|.
2877 - Careful with '\' characters, type one before a space, type two to
2878 get one in the option (see |option-backslash|), for example: >
2879 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2880< - For backwards compatibility with Vim version 3.0 a '>' at the start
2881 of the option is removed.
2882 Using "." first in the list is recommended. This means that editing
2883 the same file twice will result in a warning. Using "/tmp" on Unix is
2884 discouraged: When the system crashes you lose the swap file.
2885 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002886 choice than "/tmp". But others on the computer may be able to see the
2887 files, and it can contain a lot of files, your swap files get lost in
2888 the crowd. That is why a "tmp" directory in your home directory is
2889 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 The use of |:set+=| and |:set-=| is preferred when adding or removing
2891 directories from the list. This avoids problems when a future version
2892 uses another default.
2893 This option cannot be set from a |modeline| or in the |sandbox|, for
2894 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895
2896 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002897'display' 'dy' string (default "", set to "truncate" in
2898 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 Change the way text is displayed. This is comma separated list of
2901 flags:
2902 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002903 in a window will be displayed. "@@@" is put in the
2904 last columns of the last screen line to indicate the
2905 rest of the line is not displayed.
2906 truncate Like "lastline", but "@@@" is displayed in the first
2907 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 uhex Show unprintable characters hexadecimal as <xx>
2909 instead of using ^C and ~C.
2910
Bram Moolenaard0796902016-09-16 20:02:31 +02002911 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002912 doesn't fit is replaced with "@" lines.
2913
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 *'eadirection'* *'ead'*
2915'eadirection' 'ead' string (default "both")
2916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 Tells when the 'equalalways' option applies:
2918 ver vertically, width of windows is not affected
2919 hor horizontally, height of windows is not affected
2920 both width and height of windows is affected
2921
2922 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2923'edcompatible' 'ed' boolean (default off)
2924 global
2925 Makes the 'g' and 'c' flags of the ":substitute" command to be
2926 toggled each time the flag is given. See |complex-change|. See
2927 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002928 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002929 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930
Bram Moolenaar03413f42016-04-12 21:07:15 +02002931 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002932'emoji' 'emo' boolean (default: on)
2933 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002934 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002935 This excludes "text emoji" characters, which are normally displayed as
2936 single width. Unfortunately there is no good specification for this
2937 and it has been determined on trial-and-error basis. Use the
2938 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002939
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002941'encoding' 'enc' string (default for MS-Windows: "utf-8",
2942 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 Sets the character encoding used inside Vim. It applies to text in
2945 the buffers, registers, Strings in expressions, text stored in the
2946 viminfo file, etc. It sets the kind of characters which Vim can work
2947 with. See |encoding-names| for the possible values.
2948
2949 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002950 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002952 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953
Bram Moolenaar865242e2010-07-14 21:12:05 +02002954 This option cannot be set from a |modeline|. It would most likely
2955 corrupt the text.
2956
Bram Moolenaar3df01732017-02-17 22:47:16 +01002957 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2958 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 'encoding', "utf-8" is the natural choice for the environment and
2960 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002961 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 versions, and to avoid changing the encoding of newly created files
2963 without your knowledge (in case 'fileencodings' is empty).
2964
2965 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002966 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 iconv() or as specified with 'charconvert'.
2968
Bram Moolenaar207f0092020-08-30 17:20:20 +02002969 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002970 can use: >
2971 if has("multi_byte_encoding")
2972<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 Normally 'encoding' will be equal to your current locale. This will
2974 be the default if Vim recognizes your environment settings. If
2975 'encoding' is not set to the current locale, 'termencoding' must be
2976 set to convert typed and displayed text. See |encoding-table|.
2977
2978 When you set this option, it fires the |EncodingChanged| autocommand
2979 event so that you can set up fonts if necessary.
2980
2981 When the option is set, the value is converted to lowercase. Thus
2982 you can set it with uppercase values too. Underscores are translated
2983 to '-' signs.
2984 When the encoding is recognized, it is changed to the standard name.
2985 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2986 "iso-8859-2" and "utf8" becomes "utf-8".
2987
2988 Note: "latin1" is also used when the encoding could not be detected.
2989 This only works when editing files in the same encoding! When the
2990 actual character set is not latin1, make sure 'fileencoding' and
2991 'fileencodings' are empty. When conversion is needed, switch to using
2992 utf-8.
2993
2994 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2995 You don't notice this while editing, but it does matter for the
2996 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2997 setting 'encoding' to one of these values instead of utf-8 only has
2998 effect for encoding used for files when 'fileencoding' is empty.
2999
Bram Moolenaar661b1822005-07-28 22:36:45 +00003000 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3001 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002
3003 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3004'endofline' 'eol' boolean (default on)
3005 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003007 is on, or 'fixeol' option is off, no <EOL> will be written for the
3008 last line in the file. This option is automatically set or reset when
3009 starting to edit a new file, depending on whether file has an <EOL>
3010 for the last line in the file. Normally you don't have to set or
3011 reset this option.
3012 When 'binary' is off and 'fixeol' is on the value is not used when
3013 writing the file. When 'binary' is on or 'fixeol' is off it is used
3014 to remember the presence of a <EOL> for the last line in the file, so
3015 that when you write the file the situation from the original file can
3016 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017
3018 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3019'equalalways' 'ea' boolean (default on)
3020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003022 splitting or closing a window. This also happens the moment the
3023 option is switched on. When off, splitting a window will reduce the
3024 size of the current window and leave the other windows the same. When
3025 closing a window the extra lines are given to the window next to it
3026 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 When mixing vertically and horizontally split windows, a minimal size
3028 is computed and some windows may be larger if there is room. The
3029 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003030 Changing the height and width of a window can be avoided by setting
3031 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003032 If a window size is specified when creating a new window sizes are
3033 currently not equalized (it's complicated, but may be implemented in
3034 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035
3036 *'equalprg'* *'ep'*
3037'equalprg' 'ep' string (default "")
3038 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003040 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003041 or 'indentexpr'. When Vim was compiled without internal formatting,
3042 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003043 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 about including spaces and backslashes.
3045 This option cannot be set from a |modeline| or in the |sandbox|, for
3046 security reasons.
3047
3048 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3049'errorbells' 'eb' boolean (default off)
3050 global
3051 Ring the bell (beep or screen flash) for error messages. This only
3052 makes a difference for error messages, the bell will be used always
3053 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003054 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003055 screen flash or do nothing. See 'belloff' to finetune when to ring the
3056 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057
3058 *'errorfile'* *'ef'*
3059'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3060 others: "errors.err")
3061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 {not available when compiled without the |+quickfix|
3063 feature}
3064 Name of the errorfile for the QuickFix mode (see |:cf|).
3065 When the "-q" command-line argument is used, 'errorfile' is set to the
3066 following argument. See |-q|.
3067 NOT used for the ":make" command. See 'makeef' for that.
3068 Environment variables are expanded |:set_env|.
3069 See |option-backslash| about including spaces and backslashes.
3070 This option cannot be set from a |modeline| or in the |sandbox|, for
3071 security reasons.
3072
3073 *'errorformat'* *'efm'*
3074'errorformat' 'efm' string (default is very long)
3075 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 {not available when compiled without the |+quickfix|
3077 feature}
3078 Scanf-like description of the format for the lines in the error file
3079 (see |errorformat|).
3080
3081 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3082'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 Function keys that start with an <Esc> are recognized in Insert
3085 mode. When this option is off, the cursor and function keys cannot be
3086 used in Insert mode if they start with an <Esc>. The advantage of
3087 this is that the single <Esc> is recognized immediately, instead of
3088 after one second. Instead of resetting this option, you might want to
3089 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3090 when 'esckeys' is off, you can still map anything, but the cursor keys
3091 won't work by default.
3092 NOTE: This option is set to the Vi default value when 'compatible' is
3093 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003094 NOTE: when this option is off then the |modifyOtherKeys| functionality
3095 is disabled while in Insert mode to avoid ending Insert mode with any
3096 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097
3098 *'eventignore'* *'ei'*
3099'eventignore' 'ei' string (default "")
3100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003102 When set to "all" or when "all" is one of the items, all autocommand
3103 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 Otherwise this is a comma separated list of event names. Example: >
3105 :set ei=WinEnter,WinLeave
3106<
3107 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3108'expandtab' 'et' boolean (default off)
3109 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003111 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3113 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003114 This option is reset when the 'paste' option is set and restored when
3115 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 NOTE: This option is reset when 'compatible' is set.
3117
3118 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3119'exrc' 'ex' boolean (default off)
3120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003122 directory.
3123
3124 Setting this option is a potential security leak. E.g., consider
3125 unpacking a package or fetching files from github, a .vimrc in there
3126 might be a trojan horse. BETTER NOT SET THIS OPTION!
3127 Instead, define an autocommand in your .vimrc to set options for a
3128 matching directory.
3129
3130 If you do switch this option on you should also consider setting the
3131 'secure' option (see |initialization|).
3132 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 This option cannot be set from a |modeline| or in the |sandbox|, for
3134 security reasons.
3135
3136 *'fileencoding'* *'fenc'* *E213*
3137'fileencoding' 'fenc' string (default: "")
3138 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003140
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003142 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 When 'fileencoding' is empty, the same value as 'encoding' will be
3144 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003145 No error will be given when the value is set, only when it is used,
3146 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003147 Conversion will also be done when 'encoding' and 'fileencoding' are
3148 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3149 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003151 'encoding' is "utf-8" or another Unicode encoding, conversion
3152 is most likely done in a way that the reverse conversion
3153 results in the same text. When 'encoding' is not "utf-8" some
3154 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003155
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 See 'encoding' for the possible values. Additionally, values may be
3157 specified that can be handled by the converter, see
3158 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003159
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 When reading a file 'fileencoding' will be set from 'fileencodings'.
3161 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003162 'fileencoding', use the |++enc| argument. One exception: when
3163 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003164 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003165
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3167 When the option is set, the value is converted to lowercase. Thus
3168 you can set it with uppercase values too. '_' characters are
3169 replaced with '-'. If a name is recognized from the list for
3170 'encoding', it is replaced by the standard name. For example
3171 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003172
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 When this option is set, after starting to edit a file, the 'modified'
3174 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003175
3176 Keep in mind that changing 'fenc' from a modeline happens
3177 AFTER the text has been read, thus it applies to when the file will be
3178 written. If you do set 'fenc' in a modeline, you might want to set
3179 'nomodified' to avoid not being able to ":q".
3180
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 This option can not be changed when 'modifiable' is off.
3182
3183 *'fe'*
3184 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003185 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 old short name was 'fe', which is no longer used.
3187
3188 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003189'fileencodings' 'fencs' string (default: "ucs-bom",
3190 "ucs-bom,utf-8,default,latin1" when
3191 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 This is a list of character encodings considered when starting to edit
3194 an existing file. When a file is read, Vim tries to use the first
3195 mentioned character encoding. If an error is detected, the next one
3196 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003197 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 an empty string, which means the value of 'encoding' is used.
3199 WARNING: Conversion can cause loss of information! When
3200 'encoding' is "utf-8" (or one of the other Unicode variants)
3201 conversion is most likely done in a way that the reverse
3202 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003203 "utf-8" some non-ASCII characters may be lost! You can use
3204 the |++bad| argument to specify what is done with characters
3205 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 For an empty file or a file with only ASCII characters most encodings
3207 will work and the first entry of 'fileencodings' will be used (except
3208 "ucs-bom", which requires the BOM to be present). If you prefer
3209 another encoding use an BufReadPost autocommand event to test if your
3210 preferred encoding is to be used. Example: >
3211 au BufReadPost * if search('\S', 'w') == 0 |
3212 \ set fenc=iso-2022-jp | endif
3213< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3214 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003215 When the |++enc| argument is used then the value of 'fileencodings' is
3216 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003217 Note that 'fileencodings' is not used for a new file, the global value
3218 of 'fileencoding' is used instead. You can set it with: >
3219 :setglobal fenc=iso-8859-2
3220< This means that a non-existing file may get a different encoding than
3221 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 The special value "ucs-bom" can be used to check for a Unicode BOM
3223 (Byte Order Mark) at the start of the file. It must not be preceded
3224 by "utf-8" or another Unicode encoding for this to work properly.
3225 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3226 because Vim cannot detect an error, thus the encoding is always
3227 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003228 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003229 environment. On MS-Windows this is the system encoding. Otherwise
3230 this is the default value for 'encoding'. It is useful when
3231 'encoding' is set to "utf-8" and your environment uses a non-latin1
3232 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003233 When 'encoding' is "utf-8" and a file contains an illegal byte
3234 sequence it won't be recognized as UTF-8. You can use the |8g8|
3235 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 WRONG VALUES: WHAT'S WRONG:
3237 latin1,utf-8 "latin1" will always be used
3238 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3239 file
3240 cp1250,latin1 "cp1250" will always be used
3241 If 'fileencodings' is empty, 'fileencoding' is not modified.
3242 See 'fileencoding' for the possible values.
3243 Setting this option does not have an effect until the next time a file
3244 is read.
3245
3246 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003247'fileformat' 'ff' string (MS-Windows default: "dos",
3248 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 This gives the <EOL> of the current buffer, which is used for
3251 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003252 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 unix <NL>
3254 mac <CR>
3255 When "dos" is used, CTRL-Z at the end of a file is ignored.
3256 See |file-formats| and |file-read|.
3257 For the character encoding of the file see 'fileencoding'.
3258 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003259 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 This option is set automatically when starting to edit a file and
3261 'fileformats' is not empty and 'binary' is off.
3262 When this option is set, after starting to edit a file, the 'modified'
3263 option is set, because the file would be different when written.
3264 This option can not be changed when 'modifiable' is off.
3265 For backwards compatibility: When this option is set to "dos",
3266 'textmode' is set, otherwise 'textmode' is reset.
3267
3268 *'fileformats'* *'ffs'*
3269'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003270 Vim+Vi MS-Windows: "dos,unix",
3271 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 Vi Cygwin: "unix,dos",
3273 Vi others: "")
3274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 This gives the end-of-line (<EOL>) formats that will be tried when
3276 starting to edit a new buffer and when reading a file into an existing
3277 buffer:
3278 - When empty, the format defined with 'fileformat' will be used
3279 always. It is not set automatically.
3280 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003281 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 'fileformats' name will be used when a file is read into an existing
3283 buffer, no matter what 'fileformat' for that buffer is set to.
3284 - When more than one name is present, separated by commas, automatic
3285 <EOL> detection will be done when reading a file. When starting to
3286 edit a file, a check is done for the <EOL>:
3287 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3288 'fileformat' is set to "dos".
3289 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003290 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003292 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3293 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003294 This means that "mac" is only chosen when:
3295 "unix" is not present or no <NL> is found in the file, and
3296 "dos" is not present or no <CR><NL> is found in the file.
3297 Except: if "unix" was chosen, but there is a <CR> before
3298 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003299 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 4. If 'fileformat' is still not set, the first name from
3301 'fileformats' is used.
3302 When reading a file into an existing buffer, the same is done, but
3303 this happens like 'fileformat' has been set appropriately for that
3304 file only, the option is not changed.
3305 When 'binary' is set, the value of 'fileformats' is not used.
3306
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003307 When Vim starts up with an empty buffer the first item is used. You
3308 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003309
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3311 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3312 done:
3313 - When 'fileformats' is empty, there is no automatic detection. Dos
3314 format will be used.
3315 - When 'fileformats' is set to one or more names, automatic detection
3316 is done. This is based on the first <NL> in the file: If there is a
3317 <CR> in front of it, Dos format is used, otherwise Unix format is
3318 used.
3319 Also see |file-formats|.
3320 For backwards compatibility: When this option is set to an empty
3321 string or one format (no comma is included), 'textauto' is reset,
3322 otherwise 'textauto' is set.
3323 NOTE: This option is set to the Vi default value when 'compatible' is
3324 set and to the Vim default value when 'compatible' is reset.
3325
Bram Moolenaarbf884932013-04-05 22:26:15 +02003326 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3327'fileignorecase' 'fic' boolean (default on for systems where case in file
3328 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003329 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003330 When set case is ignored when using file names and directories.
3331 See 'wildignorecase' for only ignoring case when doing completion.
3332
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 *'filetype'* *'ft'*
3334'filetype' 'ft' string (default: "")
3335 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 When this option is set, the FileType autocommand event is triggered.
3337 All autocommands that match with the value of this option will be
3338 executed. Thus the value of 'filetype' is used in place of the file
3339 name.
3340 Otherwise this option does not always reflect the current file type.
3341 This option is normally set when the file type is detected. To enable
3342 this use the ":filetype on" command. |:filetype|
3343 Setting this option to a different value is most useful in a modeline,
3344 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003345 Example, for in an IDL file:
3346 /* vim: set filetype=idl : */ ~
3347 |FileType| |filetypes|
3348 When a dot appears in the value then this separates two filetype
3349 names. Example:
3350 /* vim: set filetype=c.doxygen : */ ~
3351 This will use the "c" filetype first, then the "doxygen" filetype.
3352 This works both for filetype plugins and for syntax files. More than
3353 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 This option is not copied to another buffer, independent of the 's' or
3355 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003356 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357
3358 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003359'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003361 {not available when compiled without the |+folding|
3362 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 Characters to fill the statuslines and vertical separators.
3364 It is a comma separated list of items:
3365
3366 item default Used for ~
3367 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003368 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 vert:c '|' vertical separators |:vsplit|
3370 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003371 foldopen:c '-' mark the beginning of a fold
3372 foldclose:c '+' show a closed fold
3373 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003375 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003377 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003378 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 otherwise.
3380
3381 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003382 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383< This is similar to the default, except that these characters will also
3384 be used when there is highlighting.
3385
Bram Moolenaar008bff92021-03-04 21:55:58 +01003386 For "stl" and "stlnc" single-byte and multibyte characters are
3387 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003388
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 The highlighting used for these items:
3390 item highlight group ~
3391 stl:c StatusLine |hl-StatusLine|
3392 stlnc:c StatusLineNC |hl-StatusLineNC|
3393 vert:c VertSplit |hl-VertSplit|
3394 fold:c Folded |hl-Folded|
3395 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003396 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003398 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3399'fixendofline' 'fixeol' boolean (default on)
3400 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003401 When writing a file and this option is on, <EOL> at the end of file
3402 will be restored if missing. Turn this option off if you want to
3403 preserve the situation from the original file.
3404 When the 'binary' option is set the value of this option doesn't
3405 matter.
3406 See the 'endofline' option.
3407
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003409'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 {only available when compiled with the |+rightleft|
3412 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003413 This option was for using Farsi, which has been removed. See
3414 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415
3416 *'foldclose'* *'fcl'*
3417'foldclose' 'fcl' string (default "")
3418 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 {not available when compiled without the |+folding|
3420 feature}
3421 When set to "all", a fold is closed when the cursor isn't in it and
3422 its level is higher than 'foldlevel'. Useful if you want folds to
3423 automatically close when moving out of them.
3424
3425 *'foldcolumn'* *'fdc'*
3426'foldcolumn' 'fdc' number (default 0)
3427 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 {not available when compiled without the |+folding|
3429 feature}
3430 When non-zero, a column with the specified width is shown at the side
3431 of the window which indicates open and closed folds. The maximum
3432 value is 12.
3433 See |folding|.
3434
3435 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3436'foldenable' 'fen' boolean (default on)
3437 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 {not available when compiled without the |+folding|
3439 feature}
3440 When off, all folds are open. This option can be used to quickly
3441 switch between showing all text unfolded and viewing the text with
3442 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003443 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 'foldenable' is off.
3445 This option is set by commands that create a new fold or close a fold.
3446 See |folding|.
3447
3448 *'foldexpr'* *'fde'*
3449'foldexpr' 'fde' string (default: "0")
3450 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003452 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003454 for each line to obtain its fold level. The context is set to the
3455 script where 'foldexpr' was set, script-local items can be accessed.
3456 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003457
Bram Moolenaar30b65812012-07-12 22:01:11 +02003458 The expression will be evaluated in the |sandbox| if set from a
3459 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003460 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003461 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003462
3463 It is not allowed to change text or jump to another window while
3464 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465
3466 *'foldignore'* *'fdi'*
3467'foldignore' 'fdi' string (default: "#")
3468 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 {not available when compiled without the |+folding|
3470 feature}
3471 Used only when 'foldmethod' is "indent". Lines starting with
3472 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003473 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 The default "#" works well for C programs. See |fold-indent|.
3475
3476 *'foldlevel'* *'fdl'*
3477'foldlevel' 'fdl' number (default: 0)
3478 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 {not available when compiled without the |+folding|
3480 feature}
3481 Sets the fold level: Folds with a higher level will be closed.
3482 Setting this option to zero will close all folds. Higher numbers will
3483 close fewer folds.
3484 This option is set by commands like |zm|, |zM| and |zR|.
3485 See |fold-foldlevel|.
3486
3487 *'foldlevelstart'* *'fdls'*
3488'foldlevelstart' 'fdls' number (default: -1)
3489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 {not available when compiled without the |+folding|
3491 feature}
3492 Sets 'foldlevel' when starting to edit another buffer in a window.
3493 Useful to always start editing with all folds closed (value zero),
3494 some folds closed (one) or no folds closed (99).
3495 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003496 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 ignores this option and closes all folds.
3498 It is also done before BufReadPre autocommands, to allow an autocmd to
3499 overrule the 'foldlevel' value for specific files.
3500 When the value is negative, it is not used.
3501
3502 *'foldmarker'* *'fmr'* *E536*
3503'foldmarker' 'fmr' string (default: "{{{,}}}")
3504 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 {not available when compiled without the |+folding|
3506 feature}
3507 The start and end marker used when 'foldmethod' is "marker". There
3508 must be one comma, which separates the start and end marker. The
3509 marker is a literal string (a regular expression would be too slow).
3510 See |fold-marker|.
3511
3512 *'foldmethod'* *'fdm'*
3513'foldmethod' 'fdm' string (default: "manual")
3514 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 {not available when compiled without the |+folding|
3516 feature}
3517 The kind of folding used for the current window. Possible values:
3518 |fold-manual| manual Folds are created manually.
3519 |fold-indent| indent Lines with equal indent form a fold.
3520 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3521 |fold-marker| marker Markers are used to specify folds.
3522 |fold-syntax| syntax Syntax highlighting items specify folds.
3523 |fold-diff| diff Fold text that is not changed.
3524
3525 *'foldminlines'* *'fml'*
3526'foldminlines' 'fml' number (default: 1)
3527 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 {not available when compiled without the |+folding|
3529 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003530 Sets the number of screen lines above which a fold can be displayed
3531 closed. Also for manually closed folds. With the default value of
3532 one a fold can only be closed if it takes up two or more screen lines.
3533 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003534 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 "zc" to close a fold, which is displayed open because it's smaller
3536 than 'foldminlines', a following "zc" may close a containing fold.
3537
3538 *'foldnestmax'* *'fdn'*
3539'foldnestmax' 'fdn' number (default: 20)
3540 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 {not available when compiled without the |+folding|
3542 feature}
3543 Sets the maximum nesting of folds for the "indent" and "syntax"
3544 methods. This avoids that too many folds will be created. Using more
3545 than 20 doesn't work, because the internal limit is 20.
3546
3547 *'foldopen'* *'fdo'*
3548'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3549 search,tag,undo")
3550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 {not available when compiled without the |+folding|
3552 feature}
3553 Specifies for which type of commands folds will be opened, if the
3554 command moves the cursor into a closed fold. It is a comma separated
3555 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003556 NOTE: When the command is part of a mapping this option is not used.
3557 Add the |zv| command to the mapping to get the same effect.
3558 (rationale: the mapping may want to control opening folds itself)
3559
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 item commands ~
3561 all any
3562 block "(", "{", "[[", "[{", etc.
3563 hor horizontal movements: "l", "w", "fx", etc.
3564 insert any command in Insert mode
3565 jump far jumps: "G", "gg", etc.
3566 mark jumping to a mark: "'m", CTRL-O, etc.
3567 percent "%"
3568 quickfix ":cn", ":crew", ":make", etc.
3569 search search for a pattern: "/", "n", "*", "gd", etc.
3570 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003571 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 tag jumping to a tag: ":ta", CTRL-T, etc.
3573 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 When a movement command is used for an operator (e.g., "dl" or "y%")
3575 this option is not used. This means the operator will include the
3576 whole closed fold.
3577 Note that vertical movements are not here, because it would make it
3578 very difficult to move onto a closed fold.
3579 In insert mode the folds containing the cursor will always be open
3580 when text is inserted.
3581 To close folds you can re-apply 'foldlevel' with the |zx| command or
3582 set the 'foldclose' option to "all".
3583
3584 *'foldtext'* *'fdt'*
3585'foldtext' 'fdt' string (default: "foldtext()")
3586 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 {not available when compiled without the |+folding|
3588 feature}
3589 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003590 fold. The context is set to the script where 'foldexpr' was set,
3591 script-local items can be accessed. See |fold-foldtext| for the
3592 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593
Bram Moolenaar30b65812012-07-12 22:01:11 +02003594 The expression will be evaluated in the |sandbox| if set from a
3595 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003596 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003597
3598 It is not allowed to change text or jump to another window while
3599 evaluating 'foldtext' |textlock|.
3600
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003601 *'formatexpr'* *'fex'*
3602'formatexpr' 'fex' string (default "")
3603 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003604 {not available when compiled without the |+eval|
3605 feature}
3606 Expression which is evaluated to format a range of lines for the |gq|
3607 operator or automatic formatting (see 'formatoptions'). When this
3608 option is empty 'formatprg' is used.
3609
3610 The |v:lnum| variable holds the first line to be formatted.
3611 The |v:count| variable holds the number of lines to be formatted.
3612 The |v:char| variable holds the character that is going to be
3613 inserted if the expression is being evaluated due to
3614 automatic formatting. This can be empty. Don't insert
3615 it yet!
3616
3617 Example: >
3618 :set formatexpr=mylang#Format()
3619< This will invoke the mylang#Format() function in the
3620 autoload/mylang.vim file in 'runtimepath'. |autoload|
3621
3622 The expression is also evaluated when 'textwidth' is set and adding
3623 text beyond that limit. This happens under the same conditions as
3624 when internal formatting is used. Make sure the cursor is kept in the
3625 same spot relative to the text then! The |mode()| function will
3626 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003627
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003628 When the expression evaluates to non-zero Vim will fall back to using
3629 the internal format mechanism.
3630
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003631 If the expression starts with s: or |<SID>|, then it is replaced with
3632 the script ID (|local-function|). Example: >
3633 set formatexpr=s:MyFormatExpr()
3634 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003635< Otherwise, the expression is evaluated in the context of the script
3636 where the option was set, thus script-local items are available.
3637
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003638 The expression will be evaluated in the |sandbox| when set from a
3639 modeline, see |sandbox-option|. That stops the option from working,
3640 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003641 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003642 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003643
Bram Moolenaar86b68352004-12-27 21:59:20 +00003644 *'formatlistpat'* *'flp'*
3645'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3646 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003647 A pattern that is used to recognize a list header. This is used for
3648 the "n" flag in 'formatoptions'.
3649 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003650 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003651 while still checking more characters. There must be a character
3652 following the pattern, when it matches the whole line it is handled
3653 like there is no match.
3654 The default recognizes a number, followed by an optional punctuation
3655 character and white space.
3656
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003657 *'formatoptions'* *'fo'*
3658'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3659 local to buffer
3660 This is a sequence of letters which describes how automatic
3661 formatting is to be done. See |fo-table|. When the 'paste' option is
3662 on, no formatting is done (like 'formatoptions' is empty). Commas can
3663 be inserted for readability.
3664 To avoid problems with flags that are added in the future, use the
3665 "+=" and "-=" feature of ":set" |add-option-flags|.
3666 NOTE: This option is set to the Vi default value when 'compatible' is
3667 set and to the Vim default value when 'compatible' is reset.
3668
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 *'formatprg'* *'fp'*
3670'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003671 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003673 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003675 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003676 If the 'formatexpr' option is not empty it will be used instead.
3677 Otherwise, if 'formatprg' option is an empty string, the internal
3678 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003679 Environment variables are expanded |:set_env|. See |option-backslash|
3680 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003681 This option cannot be set from a |modeline| or in the |sandbox|, for
3682 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683
Bram Moolenaard94464e2015-11-02 15:28:18 +01003684 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003685'fsync' 'fs' boolean (default on)
3686 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003687 When on, the library function fsync() will be called after writing a
3688 file. This will flush a file to disk, ensuring that it is safely
3689 written even on filesystems which do metadata-only journaling. This
3690 will force the harddrive to spin up on Linux systems running in laptop
3691 mode, so it may be undesirable in some situations. Be warned that
3692 turning this off increases the chances of data loss after a crash. On
3693 systems without an fsync() implementation, this variable is always
3694 off.
3695 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003696 'fsync' also applies to |writefile()| (unless a flag is used to
3697 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003698 This option cannot be set from a |modeline| or in the |sandbox|, for
3699 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003700
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3702'gdefault' 'gd' boolean (default off)
3703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 When on, the ":substitute" flag 'g' is default on. This means that
3705 all matches in a line are substituted instead of one. When a 'g' flag
3706 is given to a ":substitute" command, this will toggle the substitution
3707 of all or one match. See |complex-change|.
3708
3709 command 'gdefault' on 'gdefault' off ~
3710 :s/// subst. all subst. one
3711 :s///g subst. one subst. all
3712 :s///gg subst. all subst. one
3713
3714 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003715 DEPRECATED: Setting this option may break plugins that are not aware
3716 of this option. Also, many users get confused that adding the /g flag
3717 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003718 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719
3720 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003721'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 Format to recognize for the ":grep" command output.
3724 This is a scanf-like string that uses the same format as the
3725 'errorformat' option: see |errorformat|.
3726
3727 *'grepprg'* *'gp'*
3728'grepprg' 'gp' string (default "grep -n ",
3729 Unix: "grep -n $* /dev/null",
3730 Win32: "findstr /n" or "grep -n",
3731 VMS: "SEARCH/NUMBERS ")
3732 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003733 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 and '#' characters, which are expanded like when used in a command-
3735 line. The placeholder "$*" is allowed to specify where the arguments
3736 will be included. Environment variables are expanded |:set_env|. See
3737 |option-backslash| about including spaces and backslashes.
3738 When your "grep" accepts the "-H" argument, use this to make ":grep"
3739 also work well with a single file: >
3740 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003741< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003742 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3743 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003744 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 apply equally to 'grepprg'.
3746 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3747 otherwise it's "grep -n".
3748 This option cannot be set from a |modeline| or in the |sandbox|, for
3749 security reasons.
3750
3751 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3752'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3753 ve:ver35-Cursor,
3754 o:hor50-Cursor,
3755 i-ci:ver25-Cursor/lCursor,
3756 r-cr:hor20-Cursor/lCursor,
3757 sm:block-Cursor
3758 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003759 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 "n-v-c:block,o:hor50,i-ci:hor15,
3761 r-cr:hor30,sm:block")
3762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003764 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003766 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003767 height of the cursor can be changed. This can be done by specifying a
3768 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003769 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3770 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003772 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 mode-list and an argument-list:
3774 mode-list:argument-list,mode-list:argument-list,..
3775 The mode-list is a dash separated list of these modes:
3776 n Normal mode
3777 v Visual mode
3778 ve Visual mode with 'selection' "exclusive" (same as 'v',
3779 if not specified)
3780 o Operator-pending mode
3781 i Insert mode
3782 r Replace mode
3783 c Command-line Normal (append) mode
3784 ci Command-line Insert mode
3785 cr Command-line Replace mode
3786 sm showmatch in Insert mode
3787 a all modes
3788 The argument-list is a dash separated list of these arguments:
3789 hor{N} horizontal bar, {N} percent of the character height
3790 ver{N} vertical bar, {N} percent of the character width
3791 block block cursor, fills the whole character
3792 [only one of the above three should be present]
3793 blinkwait{N} *cursor-blinking*
3794 blinkon{N}
3795 blinkoff{N}
3796 blink times for cursor: blinkwait is the delay before
3797 the cursor starts blinking, blinkon is the time that
3798 the cursor is shown and blinkoff is the time that the
3799 cursor is not shown. The times are in msec. When one
3800 of the numbers is zero, there is no blinking. The
3801 default is: "blinkwait700-blinkon400-blinkoff250".
3802 These numbers are used for a missing entry. This
3803 means that blinking is enabled by default. To switch
3804 blinking off you can use "blinkon0". The cursor only
3805 blinks when Vim is waiting for input, not while
3806 executing a command.
3807 To make the cursor blink in an xterm, see
3808 |xterm-blink|.
3809 {group-name}
3810 a highlight group name, that sets the color and font
3811 for the cursor
3812 {group-name}/{group-name}
3813 Two highlight group names, the first is used when
3814 no language mappings are used, the other when they
3815 are. |language-mapping|
3816
3817 Examples of parts:
3818 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3819 block cursor with colors from the "nCursor"
3820 highlight group
3821 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3822 In Insert and Command-line Insert mode, use a
3823 30% vertical bar cursor with colors from the
3824 "iCursor" highlight group. Blink a bit
3825 faster.
3826
3827 The 'a' mode is different. It will set the given argument-list for
3828 all modes. It does not reset anything to defaults. This can be used
3829 to do a common setting for all modes. For example, to switch off
3830 blinking: "a:blinkon0"
3831
3832 Examples of cursor highlighting: >
3833 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3834 :highlight Cursor gui=NONE guifg=bg guibg=fg
3835<
3836 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003837 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838'guifont' 'gfn' string (default "")
3839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 {only available when compiled with GUI enabled}
3841 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003842 In its simplest form the value is just one font name.
3843 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844
3845 *'guifontset'* *'gfs'*
3846 *E250* *E252* *E234* *E597* *E598*
3847'guifontset' 'gfs' string (default "")
3848 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 {only available when compiled with GUI enabled and
3850 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003851 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 When not empty, specifies two (or more) fonts to be used. The first
3853 one for normal English, the second one for your special language. See
3854 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003855
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3857'guifontwide' 'gfw' string (default "")
3858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 {only available when compiled with GUI enabled}
3860 When not empty, specifies a comma-separated list of fonts to be used
3861 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003862 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003863
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 *'guiheadroom'* *'ghr'*
3865'guiheadroom' 'ghr' number (default 50)
3866 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003867 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 The number of pixels subtracted from the screen height when fitting
3869 the GUI window on the screen. Set this before the GUI is started,
3870 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003871 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 lines will be left for window decorations and other items on the
3873 screen. Set it to a negative value to allow windows taller than the
3874 screen.
3875
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003876 *'guiligatures'* *'gli'* *E1243*
3877'guiligatures' 'gli' string (default "")
3878 global
3879 {only for GTK GUI}
3880 List of ASCII characters that, when combined together, can create more
3881 complex shapes. Each character must be a printable ASCII character
3882 with a value in the 32-127 range.
3883 Example: >
3884 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3885< Changing this option updates screen output immediately. Set it to an
3886 empty string to disable ligatures.
3887
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003889'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3890 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003891 "aegimrLtT" (GTK, Motif and Athena),
3892 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003895 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 sequence of letters which describes what components and options of the
3897 GUI should be used.
3898 To avoid problems with flags that are added in the future, use the
3899 "+=" and "-=" feature of ":set" |add-option-flags|.
3900
Bram Moolenaar13568252018-03-16 20:46:58 +01003901 Valid characters are as follows:
3902 *'go-!'*
3903 '!' External commands are executed in a terminal window. Without
3904 this flag the MS-Windows GUI will open a console window to
3905 execute the command. The Unix GUI will simulate a dumb
3906 terminal to list the command output.
3907 The terminal window will be positioned at the bottom, and grow
3908 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003909 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 'a' Autoselect: If present, then whenever VISUAL mode is started,
3911 or the Visual area extended, Vim tries to become the owner of
3912 the windowing system's global selection. This means that the
3913 Visually highlighted text is available for pasting into other
3914 applications as well as into Vim itself. When the Visual mode
3915 ends, possibly due to an operation on the text, or when an
3916 application wants to paste the selection, the highlighted text
3917 is automatically yanked into the "* selection register.
3918 Thus the selection is still available for pasting into other
3919 applications after the VISUAL mode has ended.
3920 If not present, then Vim won't become the owner of the
3921 windowing system's global selection unless explicitly told to
3922 by a yank or delete operation for the "* register.
3923 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003924 *'go-P'*
3925 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003926 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003927 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003928 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 applies to the modeless selection.
3930
3931 'guioptions' autoselect Visual autoselect modeless ~
3932 "" - -
3933 "a" yes yes
3934 "A" - yes
3935 "aA" yes yes
3936
Bram Moolenaar02467872007-05-06 13:22:01 +00003937 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 'c' Use console dialogs instead of popup dialogs for simple
3939 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003940 *'go-d'*
3941 'd' Use dark theme variant if available. Currently only works for
3942 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003943 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003944 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003945 'guitablabel' can be used to change the text in the labels.
3946 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003947 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003948 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003949 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 'f' Foreground: Don't use fork() to detach the GUI from the shell
3951 where it was started. Use this for programs that wait for the
3952 editor to finish (e.g., an e-mail program). Alternatively you
3953 can use "gvim -f" or ":gui -f" to start the GUI in the
3954 foreground. |gui-fork|
3955 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003956 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003957 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3959 corner of the window. It's black&white on non-GTK, because of
3960 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003961 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003963 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003964 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003966 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003968 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003969 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 'g' Grey menu items: Make menu items that are not active grey. If
3971 'g' is not included inactive menu items are not shown at all.
3972 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003973 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 't' Include tearoff menu items. Currently only works for Win32,
3975 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003976 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003977 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003978 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003979 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003981 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 'R' Right-hand scrollbar is present when there is a vertically
3983 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003984 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003986 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 'L' Left-hand scrollbar is present when there is a vertically
3988 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003989 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3991 the longest visible line, or on the cursor line if the 'h'
3992 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003993 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 'h' Limit horizontal scrollbar size to the length of the cursor
3995 line. Reduces computations. |gui-horiz-scroll|
3996
3997 And yes, you may even have scrollbars on the left AND the right if
3998 you really want to :-). See |gui-scrollbars| for more information.
3999
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004000 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 'v' Use a vertical button layout for dialogs. When not included,
4002 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004003 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004004 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 'p' Use Pointer callbacks for X11 GUI. This is required for some
4006 window managers. If the cursor is not blinking or hollow at
4007 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004008 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004010 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004011 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004012 *'go-k'*
4013 'k' Keep the GUI window size when adding/removing a scrollbar, or
4014 toolbar, tabline, etc. Instead, the behavior is similar to
4015 when the window is maximized and will adjust 'lines' and
4016 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004017 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004018 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004019
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 *'guipty'* *'noguipty'*
4021'guipty' boolean (default on)
4022 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 {only available when compiled with GUI enabled}
4024 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4025 I/O to/from shell commands. See |gui-pty|.
4026
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004027 *'guitablabel'* *'gtl'*
4028'guitablabel' 'gtl' string (default empty)
4029 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004030 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004031 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004032 pages line. When empty and when the result is empty Vim will use a
4033 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004034
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004035 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004036 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004037 The expression will be evaluated in the |sandbox| when set from a
4038 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004039 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004040
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004041 Only used when the GUI tab pages line is displayed. 'e' must be
4042 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4043 used.
4044
Bram Moolenaar57657d82006-04-21 22:12:41 +00004045 *'guitabtooltip'* *'gtt'*
4046'guitabtooltip' 'gtt' string (default empty)
4047 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004048 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004049 When nonempty describes the text to use in a tooltip for the GUI tab
4050 pages line. When empty Vim will use a default tooltip.
4051 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004052 You can include a line break. Simplest method is to use |:let|: >
4053 :let &guitabtooltip = "line one\nline two"
4054<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004055
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004057'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 (others) "$VIMRUNTIME/doc/help.txt")
4059 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 Name of the main help file. All distributed help files should be
4061 placed together in one directory. Additionally, all "doc" directories
4062 in 'runtimepath' will be used.
4063 Environment variables are expanded |:set_env|. For example:
4064 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004065 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 spaces and backslashes.
4067 This option cannot be set from a |modeline| or in the |sandbox|, for
4068 security reasons.
4069
4070 *'helpheight'* *'hh'*
4071'helpheight' 'hh' number (default 20)
4072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 Minimal initial height of the help window when it is opened with the
4074 ":help" command. The initial height of the help window is half of the
4075 current window, or (when the 'ea' option is on) the same as other
4076 windows. When the height is less than 'helpheight', the height is
4077 set to 'helpheight'. Set to zero to disable.
4078
4079 *'helplang'* *'hlg'*
4080'helplang' 'hlg' string (default: messages language or empty)
4081 global
4082 {only available when compiled with the |+multi_lang|
4083 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 Comma separated list of languages. Vim will use the first language
4085 for which the desired help can be found. The English help will always
4086 be used as a last resort. You can add "en" to prefer English over
4087 another language, but that will only find tags that exist in that
4088 language and not in the English help.
4089 Example: >
4090 :set helplang=de,it
4091< This will first search German, then Italian and finally English help
4092 files.
4093 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4094 try to find the tag in the current language before using this option.
4095 See |help-translated|.
4096
4097 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4098'hidden' 'hid' boolean (default off)
4099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 When off a buffer is unloaded when it is |abandon|ed. When on a
4101 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4102 displayed in another window, it does not become hidden, of course.
4103 The commands that move through the buffer list sometimes make a buffer
4104 hidden although the 'hidden' option is off: When the buffer is
4105 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004106 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004107 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 This option is set for one command with ":hide {command}" |:hide|.
4109 WARNING: It's easy to forget that you have changes in hidden buffers.
4110 Think twice when using ":q!" or ":qa!".
4111
4112 *'highlight'* *'hl'*
4113'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004114 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4115 d:Directory,e:ErrorMsg,i:IncSearch,
4116 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004117 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004118 N:CursorLineNr,r:Question,s:StatusLine,
4119 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004120 v:Visual,V:VisualNOS,w:WarningMsg,
4121 W:WildMenu,f:Folded,F:FoldColumn,
4122 A:DiffAdd,C:DiffChange,D:DiffDelete,
4123 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004124 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004125 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004126 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4127 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004128 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004129 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 This option can be used to set highlighting mode for various
4132 occasions. It is a comma separated list of character pairs. The
4133 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004134 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004136 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4137 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 characters from 'showbreak'
4139 |hl-Directory| d directories in CTRL-D listing and other special
4140 things in listings
4141 |hl-ErrorMsg| e error messages
4142 h (obsolete, ignored)
4143 |hl-IncSearch| i 'incsearch' highlighting
4144 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4145 |hl-MoreMsg| m |more-prompt|
4146 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004147 |hl-LineNr| n line number for ":number" and ":#" commands, and
4148 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004149 |hl-LineNrAbove| a line number above the cursor for when the
4150 'relativenumber' option is set.
4151 |hl-LineNrBelow| b line number below the cursor for when the
4152 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004153 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4154 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 |hl-Question| r |hit-enter| prompt and yes/no questions
4156 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004157 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4159 |hl-VertSplit| c column used to separate vertically split windows
4160 |hl-Visual| v Visual mode
4161 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4162 Selection" Only X11 Gui's |gui-x11| and
4163 |xterm-clipboard|.
4164 |hl-WarningMsg| w warning messages
4165 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4166 |hl-Folded| f line used for closed folds
4167 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004168 |hl-DiffAdd| A added line in diff mode
4169 |hl-DiffChange| C changed line in diff mode
4170 |hl-DiffDelete| D deleted line in diff mode
4171 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004173 |hl-Conceal| - the placeholders used for concealed characters
4174 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004175 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004176 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004177 |hl-SpellRare| R rare word |spell|
4178 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004179 |hl-Pmenu| + popup menu normal line
4180 |hl-PmenuSel| = popup menu selected line
4181 |hl-PmenuSbar| x popup menu scrollbar
4182 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183
4184 The display modes are:
4185 r reverse (termcap entry "mr" and "me")
4186 i italic (termcap entry "ZH" and "ZR")
4187 b bold (termcap entry "md" and "me")
4188 s standout (termcap entry "so" and "se")
4189 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004190 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004191 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 n no highlighting
4193 - no highlighting
4194 : use a highlight group
4195 The default is used for occasions that are not included.
4196 If you want to change what the display modes do, see |dos-colors|
4197 for an example.
4198 When using the ':' display mode, this must be followed by the name of
4199 a highlight group. A highlight group can be used to define any type
4200 of highlighting, including using color. See |:highlight| on how to
4201 define one. The default uses a different group for each occasion.
4202 See |highlight-default| for the default highlight groups.
4203
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004205'history' 'hi' number (Vim default: 50, Vi default: 0,
4206 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004209 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004211 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 NOTE: This option is set to the Vi default value when 'compatible' is
4213 set and to the Vim default value when 'compatible' is reset.
4214
4215 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4216'hkmap' 'hk' 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, the keyboard is mapped for the Hebrew character set.
4221 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4222 toggle this option. See |rileft.txt|.
4223 NOTE: This option is reset when 'compatible' is set.
4224
4225 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4226'hkmapp' 'hkp' boolean (default off)
4227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 {only available when compiled with the |+rightleft|
4229 feature}
4230 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4231 This is useful if you have a non-Hebrew keyboard.
4232 See |rileft.txt|.
4233 NOTE: This option is reset when 'compatible' is set.
4234
Bram Moolenaar036986f2017-03-16 17:41:02 +01004235 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4236'hlsearch' 'hls' boolean (default off)
4237 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004238 {not available when compiled without the
4239 |+extra_search| feature}
4240 When there is a previous search pattern, highlight all its matches.
4241 The type of highlighting used can be set with the 'l' occasion in the
4242 'highlight' option. This uses the "Search" highlight group by
4243 default. Note that only the matching text is highlighted, any offsets
4244 are not applied.
4245 See also: 'incsearch' and |:match|.
4246 When you get bored looking at the highlighted matches, you can turn it
4247 off with |:nohlsearch|. This does not change the option value, as
4248 soon as you use a search command, the highlighting comes back.
4249 'redrawtime' specifies the maximum time spent on finding matches.
4250 When the search pattern can match an end-of-line, Vim will try to
4251 highlight all of the matched text. However, this depends on where the
4252 search starts. This will be the first line in the window or the first
4253 line below a closed fold. A match in a previous line which is not
4254 drawn may not continue in a newly drawn line.
4255 You can specify whether the highlight status is restored on startup
4256 with the 'h' flag in 'viminfo' |viminfo-h|.
4257 NOTE: This option is reset when 'compatible' is set.
4258
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 *'icon'* *'noicon'*
4260'icon' boolean (default off, on when title can be restored)
4261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 When on, the icon text of the window will be set to the value of
4263 'iconstring' (if it is not empty), or to the name of the file
4264 currently being edited. Only the last part of the name is used.
4265 Overridden by the 'iconstring' option.
4266 Only works if the terminal supports setting window icons (currently
4267 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4268 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4269 builtin termcap).
4270 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004271 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004273 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274
4275 *'iconstring'*
4276'iconstring' string (default "")
4277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 When this option is not empty, it will be used for the icon text of
4279 the window. This happens only when the 'icon' option is on.
4280 Only works if the terminal supports setting window icon text
4281 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004282 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 When Vim was compiled with HAVE_X11 defined, the original icon will be
4284 restored if possible |X11|.
4285 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004286 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004288 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 {not available when compiled without the |+statusline| feature}
4290
4291 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4292'ignorecase' 'ic' boolean (default off)
4293 global
4294 Ignore case in search patterns. Also used when searching in the tags
4295 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004296 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 Can be overruled by using "\c" or "\C" in the pattern, see
4298 |/ignorecase|.
4299
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004300 *'imactivatefunc'* *'imaf'*
4301'imactivatefunc' 'imaf' string (default "")
4302 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004303 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004304 activate or deactivate the Input Method. The value can be the name of
4305 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4306 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004307 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004308 The expression will be evaluated in the |sandbox| when set from a
4309 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004310
4311 Example: >
4312 function ImActivateFunc(active)
4313 if a:active
4314 ... do something
4315 else
4316 ... do something
4317 endif
4318 " return value is not used
4319 endfunction
4320 set imactivatefunc=ImActivateFunc
4321<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 *'imactivatekey'* *'imak'*
4323'imactivatekey' 'imak' string (default "")
4324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004326 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 Specifies the key that your Input Method in X-Windows uses for
4328 activation. When this is specified correctly, vim can fully control
4329 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4330 You can't use this option to change the activation key, the option
4331 tells Vim what the key is.
4332 Format:
4333 [MODIFIER_FLAG-]KEY_STRING
4334
4335 These characters can be used for MODIFIER_FLAG (case is ignored):
4336 S Shift key
4337 L Lock key
4338 C Control key
4339 1 Mod1 key
4340 2 Mod2 key
4341 3 Mod3 key
4342 4 Mod4 key
4343 5 Mod5 key
4344 Combinations are allowed, for example "S-C-space" or "SC-space" are
4345 both shift+ctrl+space.
4346 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4347
4348 Example: >
4349 :set imactivatekey=S-space
4350< "S-space" means shift+space. This is the activation key for kinput2 +
4351 canna (Japanese), and ami (Korean).
4352
4353 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4354'imcmdline' 'imc' boolean (default off)
4355 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 When set the Input Method is always on when starting to edit a command
4357 line, unless entering a search pattern (see 'imsearch' for that).
4358 Setting this option is useful when your input method allows entering
4359 English characters directly, e.g., when it's used to type accented
4360 characters with dead keys.
4361
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004362 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 When set the Input Method is never used. This is useful to disable
4366 the IM when it doesn't work properly.
4367 Currently this option is on by default for SGI/IRIX machines. This
4368 may change in later releases.
4369
4370 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004371'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 Specifies whether :lmap or an Input Method (IM) is to be used in
4374 Insert mode. Valid values:
4375 0 :lmap is off and IM is off
4376 1 :lmap is ON and IM is off
4377 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 To always reset the option to zero when leaving Insert mode with <Esc>
4379 this can be used: >
4380 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4381< This makes :lmap and IM turn off automatically when leaving Insert
4382 mode.
4383 Note that this option changes when using CTRL-^ in Insert mode
4384 |i_CTRL-^|.
4385 The value is set to 1 when setting 'keymap' to a valid keymap name.
4386 It is also used for the argument of commands like "r" and "f".
4387 The value 0 may not work correctly with Athena and Motif with some XIM
4388 methods. Use 'imdisable' to disable XIM then.
4389
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004390 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004391 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004392 |+multi_byte_ime| or |global-ime|.
4393
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004395'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 Specifies whether :lmap or an Input Method (IM) is to be used when
4398 entering a search pattern. Valid values:
4399 -1 the value of 'iminsert' is used, makes it look like
4400 'iminsert' is also used when typing a search pattern
4401 0 :lmap is off and IM is off
4402 1 :lmap is ON and IM is off
4403 2 :lmap is off and IM is ON
4404 Note that this option changes when using CTRL-^ in Command-line mode
4405 |c_CTRL-^|.
4406 The value is set to 1 when it is not -1 and setting the 'keymap'
4407 option to a valid keymap name.
4408 The value 0 may not work correctly with Athena and Motif with some XIM
4409 methods. Use 'imdisable' to disable XIM then.
4410
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004411 *'imstatusfunc'* *'imsf'*
4412'imstatusfunc' 'imsf' string (default "")
4413 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004414 This option specifies a function that is called to obtain the status
4415 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004416 The value can be the name of a function, a |lambda| or a |Funcref|.
4417 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004418 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004419
4420 Example: >
4421 function ImStatusFunc()
4422 let is_active = ...do something
4423 return is_active ? 1 : 0
4424 endfunction
4425 set imstatusfunc=ImStatusFunc
4426<
4427 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004428 The expression will be evaluated in the |sandbox| when set from a
4429 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004430
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004431 *'imstyle'* *'imst'*
4432'imstyle' 'imst' number (default 1)
4433 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004434 {only available when compiled with |+xim| and
4435 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004436 This option specifies the input style of Input Method:
4437 0 use on-the-spot style
4438 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004439 See: |xim-input-style|
4440
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004441 For a long time on-the-spot style had been used in the GTK version of
4442 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004443 |single-repeat|, etc. Therefore over-the-spot style becomes the
4444 default now. This should work fine for most people, however if you
4445 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004446 The expression will be evaluated in the |sandbox| when set from a
4447 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004448
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 *'include'* *'inc'*
4450'include' 'inc' string (default "^\s*#\s*include")
4451 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 {not available when compiled without the
4453 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004454 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 pattern, just like for the "/" command (See |pattern|). The default
4456 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004457 "]I", "[d", etc.
4458 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004459 comes after the matched pattern. But if "\zs" appears in the pattern
4460 then the text matched from "\zs" to the end, or until "\ze" if it
4461 appears, is used as the file name. Use this to include characters
4462 that are not in 'isfname', such as a space. You can then use
4463 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004464 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465
4466 *'includeexpr'* *'inex'*
4467'includeexpr' 'inex' string (default "")
4468 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004470 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004472 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 :set includeexpr=substitute(v:fname,'\\.','/','g')
4474< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004475
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004477 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 Also used for |<cfile>|.
4479
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004480 If the expression starts with s: or |<SID>|, then it is replaced with
4481 the script ID (|local-function|). Example: >
4482 set includeexpr=s:MyIncludeExpr(v:fname)
4483 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004484< Otherwise, the expression is evaluated in the context of the script
4485 where the option was set, thus script-local items are available.
4486
Bram Moolenaar30b65812012-07-12 22:01:11 +02004487 The expression will be evaluated in the |sandbox| when set from a
4488 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004489 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004490
4491 It is not allowed to change text or jump to another window while
4492 evaluating 'includeexpr' |textlock|.
4493
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004495'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4496 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004499 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004500 While typing a search command, show where the pattern, as it was typed
4501 so far, matches. The matched string is highlighted. If the pattern
4502 is invalid or not found, nothing is shown. The screen will be updated
4503 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004504 Also applies to the pattern in commands: >
4505 :global
4506 :lvimgrep
4507 :lvimgrepadd
4508 :smagic
4509 :snomagic
4510 :sort
4511 :substitute
4512 :vglobal
4513 :vimgrep
4514 :vimgrepadd
4515< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004516 original position when no match is found and when pressing <Esc>. You
4517 still need to finish the search command with <Enter> to move the
4518 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004519 You can use the CTRL-G and CTRL-T keys to move to the next and
4520 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004521 When compiled with the |+reltime| feature Vim only searches for about
4522 half a second. With a complicated pattern and/or a lot of text the
4523 match may not be found. This is to avoid that Vim hangs while you
4524 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004525 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004526 When 'hlsearch' is on, all matched strings are highlighted too while
4527 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004528 If you don't want to turn 'hlsearch' on, but want to highlight all
4529 matches while searching, you can turn on and off 'hlsearch' with
4530 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004531 augroup vimrc-incsearch-highlight
4532 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004533 autocmd CmdlineEnter /,\? :set hlsearch
4534 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004535 augroup END
4536<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004537 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004538 to the command line. If 'ignorecase' and 'smartcase' are set and the
4539 command line has no uppercase characters, the added character is
4540 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004541 CTRL-R CTRL-W can be used to add the word at the end of the current
4542 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 NOTE: This option is reset when 'compatible' is set.
4544
4545 *'indentexpr'* *'inde'*
4546'indentexpr' 'inde' string (default "")
4547 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 {not available when compiled without the |+cindent|
4549 or |+eval| features}
4550 Expression which is evaluated to obtain the proper indent for a line.
4551 It is used when a new line is created, for the |=| operator and
4552 in Insert mode as specified with the 'indentkeys' option.
4553 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004554 'smartindent' indenting. When 'lisp' is set, this option is
4555 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 When 'paste' is set this option is not used for indenting.
4557 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004558 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004560
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004561 If the expression starts with s: or |<SID>|, then it is replaced with
4562 the script ID (|local-function|). Example: >
4563 set indentexpr=s:MyIndentExpr()
4564 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004565< Otherwise, the expression is evaluated in the context of the script
4566 where the option was set, thus script-local items are available.
4567
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 The expression must return the number of spaces worth of indent. It
4569 can return "-1" to keep the current indent (this means 'autoindent' is
4570 used for the indent).
4571 Functions useful for computing the indent are |indent()|, |cindent()|
4572 and |lispindent()|.
4573 The evaluation of the expression must not have side effects! It must
4574 not change the text, jump to another window, etc. Afterwards the
4575 cursor position is always restored, thus the cursor may be moved.
4576 Normally this option would be set to call a function: >
4577 :set indentexpr=GetMyIndent()
4578< Error messages will be suppressed, unless the 'debug' option contains
4579 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004580 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004581 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582
Bram Moolenaar30b65812012-07-12 22:01:11 +02004583 The expression will be evaluated in the |sandbox| when set from a
4584 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004585 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004586
4587 It is not allowed to change text or jump to another window while
4588 evaluating 'indentexpr' |textlock|.
4589
4590
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004592'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 {not available when compiled without the |+cindent|
4595 feature}
4596 A list of keys that, when typed in Insert mode, cause reindenting of
4597 the current line. Only happens if 'indentexpr' isn't empty.
4598 The format is identical to 'cinkeys', see |indentkeys-format|.
4599 See |C-indenting| and |indent-expression|.
4600
4601 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4602'infercase' 'inf' boolean (default off)
4603 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004605 'ignorecase' is also on, the case of the match is adjusted depending
4606 on the typed text. If the typed text contains a lowercase letter
4607 where the match has an upper case letter, the completed part is made
4608 lowercase. If the typed text has no lowercase letters and the match
4609 has a lowercase letter where the typed text has an uppercase letter,
4610 and there is a letter before it, the completed part is made uppercase.
4611 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612
4613 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4614'insertmode' 'im' boolean (default off)
4615 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 Makes Vim work in a way that Insert mode is the default mode. Useful
4617 if you want to use Vim as a modeless editor. Used for |evim|.
4618 These Insert mode commands will be useful:
4619 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004620 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 this is a mapping, it is executed as if 'insertmode' was off.
4622 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004624 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4625 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626
4627 These items change when 'insertmode' is set:
4628 - when starting to edit of a file, Vim goes to Insert mode.
4629 - <Esc> in Insert mode is a no-op and beeps.
4630 - <Esc> in Normal mode makes Vim go to Insert mode.
4631 - CTRL-L in Insert mode is a command, it is not inserted.
4632 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4633 However, when <Esc> is used inside a mapping, it behaves like
4634 'insertmode' was not set. This was done to be able to use the same
4635 mappings with 'insertmode' set or not set.
4636 When executing commands with |:normal| 'insertmode' is not used.
4637
4638 NOTE: This option is reset when 'compatible' is set.
4639
4640 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004641'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4643 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4644 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4645 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4646 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 The characters specified by this option are included in file names and
4649 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004650 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 Multi-byte characters 256 and above are always included, only the
4652 characters up to 255 are specified with this option.
4653 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004654 Think twice before adding white space to this option. Although a
4655 space may appear inside a file name, the effect will be that Vim
4656 doesn't know where a file name starts or ends when doing completion.
4657 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658
4659 Note that on systems using a backslash as path separator, Vim tries to
4660 do its best to make it work as you would expect. That is a bit
4661 tricky, since Vi originally used the backslash to escape special
4662 characters. Vim will not remove a backslash in front of a normal file
4663 name character on these systems, but it will on Unix and alikes. The
4664 '&' and '^' are not included by default, because these are special for
4665 cmd.exe.
4666
4667 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004668 Each part can be a single character number or a range. A range is two
4669 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 decimal number between 0 and 255 or the ASCII character itself (does
4671 not work for digits). Example:
4672 "_,-,128-140,#-43" (include '_' and '-' and the range
4673 128 to 140 and '#' to 43)
4674 If a part starts with '^', the following character number or range
4675 will be excluded from the option. The option is interpreted from left
4676 to right. Put the excluded character after the range where it is
4677 included. To include '^' itself use it as the last character of the
4678 option or the end of a range. Example:
4679 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4680 If the character is '@', all characters where isalpha() returns TRUE
4681 are included. Normally these are the characters a to z and A to Z,
4682 plus accented characters. To include '@' itself use "@-@". Examples:
4683 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004684 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 "a-z,A-Z,@-@" All letters plus the '@' character.
4686 A comma can be included by using it where a character number is
4687 expected. Example:
4688 "48-57,,,_" Digits, comma and underscore.
4689 A comma can be excluded by prepending a '^'. Example:
4690 " -~,^,,9" All characters from space to '~', excluding
4691 comma, plus <Tab>.
4692 See |option-backslash| about including spaces and backslashes.
4693
4694 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004695'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 "@,48-57,_,128-167,224-235"
4697 otherwise: "@,48-57,_,192-255")
4698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 The characters given by this option are included in identifiers.
4700 Identifiers are used in recognizing environment variables and after a
4701 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004702 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004703 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004705 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4707
4708 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004709'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 "@,48-57,_,128-167,224-235"
4711 otherwise: "@,48-57,_,192-255"
4712 Vi default: "@,48-57,_")
4713 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004715 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004716 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004717 characters above 255 check the "word" character class (any character
4718 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004719 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 For a help file it is set to all non-blank printable characters except
4721 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4722 command).
4723 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004724 This option also influences syntax highlighting, unless the syntax
4725 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 NOTE: This option is set to the Vi default value when 'compatible' is
4727 set and to the Vim default value when 'compatible' is reset.
4728
4729 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004730'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 "@,~-255"; otherwise: "@,161-255")
4732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 The characters given by this option are displayed directly on the
4734 screen. It is also used for "\p" in a |pattern|. The characters from
4735 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4736 even when they are not included in 'isprint' or excluded. See
4737 'isfname' for a description of the format of this option.
4738
4739 Non-printable characters are displayed with two characters:
4740 0 - 31 "^@" - "^_"
4741 32 - 126 always single characters
4742 127 "^?"
4743 128 - 159 "~@" - "~_"
4744 160 - 254 "| " - "|~"
4745 255 "~?"
4746 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4747 displayed as <xx>, with the hexadecimal value of the byte.
4748 When 'display' contains "uhex" all unprintable characters are
4749 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004750 The SpecialKey highlighting will be used for unprintable characters.
4751 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752
4753 Multi-byte characters 256 and above are always included, only the
4754 characters up to 255 are specified with this option. When a character
4755 is printable but it is not available in the current font, a
4756 replacement character will be shown.
4757 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4758 There is no option to specify these characters.
4759
4760 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4761'joinspaces' 'js' boolean (default on)
4762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 Insert two spaces after a '.', '?' and '!' with a join command.
4764 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4765 Otherwise only one space is inserted.
4766 NOTE: This option is set when 'compatible' is set.
4767
4768 *'key'*
4769'key' string (default "")
4770 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004771 {only available when compiled with the |+cryptv|
4772 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004774 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 Careful: Do not set the key value by hand, someone might see the typed
4776 key. Use the |:X| command. But you can make 'key' empty: >
4777 :set key=
4778< It is not possible to get the value of this option with ":set key" or
4779 "echo &key". This is to avoid showing it to someone who shouldn't
4780 know. It also means you cannot see it yourself once you have set it,
4781 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004782 You can use "&key" in an expression to detect whether encryption is
4783 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784
4785 *'keymap'* *'kmp'* *E544*
4786'keymap' 'kmp' string (default "")
4787 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 {only available when compiled with the |+keymap|
4789 feature}
4790 Name of a keyboard mapping. See |mbyte-keymap|.
4791 Setting this option to a valid keymap name has the side effect of
4792 setting 'iminsert' to one, so that the keymap becomes effective.
4793 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004794 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795
4796 *'keymodel'* *'km'*
4797'keymodel' 'km' string (default "")
4798 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 List of comma separated words, which enable special things that keys
4800 can do. These values can be used:
4801 startsel Using a shifted special key starts selection (either
4802 Select mode or Visual mode, depending on "key" being
4803 present in 'selectmode').
4804 stopsel Using a not-shifted special key stops selection.
4805 Special keys in this context are the cursor keys, <End>, <Home>,
4806 <PageUp> and <PageDown>.
4807 The 'keymodel' option is set by the |:behave| command.
4808
4809 *'keywordprg'* *'kp'*
4810'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004811 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 Program to use for the |K| command. Environment variables are
4814 expanded |:set_env|. ":help" may be used to access the Vim internal
4815 help. (Note that previously setting the global option to the empty
4816 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004817 When the first character is ":", the command is invoked as a Vim
4818 Ex command prefixed with [count].
4819 When "man", "man -s" or an Ex command is used, Vim will automatically
4820 translate a count for the "K" command and pass it as the first
4821 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 See |option-backslash| about including spaces and backslashes.
4823 Example: >
4824 :set keywordprg=man\ -s
4825< This option cannot be set from a |modeline| or in the |sandbox|, for
4826 security reasons.
4827
4828 *'langmap'* *'lmap'* *E357* *E358*
4829'langmap' 'lmap' string (default "")
4830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 {only available when compiled with the |+langmap|
4832 feature}
4833 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004834 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004835 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 care of translating these special characters to the original meaning
4837 of the key. This means you don't have to change the keyboard mode to
4838 be able to execute Normal mode commands.
4839 This is the opposite of the 'keymap' option, where characters are
4840 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004841 Also consider setting 'langremap' to off, to prevent 'langmap' from
4842 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004843 This option cannot be set from a |modeline| or in the |sandbox|, for
4844 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004846 Example (for Greek, in UTF-8): *greek* >
4847 :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 +00004848< Example (exchanges meaning of z and y for commands): >
4849 :set langmap=zy,yz,ZY,YZ
4850<
4851 The 'langmap' option is a list of parts, separated with commas. Each
4852 part can be in one of two forms:
4853 1. A list of pairs. Each pair is a "from" character immediately
4854 followed by the "to" character. Examples: "aA", "aAbBcC".
4855 2. A list of "from" characters, a semi-colon and a list of "to"
4856 characters. Example: "abc;ABC"
4857 Example: "aA,fgh;FGH,cCdDeE"
4858 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004859 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860
4861 This will allow you to activate vim actions without having to switch
4862 back and forth between the languages. Your language characters will
4863 be understood as normal vim English characters (according to the
4864 langmap mappings) in the following cases:
4865 o Normal/Visual mode (commands, buffer/register names, user mappings)
4866 o Insert/Replace Mode: Register names after CTRL-R
4867 o Insert/Replace Mode: Mappings
4868 Characters entered in Command-line mode will NOT be affected by
4869 this option. Note that this option can be changed at any time
4870 allowing to switch between mappings for different languages/encodings.
4871 Use a mapping to avoid having to type it each time!
4872
4873 *'langmenu'* *'lm'*
4874'langmenu' 'lm' string (default "")
4875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 {only available when compiled with the |+menu| and
4877 |+multi_lang| features}
4878 Language to use for menu translation. Tells which file is loaded
4879 from the "lang" directory in 'runtimepath': >
4880 "lang/menu_" . &langmenu . ".vim"
4881< (without the spaces). For example, to always use the Dutch menus, no
4882 matter what $LANG is set to: >
4883 :set langmenu=nl_NL.ISO_8859-1
4884< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004885 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 If your $LANG is set to a non-English language but you do want to use
4887 the English menus: >
4888 :set langmenu=none
4889< This option must be set before loading menus, switching on filetype
4890 detection or syntax highlighting. Once the menus are defined setting
4891 this option has no effect. But you could do this: >
4892 :source $VIMRUNTIME/delmenu.vim
4893 :set langmenu=de_DE.ISO_8859-1
4894 :source $VIMRUNTIME/menu.vim
4895< Warning: This deletes all menus that you defined yourself!
4896
Bram Moolenaard94464e2015-11-02 15:28:18 +01004897 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004898'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004899 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004900 {only available when compiled with the |+langmap|
4901 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004902 This is just like 'langremap' but with the value inverted. It only
4903 exists for backwards compatibility. When setting 'langremap' then
4904 'langnoremap' is set to the inverted value, and the other way around.
4905
4906 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004907'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004908 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004909 {only available when compiled with the |+langmap|
4910 feature}
4911 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004912 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004913 'langmap' disables some of your mappings, try resetting this option.
4914 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004915 that works for you to avoid mappings to break.
4916
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 *'laststatus'* *'ls'*
4918'laststatus' 'ls' number (default 1)
4919 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 The value of this option influences when the last window will have a
4921 status line:
4922 0: never
4923 1: only if there are at least two windows
4924 2: always
4925 The screen looks nicer with a status line if you have several
4926 windows, but it takes another screen line. |status-line|
4927
4928 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4929'lazyredraw' 'lz' boolean (default off)
4930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 When this option is set, the screen will not be redrawn while
4932 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004933 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 update use |:redraw|.
4935
4936 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4937'linebreak' 'lbr' boolean (default off)
4938 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004939 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004941 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 than at the last character that fits on the screen. Unlike
4943 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004944 it only affects the way the file is displayed, not its contents.
4945 If 'breakindent' is set, line is visually indented. Then, the value
4946 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004947 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 Note that <Tab> characters after an <EOL> are mostly not displayed
4949 with the right amount of white space.
4950
4951 *'lines'* *E593*
4952'lines' number (default 24 or terminal height)
4953 global
4954 Number of lines of the Vim window.
4955 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004956 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 When Vim is running in the GUI or in a resizable window, setting this
4958 option will cause the window size to be changed. When you only want
4959 to use the size for the GUI, put the command in your |gvimrc| file.
4960 Vim limits the number of lines to what fits on the screen. You can
4961 use this command to get the tallest window possible: >
4962 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004963< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004964 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 When you set this option and Vim is unable to change the physical
4966 number of lines of the display, the display may be messed up.
4967
4968 *'linespace'* *'lsp'*
4969'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4970 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 {only in the GUI}
4972 Number of pixel lines inserted between characters. Useful if the font
4973 uses the full character cell height, making lines touch each other.
4974 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004975 With some fonts there can be too much room between lines (to have
4976 space for ascents and descents). Then it makes sense to set
4977 'linespace' to a negative value. This may cause display problems
4978 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979
4980 *'lisp'* *'nolisp'*
4981'lisp' boolean (default off)
4982 local to buffer
4983 {not available when compiled without the |+lispindent|
4984 feature}
4985 Lisp mode: When <Enter> is typed in insert mode set the indent for
4986 the next line to Lisp standards (well, sort of). Also happens with
4987 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4988 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4989 better. Also see 'lispwords'.
4990 The '-' character is included in keyword characters. Redefines the
4991 "=" operator to use this same indentation algorithm rather than
4992 calling an external program if 'equalprg' is empty.
4993 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994
4995 *'lispwords'* *'lw'*
4996'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004997 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 {not available when compiled without the |+lispindent|
4999 feature}
5000 Comma separated list of words that influence the Lisp indenting.
5001 |'lisp'|
5002
5003 *'list'* *'nolist'*
5004'list' boolean (default off)
5005 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005006 List mode: By default show tabs as CTRL-I is displayed, display $
5007 after end of line. Useful to see the difference between tabs and
5008 spaces and for trailing blanks. Further changed by the 'listchars'
5009 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005010
5011 The cursor is displayed at the start of the space a Tab character
5012 occupies, not at the end as usual in Normal mode. To get this cursor
5013 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005014 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005015<
5016 Note that list mode will also affect formatting (set with 'textwidth'
5017 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 changing the way tabs are displayed.
5019
5020 *'listchars'* *'lcs'*
5021'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005022 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005023 Strings to use in 'list' mode and for the |:list| command. It is a
5024 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005025 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 eol:c Character to show at the end of each line. When
5027 omitted, there is no extra character at the end of the
5028 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005029 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005030 tab:xy[z] Two or three characters to be used to show a tab.
5031 The third character is optional.
5032
5033 tab:xy The 'x' is always used, then 'y' as many times as will
5034 fit. Thus "tab:>-" displays:
5035 >
5036 >-
5037 >--
5038 etc.
5039
5040 tab:xyz The 'z' is always used, then 'x' is prepended, and
5041 then 'y' is used as many times as will fit. Thus
5042 "tab:<->" displays:
5043 >
5044 <>
5045 <->
5046 <-->
5047 etc.
5048
5049 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005050 *lcs-space*
5051 space:c Character to show for a space. When omitted, spaces
5052 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005053 *lcs-multispace*
5054 multispace:c...
5055 One or more characters to use cyclically to show for
5056 multiple consecutive spaces. Overrides the "space"
5057 setting, except for single spaces. When omitted, the
5058 "space" setting is used. For example,
5059 `:set listchars=multispace:---+` shows ten consecutive
5060 spaces as:
5061 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005062 *lcs-lead*
5063 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005064 leading spaces are blank. Overrides the "space" and
5065 "multispace" settings for leading spaces. You can
5066 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005067 :set listchars+=tab:>-,lead:.
5068< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005069 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005070 trailing spaces are blank. Overrides the "space" and
5071 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005072 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 extends:c Character to show in the last column, when 'wrap' is
5074 off and the line continues beyond the right of the
5075 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005076 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005077 precedes:c Character to show in the first visible column of the
5078 physical line, when there is text preceding the
5079 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005080 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005081 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005082 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005083 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005084 nbsp:c Character to show for a non-breakable space character
5085 (0xA0 (160 decimal) and U+202F). Left blank when
5086 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005088 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005090 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005092 Each character can be specified as hex: >
5093 set listchars=eol:\\x24
5094 set listchars=eol:\\u21b5
5095 set listchars=eol:\\U000021b5
5096< Note that a double backslash is used. The number of hex characters
5097 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5098
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 Examples: >
5100 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005101 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 :set lcs=extends:>,precedes:<
5103< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005104 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5105 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005106 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107
5108 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5109'loadplugins' 'lpl' boolean (default on)
5110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 When on the plugin scripts are loaded when starting up |load-plugins|.
5112 This option can be reset in your |vimrc| file to disable the loading
5113 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005114 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5115 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116
Bram Moolenaard94464e2015-11-02 15:28:18 +01005117 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005118'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005119 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005120 {only available when compiled with the |+lua/dyn|
5121 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005122 Specifies the name of the Lua shared library. The default is
5123 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005124 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005125 This option cannot be set from a |modeline| or in the |sandbox|, for
5126 security reasons.
5127
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005128 *'macatsui'* *'nomacatsui'*
5129'macatsui' boolean (default on)
5130 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005131 {not supported}
5132 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005133
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 *'magic'* *'nomagic'*
5135'magic' boolean (default on)
5136 global
5137 Changes the special characters that can be used in search patterns.
5138 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005139 WARNING: Switching this option off most likely breaks plugins! That
5140 is because many patterns assume it's on and will fail when it's off.
5141 Only switch it off when working with old Vi scripts. In any other
5142 situation write patterns that work when 'magic' is on. Include "\M"
5143 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005144 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5145 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146
5147 *'makeef'* *'mef'*
5148'makeef' 'mef' string (default: "")
5149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150 {not available when compiled without the |+quickfix|
5151 feature}
5152 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5153 and the |:grep| command.
5154 When it is empty, an internally generated temp file will be used.
5155 When "##" is included, it is replaced by a number to make the name
5156 unique. This makes sure that the ":make" command doesn't overwrite an
5157 existing file.
5158 NOT used for the ":cf" command. See 'errorfile' for that.
5159 Environment variables are expanded |:set_env|.
5160 See |option-backslash| about including spaces and backslashes.
5161 This option cannot be set from a |modeline| or in the |sandbox|, for
5162 security reasons.
5163
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005164 *'makeencoding'* *'menc'*
5165'makeencoding' 'menc' string (default "")
5166 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005167 Encoding used for reading the output of external commands. When empty,
5168 encoding is not converted.
5169 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5170 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5171 and `:laddfile`.
5172
5173 This would be mostly useful when you use MS-Windows and set 'encoding'
5174 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5175 'makeencoding' to "char" has the same effect as setting to the system
5176 locale encoding. Example: >
5177 :set encoding=utf-8
5178 :set makeencoding=char " system locale is used
5179<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 *'makeprg'* *'mp'*
5181'makeprg' 'mp' string (default "make", VMS: "MMS")
5182 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005183 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005184 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5185 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005186 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005187 Environment variables are expanded |:set_env|. See |option-backslash|
5188 about including spaces and backslashes.
5189 Note that a '|' must be escaped twice: once for ":set" and once for
5190 the interpretation of a command. When you use a filter called
5191 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 :set makeprg=gmake\ \\\|\ myfilter
5193< The placeholder "$*" can be given (even multiple times) to specify
5194 where the arguments will be included, for example: >
5195 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5196< This option cannot be set from a |modeline| or in the |sandbox|, for
5197 security reasons.
5198
5199 *'matchpairs'* *'mps'*
5200'matchpairs' 'mps' string (default "(:),{:},[:]")
5201 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005203 other.
5204 Only character pairs are allowed that are different, thus you cannot
5205 jump between two double quotes.
5206 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005207 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005208 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 :set mps+=<:>
5210
5211< A more exotic example, to jump between the '=' and ';' in an
5212 assignment, useful for languages like C and Java: >
5213 :au FileType c,cpp,java set mps+==:;
5214
5215< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005216 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217
5218 *'matchtime'* *'mat'*
5219'matchtime' 'mat' number (default 5)
5220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 Tenths of a second to show the matching paren, when 'showmatch' is
5222 set. Note that this is not in milliseconds, like other options that
5223 set a time. This is to be compatible with Nvi.
5224
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005225 *'maxcombine'* *'mco'*
5226'maxcombine' 'mco' number (default 2)
5227 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005228 The maximum number of combining characters supported for displaying.
5229 Only used when 'encoding' is "utf-8".
5230 The default is OK for most languages. Hebrew may require 4.
5231 Maximum value is 6.
5232 Even when this option is set to 2 you can still edit text with more
5233 combining characters, you just can't see them. Use |g8| or |ga|.
5234 See |mbyte-combining|.
5235
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 *'maxfuncdepth'* *'mfd'*
5237'maxfuncdepth' 'mfd' number (default 100)
5238 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005239 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005240 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 Maximum depth of function calls for user functions. This normally
5242 catches endless recursion. When using a recursive function with
5243 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5244 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005245 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005246 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 See also |:function|.
5248
5249 *'maxmapdepth'* *'mmd'* *E223*
5250'maxmapdepth' 'mmd' number (default 1000)
5251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 Maximum number of times a mapping is done without resulting in a
5253 character to be used. This normally catches endless mappings, like
5254 ":map x y" with ":map y x". It still does not catch ":map g wg",
5255 because the 'w' is used before the next mapping is done. See also
5256 |key-mapping|.
5257
5258 *'maxmem'* *'mm'*
5259'maxmem' 'mm' number (default between 256 to 5120 (system
5260 dependent) or half the amount of memory
5261 available)
5262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5264 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005265 other memory to be freed.
5266 The maximum usable value is about 2000000. Use this to work without a
5267 limit.
5268 The value is ignored when 'swapfile' is off.
5269 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005271 *'maxmempattern'* *'mmp'*
5272'maxmempattern' 'mmp' number (default 1000)
5273 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005274 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005275 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005276 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005277 When Vim runs into the limit it gives an error message and mostly
5278 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005279 Running into the limit often means that the pattern is very
5280 inefficient or too complex. This may already happen with the pattern
5281 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005282 Might also happen on redraw, when syntax rules try to match a complex
5283 text structure.
5284 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5285 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005286
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 *'maxmemtot'* *'mmt'*
5288'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5289 dependent) or half the amount of memory
5290 available)
5291 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005292 Maximum amount of memory in Kbyte to use for all buffers together.
5293 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005294 without a limit.
5295 On 64 bit machines higher values might work. But hey, do you really
5296 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005297 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005298 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005299 Buffers with 'swapfile' off still count to the total amount of memory
5300 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005301 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302
5303 *'menuitems'* *'mis'*
5304'menuitems' 'mis' number (default 25)
5305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 {not available when compiled without the |+menu|
5307 feature}
5308 Maximum number of items to use in a menu. Used for menus that are
5309 generated from a list of items, e.g., the Buffers menu. Changing this
5310 option has no direct effect, the menu must be refreshed first.
5311
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005312 *'mkspellmem'* *'msm'*
5313'mkspellmem' 'msm' string (default "460000,2000,500")
5314 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005315 {not available when compiled without the |+syntax|
5316 feature}
5317 Parameters for |:mkspell|. This tunes when to start compressing the
5318 word tree. Compression can be slow when there are many words, but
5319 it's needed to avoid running out of memory. The amount of memory used
5320 per word depends very much on how similar the words are, that's why
5321 this tuning is complicated.
5322
5323 There are three numbers, separated by commas:
5324 {start},{inc},{added}
5325
5326 For most languages the uncompressed word tree fits in memory. {start}
5327 gives the amount of memory in Kbyte that can be used before any
5328 compression is done. It should be a bit smaller than the amount of
5329 memory that is available to Vim.
5330
5331 When going over the {start} limit the {inc} number specifies the
5332 amount of memory in Kbyte that can be allocated before another
5333 compression is done. A low number means compression is done after
5334 less words are added, which is slow. A high number means more memory
5335 will be allocated.
5336
5337 After doing compression, {added} times 1024 words can be added before
5338 the {inc} limit is ignored and compression is done when any extra
5339 amount of memory is needed. A low number means there is a smaller
5340 chance of hitting the {inc} limit, less memory is used but it's
5341 slower.
5342
5343 The languages for which these numbers are important are Italian and
5344 Hungarian. The default works for when you have about 512 Mbyte. If
5345 you have 1 Gbyte you could use: >
5346 :set mkspellmem=900000,3000,800
5347< If you have less than 512 Mbyte |:mkspell| may fail for some
5348 languages, no matter what you set 'mkspellmem' to.
5349
Bram Moolenaar07607392019-05-26 19:20:43 +02005350 This option cannot be set from a |modeline| or in the |sandbox|.
5351
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005353'modeline' 'ml' boolean (Vim default: on (off for root),
5354 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005356 If 'modeline' is on 'modelines' gives the number of lines that is
5357 checked for set commands. If 'modeline' is off or 'modelines' is zero
5358 no lines are checked. See |modeline|.
5359
5360 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5361'modelineexpr' 'mle' boolean (default: off)
5362 global
5363 When on allow some options that are an expression to be set in the
5364 modeline. Check the option for whether it is affected by
5365 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005366 This option cannot be set from a |modeline| or in the |sandbox|, for
5367 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005368
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 *'modelines'* *'mls'*
5370'modelines' 'mls' number (default 5)
5371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 If 'modeline' is on 'modelines' gives the number of lines that is
5373 checked for set commands. If 'modeline' is off or 'modelines' is zero
5374 no lines are checked. See |modeline|.
5375 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5376 set and to the Vim default value when 'compatible' is reset.
5377
5378 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005379 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380'modifiable' 'ma' boolean (default on)
5381 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 When off the buffer contents cannot be changed. The 'fileformat' and
5383 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005384 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385
5386 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5387'modified' 'mod' boolean (default off)
5388 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 When on, the buffer is considered to be modified. This option is set
5390 when:
5391 1. A change was made to the text since it was last written. Using the
5392 |undo| command to go back to the original text will reset the
5393 option. But undoing changes that were made before writing the
5394 buffer will set the option again, since the text is different from
5395 when it was written.
5396 2. 'fileformat' or 'fileencoding' is different from its original
5397 value. The original value is set when the buffer is read or
5398 written. A ":set nomodified" command also resets the original
5399 values to the current values and the 'modified' option will be
5400 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005401 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005402 This option is not set when a change is made to the buffer as the
5403 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5404 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5405 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5407 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005408 Note that the text may actually be the same, e.g. 'modified' is set
5409 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410
5411 *'more'* *'nomore'*
5412'more' boolean (Vim default: on, Vi default: off)
5413 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 When on, listings pause when the whole screen is filled. You will get
5415 the |more-prompt|. When this option is off there are no pauses, the
5416 listing continues until finished.
5417 NOTE: This option is set to the Vi default value when 'compatible' is
5418 set and to the Vim default value when 'compatible' is reset.
5419
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005420 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005421'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005422 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005424 Enable the use of the mouse. Works for most terminals (xterm, Win32
5425 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5426 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5427 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005428 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 v Visual mode
5430 i Insert mode
5431 c Command-line mode
5432 h all previous modes when editing a help file
5433 a all previous modes
5434 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005435 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005437< If your terminal can't overrule the mouse events going to the
5438 application, use: >
5439 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005440< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005441 back to Vim using the mouse events.
5442 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5443 "xterm".
5444
5445 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 modeless selection. This doesn't move the text cursor.
5447
5448 See |mouse-using|. Also see |'clipboard'|.
5449
5450 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005451 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 the mouse buttons can still be used by keeping the shift key pressed.
5453 Also see the 'clipboard' option.
5454
5455 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5456'mousefocus' 'mousef' boolean (default off)
5457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005458 {only works in the GUI}
5459 The window that the mouse pointer is on is automatically activated.
5460 When changing the window layout or window focus in another way, the
5461 mouse pointer is moved to the window with keyboard focus. Off is the
5462 default because it makes using the pull down menus a little goofy, as
5463 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005464 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005465 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466
5467 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5468'mousehide' 'mh' boolean (default on)
5469 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 {only works in the GUI}
5471 When on, the mouse pointer is hidden when characters are typed.
5472 The mouse pointer is restored when the mouse is moved.
5473
5474 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005475'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 Sets the model to use for the mouse. The name mostly specifies what
5478 the right mouse button is used for:
5479 extend Right mouse button extends a selection. This works
5480 like in an xterm.
5481 popup Right mouse button pops up a menu. The shifted left
5482 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005483 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 popup_setpos Like "popup", but the cursor will be moved to the
5485 position where the mouse was clicked, and thus the
5486 selected operation will act upon the clicked object.
5487 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005488 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 course, that right clicking outside a selection will
5490 end Visual mode.
5491 Overview of what button does what for each model:
5492 mouse extend popup(_setpos) ~
5493 left click place cursor place cursor
5494 left drag start selection start selection
5495 shift-left search word extend selection
5496 right click extend selection popup menu (place cursor)
5497 right drag extend selection -
5498 middle click paste paste
5499
5500 In the "popup" model the right mouse button produces a pop-up menu.
5501 You need to define this first, see |popup-menu|.
5502
5503 Note that you can further refine the meaning of buttons with mappings.
5504 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5505 selection (because that's handled in the GUI code directly).
5506
5507 The 'mousemodel' option is set by the |:behave| command.
5508
5509 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005510'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5511 vs:leftright,vd:lrsizing,m:no,
5512 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 {only available when compiled with the |+mouseshape|
5515 feature}
5516 This option tells Vim what the mouse pointer should look like in
5517 different modes. The option is a comma separated list of parts, much
5518 like used for 'guicursor'. Each part consist of a mode/location-list
5519 and an argument-list:
5520 mode-list:shape,mode-list:shape,..
5521 The mode-list is a dash separated list of these modes/locations:
5522 In a normal window: ~
5523 n Normal mode
5524 v Visual mode
5525 ve Visual mode with 'selection' "exclusive" (same as 'v',
5526 if not specified)
5527 o Operator-pending mode
5528 i Insert mode
5529 r Replace mode
5530
5531 Others: ~
5532 c appending to the command-line
5533 ci inserting in the command-line
5534 cr replacing in the command-line
5535 m at the 'Hit ENTER' or 'More' prompts
5536 ml idem, but cursor in the last line
5537 e any mode, pointer below last window
5538 s any mode, pointer on a status line
5539 sd any mode, while dragging a status line
5540 vs any mode, pointer on a vertical separator line
5541 vd any mode, while dragging a vertical separator line
5542 a everywhere
5543
5544 The shape is one of the following:
5545 avail name looks like ~
5546 w x arrow Normal mouse pointer
5547 w x blank no pointer at all (use with care!)
5548 w x beam I-beam
5549 w x updown up-down sizing arrows
5550 w x leftright left-right sizing arrows
5551 w x busy The system's usual busy pointer
5552 w x no The system's usual 'no input' pointer
5553 x udsizing indicates up-down resizing
5554 x lrsizing indicates left-right resizing
5555 x crosshair like a big thin +
5556 x hand1 black hand
5557 x hand2 white hand
5558 x pencil what you write with
5559 x question big ?
5560 x rightup-arrow arrow pointing right-up
5561 w x up-arrow arrow pointing up
5562 x <number> any X11 pointer number (see X11/cursorfont.h)
5563
5564 The "avail" column contains a 'w' if the shape is available for Win32,
5565 x for X11.
5566 Any modes not specified or shapes not available use the normal mouse
5567 pointer.
5568
5569 Example: >
5570 :set mouseshape=s:udsizing,m:no
5571< will make the mouse turn to a sizing arrow over the status lines and
5572 indicate no input when the hit-enter prompt is displayed (since
5573 clicking the mouse has no effect in this state.)
5574
5575 *'mousetime'* *'mouset'*
5576'mousetime' 'mouset' number (default 500)
5577 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005578 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 time in msec between two mouse clicks for the second click to be
5580 recognized as a multi click.
5581
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005582 *'mzschemedll'*
5583'mzschemedll' string (default depends on the build)
5584 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005585 {only available when compiled with the |+mzscheme/dyn|
5586 feature}
5587 Specifies the name of the MzScheme shared library. The default is
5588 DYNAMIC_MZSCH_DLL which was specified at compile time.
5589 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005590 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005591 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005592 This option cannot be set from a |modeline| or in the |sandbox|, for
5593 security reasons.
5594
5595 *'mzschemegcdll'*
5596'mzschemegcdll' string (default depends on the build)
5597 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005598 {only available when compiled with the |+mzscheme/dyn|
5599 feature}
5600 Specifies the name of the MzScheme GC shared library. The default is
5601 DYNAMIC_MZGC_DLL which was specified at compile time.
5602 The value can be equal to 'mzschemedll' if it includes the GC code.
5603 Environment variables are expanded |:set_env|.
5604 This option cannot be set from a |modeline| or in the |sandbox|, for
5605 security reasons.
5606
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005607 *'mzquantum'* *'mzq'*
5608'mzquantum' 'mzq' number (default 100)
5609 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005610 {not available when compiled without the |+mzscheme|
5611 feature}
5612 The number of milliseconds between polls for MzScheme threads.
5613 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005614 NOTE: This option is set to the Vim default value when 'compatible'
5615 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005616
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005618'nrformats' 'nf' string (default "bin,octal,hex",
5619 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 This defines what bases Vim will consider for numbers when using the
5622 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5623 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005624 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005626 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005627 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005629 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 considered to be hexadecimal. Example: Using CTRL-X on
5631 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005632 bin If included, numbers starting with "0b" or "0B" will be
5633 considered to be binary. Example: Using CTRL-X on
5634 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005635 unsigned If included, numbers are recognized as unsigned. Thus a
5636 leading dash or negative sign won't be considered as part of
5637 the number. Examples:
5638 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5639 (without "unsigned" it would become "9-2021").
5640 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5641 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005642 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5643 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 Numbers which simply begin with a digit in the range 1-9 are always
5645 considered decimal. This also happens for numbers that are not
5646 recognized as octal or hex.
5647
5648 *'number'* *'nu'* *'nonumber'* *'nonu'*
5649'number' 'nu' boolean (default off)
5650 local to window
5651 Print the line number in front of each line. When the 'n' option is
5652 excluded from 'cpoptions' a wrapped line will not use the column of
5653 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005654 The 'numberwidth' option can be used to set the room used for the line
5655 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 When a long, wrapped line doesn't start with the first character, '-'
5657 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005658 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5659 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005660 *number_relativenumber*
5661 The 'relativenumber' option changes the displayed number to be
5662 relative to the cursor. Together with 'number' there are these
5663 four combinations (cursor in line 3):
5664
Bram Moolenaar3848e002016-03-19 18:42:29 +01005665 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005666 'nornu' 'nornu' 'rnu' 'rnu'
5667
5668 |apple | 1 apple | 2 apple | 2 apple
5669 |pear | 2 pear | 1 pear | 1 pear
5670 |nobody | 3 nobody | 0 nobody |3 nobody
5671 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005673 *'numberwidth'* *'nuw'*
5674'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5675 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005676 {only available when compiled with the |+linebreak|
5677 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005678 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005679 when the 'number' or 'relativenumber' option is set or printing lines
5680 with a line number. Since one space is always between the number and
5681 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005682 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005683 fit the highest line number in the buffer respectively the number of
5684 rows in the window, depending on whether 'number' or 'relativenumber'
5685 is set. Thus with the Vim default of 4 there is room for a line number
5686 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005687 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005688 NOTE: This option is set to the Vi default value when 'compatible' is
5689 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005690
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005691 *'omnifunc'* *'ofu'*
5692'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005693 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005694 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005695 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005696 This option specifies a function to be used for Insert mode omni
5697 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005698 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005699 invoked and what it should return. The value can be the name of a
5700 function, a |lambda| or a |Funcref|. See |option-value-function| for
5701 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005702 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005703 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005704 This option cannot be set from a |modeline| or in the |sandbox|, for
5705 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005706
5707
Bram Moolenaar02467872007-05-06 13:22:01 +00005708 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005709'opendevice' 'odev' boolean (default off)
5710 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005711 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005712 Enable reading and writing from devices. This may get Vim stuck on a
5713 device that can be opened but doesn't actually do the I/O. Therefore
5714 it is off by default.
5715 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5716 result in editing a device.
5717
5718
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005719 *'operatorfunc'* *'opfunc'*
5720'operatorfunc' 'opfunc' string (default: empty)
5721 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005722 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005723 See |:map-operator| for more info and an example. The value can be
5724 the name of a function, a |lambda| or a |Funcref|. See
5725 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005726
5727 This option cannot be set from a |modeline| or in the |sandbox|, for
5728 security reasons.
5729
5730
Bram Moolenaar251e1912011-06-19 05:09:16 +02005731 *'osfiletype'* *'oft'*
5732'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005734 This option was supported on RISC OS, which has been removed.
5735
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005737 *'packpath'* *'pp'*
5738'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005739 Directories used to find packages. See |packages|.
5740
5741
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005743'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 global
5745 Specifies the nroff macros that separate paragraphs. These are pairs
5746 of two letters (see |object-motions|).
5747
5748 *'paste'* *'nopaste'*
5749'paste' boolean (default off)
5750 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005751 Put Vim in Paste mode. This is useful if you want to cut or copy
5752 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 unexpected effects.
5754 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005755 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 knows about pasting and will mostly do the right thing without 'paste'
5757 being set. The same is true for a terminal where Vim handles the
5758 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005759 This option is reset when starting the GUI. Thus if you set it in
5760 your .vimrc it will work in a terminal, but not in the GUI. Setting
5761 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5762 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 When the 'paste' option is switched on (also when it was already on):
5764 - mapping in Insert mode and Command-line mode is disabled
5765 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005767 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005768 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 - 'revins' is reset
5770 - 'ruler' is reset
5771 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005772 - 'smarttab' is reset
5773 - 'softtabstop' is set to 0
5774 - 'textwidth' is set to 0
5775 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005776 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005779 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005780 - 'indentexpr'
5781 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005782 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 NOTE: When you start editing another file while the 'paste' option is
5784 on, settings from the modelines or autocommands may change the
5785 settings again, causing trouble when pasting text. You might want to
5786 set the 'paste' option again.
5787 When the 'paste' option is reset the mentioned options are restored to
5788 the value before the moment 'paste' was switched from off to on.
5789 Resetting 'paste' before ever setting it does not have any effect.
5790 Since mapping doesn't work while 'paste' is active, you need to use
5791 the 'pastetoggle' option to toggle the 'paste' option with some key.
5792
5793 *'pastetoggle'* *'pt'*
5794'pastetoggle' 'pt' string (default "")
5795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796 When non-empty, specifies the key sequence that toggles the 'paste'
5797 option. This is like specifying a mapping: >
5798 :map {keys} :set invpaste<CR>
5799< Where {keys} is the value of 'pastetoggle'.
5800 The difference is that it will work even when 'paste' is set.
5801 'pastetoggle' works in Insert mode and Normal mode, but not in
5802 Command-line mode.
5803 Mappings are checked first, thus overrule 'pastetoggle'. However,
5804 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5805 this: >
5806 :map <F10> :set paste<CR>
5807 :map <F11> :set nopaste<CR>
5808 :imap <F10> <C-O>:set paste<CR>
5809 :imap <F11> <nop>
5810 :set pastetoggle=<F11>
5811< This will make <F10> start paste mode and <F11> stop paste mode.
5812 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5813 mode everything is inserted literally, except the 'pastetoggle' key
5814 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005815 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816
5817 *'pex'* *'patchexpr'*
5818'patchexpr' 'pex' string (default "")
5819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 {not available when compiled without the |+diff|
5821 feature}
5822 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005823 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824
Bram Moolenaardbc28022014-07-26 13:40:44 +02005825 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826'patchmode' 'pm' string (default "")
5827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 When non-empty the oldest version of a file is kept. This can be used
5829 to keep the original version of a file if you are changing files in a
5830 source distribution. Only the first time that a file is written a
5831 copy of the original file will be kept. The name of the copy is the
5832 name of the original file with the string in the 'patchmode' option
5833 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005834 ".orig" or ".org". 'backupdir' must not be empty for this to work
5835 (Detail: The backup file is renamed to the patchmode file after the
5836 new file has been successfully written, that's why it must be possible
5837 to write a backup file). If there was no file to be backed up, an
5838 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 When the 'backupskip' pattern matches, a patchmode file is not made.
5840 Using 'patchmode' for compressed files appends the extension at the
5841 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5842 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005843 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005845 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 other systems: ".,,")
5848 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005850 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5851 provided that the file being searched for has a relative path (not
5852 starting with "/", "./" or "../"). The directories in the 'path'
5853 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854 - Use commas to separate directory names: >
5855 :set path=.,/usr/local/include,/usr/include
5856< - Spaces can also be used to separate directory names (for backwards
5857 compatibility with version 3.0). To have a space in a directory
5858 name, precede it with an extra backslash, and escape the space: >
5859 :set path=.,/dir/with\\\ space
5860< - To include a comma in a directory name precede it with an extra
5861 backslash: >
5862 :set path=.,/dir/with\\,comma
5863< - To search relative to the directory of the current file, use: >
5864 :set path=.
5865< - To search in the current directory use an empty string between two
5866 commas: >
5867 :set path=,,
5868< - A directory name may end in a ':' or '/'.
5869 - Environment variables are expanded |:set_env|.
5870 - When using |netrw.vim| URLs can be used. For example, adding
5871 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005872 - Search upwards and downwards in a directory tree using "*", "**" and
5873 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 {not available when compiled without the |+path_extra| feature}
5875 - Careful with '\' characters, type two to get one in the option: >
5876 :set path=.,c:\\include
5877< Or just use '/' instead: >
5878 :set path=.,c:/include
5879< Don't forget "." or files won't even be found in the same directory as
5880 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005881 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 it is something like 256 or 1024 characters.
5883 You can check if all the include files are found, using the value of
5884 'path', see |:checkpath|.
5885 The use of |:set+=| and |:set-=| is preferred when adding or removing
5886 directories from the list. This avoids problems when a future version
5887 uses another default. To remove the current directory use: >
5888 :set path-=
5889< To add the current directory use: >
5890 :set path+=
5891< To use an environment variable, you probably need to replace the
5892 separator. Here is an example to append $INCL, in which directory
5893 names are separated with a semi-colon: >
5894 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5895< Replace the ';' with a ':' or whatever separator is used. Note that
5896 this doesn't work when $INCL contains a comma or white space.
5897
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005898 *'perldll'*
5899'perldll' string (default depends on the build)
5900 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005901 {only available when compiled with the |+perl/dyn|
5902 feature}
5903 Specifies the name of the Perl shared library. The default is
5904 DYNAMIC_PERL_DLL, which was specified at compile time.
5905 Environment variables are expanded |:set_env|.
5906 This option cannot be set from a |modeline| or in the |sandbox|, for
5907 security reasons.
5908
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5910'preserveindent' 'pi' boolean (default off)
5911 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912 When changing the indent of the current line, preserve as much of the
5913 indent structure as possible. Normally the indent is replaced by a
5914 series of tabs followed by spaces as required (unless |'expandtab'| is
5915 enabled, in which case only spaces are used). Enabling this option
5916 means the indent will preserve as many existing characters as possible
5917 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005918 'expandtab' does not apply to the preserved white space, a Tab remains
5919 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 NOTE: When using ">>" multiple times the resulting indent is a mix of
5921 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005922 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923 Also see 'copyindent'.
5924 Use |:retab| to clean up white space.
5925
5926 *'previewheight'* *'pvh'*
5927'previewheight' 'pvh' number (default 12)
5928 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005929 {not available when compiled without the |+quickfix|
5930 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005932 commands. Used for |CTRL-W_}| when no count is given. Not used when
5933 'previewpopup' is set.
5934
5935 *'previewpopup'* *'pvp'*
5936'previewpopup' 'pvp' string (default empty)
5937 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005938 {not available when compiled without the |+textprop|
5939 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005940 When not empty a popup window is used for commands that would open a
5941 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005942 Not used for the insert completion info, add "popup" to
5943 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944
5945 *'previewwindow'* *'nopreviewwindow'*
5946 *'pvw'* *'nopvw'* *E590*
5947'previewwindow' 'pvw' boolean (default off)
5948 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005949 {not available when compiled without the |+quickfix|
5950 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005951 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 set. It's normally not set directly, but by using one of the commands
5953 |:ptag|, |:pedit|, etc.
5954
5955 *'printdevice'* *'pdev'*
5956'printdevice' 'pdev' string (default empty)
5957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958 {only available when compiled with the |+printer|
5959 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005960 The name of the printer to be used for |:hardcopy|.
5961 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005962 This option cannot be set from a |modeline| or in the |sandbox|, for
5963 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964
Bram Moolenaar8299df92004-07-10 09:47:34 +00005965 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005966'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 {only available when compiled with the |+printer|
5969 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005970 Sets the character encoding used when printing.
5971 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972
5973 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005974'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 {only available when compiled with the |+printer|
5977 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005978 Expression used to print the PostScript produced with |:hardcopy|.
5979 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005980 This option cannot be set from a |modeline| or in the |sandbox|, for
5981 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982
Bram Moolenaar8299df92004-07-10 09:47:34 +00005983 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984'printfont' 'pfn' string (default "courier")
5985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 {only available when compiled with the |+printer|
5987 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005988 The name of the font that will be used for |:hardcopy|.
5989 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990
5991 *'printheader'* *'pheader'*
5992'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 {only available when compiled with the |+printer|
5995 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005996 The format of the header produced in |:hardcopy| output.
5997 See |pheader-option|.
5998
5999 *'printmbcharset'* *'pmbcs'*
6000'printmbcharset' 'pmbcs' string (default "")
6001 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006002 {only available when compiled with the |+printer|
6003 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006004 The CJK character set to be used for CJK output from |:hardcopy|.
6005 See |pmbcs-option|.
6006
6007 *'printmbfont'* *'pmbfn'*
6008'printmbfont' 'pmbfn' string (default "")
6009 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006010 {only available when compiled with the |+printer|
6011 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006012 List of font names to be used for CJK output from |:hardcopy|.
6013 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014
6015 *'printoptions'* *'popt'*
6016'printoptions' 'popt' string (default "")
6017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006019 List of items that control the format of the output of |:hardcopy|.
6020 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006022 *'prompt'* *'noprompt'*
6023'prompt' boolean (default on)
6024 global
6025 When on a ":" prompt is used in Ex mode.
6026
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006027 *'pumheight'* *'ph'*
6028'pumheight' 'ph' number (default 0)
6029 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006030 Determines the maximum number of items to show in the popup menu for
6031 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006032 |ins-completion-menu|.
6033
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006034 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006035'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006036 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006037 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006038 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006039
Bram Moolenaard94464e2015-11-02 15:28:18 +01006040 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006041'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006042 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006043 {only available when compiled with the |+python/dyn|
6044 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006045 Specifies the name of the Python 2.x shared library. The default is
6046 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006047 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006048 This option cannot be set from a |modeline| or in the |sandbox|, for
6049 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006050
Bram Moolenaar94073162018-01-31 21:49:05 +01006051 *'pythonhome'*
6052'pythonhome' string (default "")
6053 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006054 {only available when compiled with the |+python/dyn|
6055 feature}
6056 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6057 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6058 which was specified at compile time, will be used for the Python 2.x
6059 home directory.
6060 Environment variables are expanded |:set_env|.
6061 This option cannot be set from a |modeline| or in the |sandbox|, for
6062 security reasons.
6063
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006064 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006065'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006066 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006067 {only available when compiled with the |+python3/dyn|
6068 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006069 Specifies the name of the Python 3 shared library. The default is
6070 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006071 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006072 This option cannot be set from a |modeline| or in the |sandbox|, for
6073 security reasons.
6074
Bram Moolenaar94073162018-01-31 21:49:05 +01006075 *'pythonthreehome'*
6076'pythonthreehome' string (default "")
6077 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006078 {only available when compiled with the |+python3/dyn|
6079 feature}
6080 Specifies the name of the Python 3 home directory. When
6081 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6082 PYTHON3_HOME, which was specified at compile time, will be used for
6083 the Python 3 home directory.
6084 Environment variables are expanded |:set_env|.
6085 This option cannot be set from a |modeline| or in the |sandbox|, for
6086 security reasons.
6087
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006088 *'pyxversion'* *'pyx'*
6089'pyxversion' 'pyx' number (default depends on the build)
6090 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006091 {only available when compiled with the |+python| or
6092 the |+python3| feature}
6093 Specifies the python version used for pyx* functions and commands
6094 |python_x|. The default value is as follows:
6095
6096 Compiled with Default ~
6097 |+python| and |+python3| 0
6098 only |+python| 2
6099 only |+python3| 3
6100
6101 Available values are 0, 2 and 3.
6102 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6103 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6104 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6105 to 2 if Python 2 is available.
6106 See also: |has-pythonx|
6107
6108 If Vim is compiled with only |+python| or |+python3| setting
6109 'pyxversion' has no effect. The pyx* functions and commands are
6110 always the same as the compiled version.
6111
6112 This option cannot be set from a |modeline| or in the |sandbox|, for
6113 security reasons.
6114
Bram Moolenaar858ba062020-05-31 23:11:59 +02006115 *'quickfixtextfunc'* *'qftf'*
6116'quickfixtextfunc' 'qftf' string (default "")
6117 global
6118 {only available when compiled with the |+quickfix|
6119 feature}
6120 This option specifies a function to be used to get the text to display
6121 in the quickfix and location list windows. This can be used to
6122 customize the information displayed in the quickfix or location window
6123 for each entry in the corresponding quickfix or location list. See
6124 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006125 function and an example. The value can be the name of a function, a
6126 |lambda| or a |Funcref|. See |option-value-function| for more
6127 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006128
6129 This option cannot be set from a |modeline| or in the |sandbox|, for
6130 security reasons.
6131
Bram Moolenaar677ee682005-01-27 14:41:15 +00006132 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006133'quoteescape' 'qe' string (default "\")
6134 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006135 The characters that are used to escape quotes in a string. Used for
6136 objects like a', a" and a` |a'|.
6137 When one of the characters in this option is found inside a string,
6138 the following character will be skipped. The default value makes the
6139 text "foo\"bar\\" considered to be one string.
6140
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6142'readonly' 'ro' boolean (default off)
6143 local to buffer
6144 If on, writes fail unless you use a '!'. Protects you from
6145 accidentally overwriting a file. Default on when Vim is started
6146 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006147 When using ":w!" the 'readonly' option is reset for the current
6148 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006149 When using the ":view" command the 'readonly' option is set for the
6150 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006151 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006153 *'redrawtime'* *'rdt'*
6154'redrawtime' 'rdt' number (default 2000)
6155 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006156 {only available when compiled with the |+reltime|
6157 feature}
6158 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006159 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006160 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006161 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006162 matches will be highlighted.
6163 For syntax highlighting the time applies per window. When over the
6164 limit syntax highlighting is disabled until |CTRL-L| is used.
6165 This is used to avoid that Vim hangs when using a very complicated
6166 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006167
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006168 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006169'regexpengine' 're' number (default 0)
6170 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006171 This selects the default regexp engine. |two-engines|
6172 The possible values are:
6173 0 automatic selection
6174 1 old engine
6175 2 NFA engine
6176 Note that when using the NFA engine and the pattern contains something
6177 that is not supported the pattern will not match. This is only useful
6178 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006179 Using automatic selection enables Vim to switch the engine, if the
6180 default engine becomes too costly. E.g., when the NFA engine uses too
6181 many states. This should prevent Vim from hanging on a combination of
6182 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006183
Bram Moolenaar64486672010-05-16 15:46:46 +02006184 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6185'relativenumber' 'rnu' boolean (default off)
6186 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006187 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006188 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006189 precede some vertical motion commands (e.g. j k + -) with, without
6190 having to calculate it yourself. Especially useful in combination with
6191 other commands (e.g. y d c < > gq gw =).
6192 When the 'n' option is excluded from 'cpoptions' a wrapped
6193 line will not use the column of line numbers (this is the default when
6194 'compatible' isn't set).
6195 The 'numberwidth' option can be used to set the room used for the line
6196 number.
6197 When a long, wrapped line doesn't start with the first character, '-'
6198 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006199 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6200 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006201
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006202 The number in front of the cursor line also depends on the value of
6203 'number', see |number_relativenumber| for all combinations of the two
6204 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006205
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 *'remap'* *'noremap'*
6207'remap' boolean (default on)
6208 global
6209 Allows for mappings to work recursively. If you do not want this for
6210 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006211 NOTE: To avoid portability problems with Vim scripts, always keep
6212 this option at the default "on". Only switch it off when working with
6213 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006215 *'renderoptions'* *'rop'*
6216'renderoptions' 'rop' string (default: empty)
6217 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006218 {only available when compiled with GUI and DIRECTX on
6219 MS-Windows}
6220 Select a text renderer and set its options. The options depend on the
6221 renderer.
6222
6223 Syntax: >
6224 set rop=type:{renderer}(,{name}:{value})*
6225<
6226 Currently, only one optional renderer is available.
6227
6228 render behavior ~
6229 directx Vim will draw text using DirectX (DirectWrite). It makes
6230 drawn glyphs more beautiful than default GDI.
6231 It requires 'encoding' is "utf-8", and only works on
6232 MS-Windows Vista or newer version.
6233
6234 Options:
6235 name meaning type value ~
6236 gamma gamma float 1.0 - 2.2 (maybe)
6237 contrast enhancedContrast float (unknown)
6238 level clearTypeLevel float (unknown)
6239 geom pixelGeometry int 0 - 2 (see below)
6240 renmode renderingMode int 0 - 6 (see below)
6241 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006242 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006243
Bram Moolenaar92467d32017-12-05 13:22:16 +01006244 See this URL for detail (except for scrlines):
6245 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006246
6247 For geom: structure of a device pixel.
6248 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6249 1 - DWRITE_PIXEL_GEOMETRY_RGB
6250 2 - DWRITE_PIXEL_GEOMETRY_BGR
6251
6252 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006253 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006254
6255 For renmode: method of rendering glyphs.
6256 0 - DWRITE_RENDERING_MODE_DEFAULT
6257 1 - DWRITE_RENDERING_MODE_ALIASED
6258 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6259 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6260 4 - DWRITE_RENDERING_MODE_NATURAL
6261 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6262 6 - DWRITE_RENDERING_MODE_OUTLINE
6263
6264 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006265 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006266
6267 For taamode: antialiasing mode used for drawing text.
6268 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6269 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6270 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6271 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6272
6273 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006274 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6275
Bram Moolenaara338adc2018-01-31 20:51:47 +01006276 For scrlines:
6277 This was used for optimizing scrolling behavior, however this
6278 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006279
6280 Example: >
6281 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006282 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006283 set rop=type:directx
6284<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006285 If select a raster font (Courier, Terminal or FixedSys which
6286 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006287 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006288
6289 NOTE: It is known that some fonts and options combination
6290 causes trouble on drawing glyphs.
6291
Bram Moolenaar92467d32017-12-05 13:22:16 +01006292 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006293 special made fonts (True-Type fonts which includes only
6294 bitmap glyphs).
6295 - 'taamode:3' will not work with some vector fonts.
6296
6297 NOTE: With this option, you can display colored emoji
6298 (emoticon) in Windows 8.1 or later. To display colored emoji,
6299 there are some conditions which you should notice.
6300
6301 - If your font includes non-colored emoji already, it will
6302 be used.
6303 - If your font doesn't have emoji, the system chooses an
6304 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6305 will be used.
6306 - When this alternative font didn't have fixed width glyph,
6307 emoji might be rendered beyond the bounding box of drawing
6308 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006309
6310 Other render types are currently not supported.
6311
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 *'report'*
6313'report' number (default 2)
6314 global
6315 Threshold for reporting number of lines changed. When the number of
6316 changed lines is more than 'report' a message will be given for most
6317 ":" commands. If you want it always, set 'report' to 0.
6318 For the ":substitute" command the number of substitutions is used
6319 instead of the number of lines.
6320
6321 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6322'restorescreen' 'rs' boolean (default on)
6323 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006324 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 When set, the screen contents is restored when exiting Vim. This also
6326 happens when executing external commands.
6327
6328 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6329 options in your .vimrc. To disable restoring:
6330 set t_ti= t_te=
6331 To enable restoring (for an xterm):
6332 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6333 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6334
6335 *'revins'* *'ri'* *'norevins'* *'nori'*
6336'revins' 'ri' boolean (default off)
6337 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 {only available when compiled with the |+rightleft|
6339 feature}
6340 Inserting characters in Insert mode will work backwards. See "typing
6341 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6342 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006343 NOTE: This option is reset when 'compatible' is set.
6344 This option is reset when 'paste' is set and restored when 'paste' is
6345 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346
6347 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6348'rightleft' 'rl' boolean (default off)
6349 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 {only available when compiled with the |+rightleft|
6351 feature}
6352 When on, display orientation becomes right-to-left, i.e., characters
6353 that are stored in the file appear from the right to the left.
6354 Using this option, it is possible to edit files for languages that
6355 are written from the right to the left such as Hebrew and Arabic.
6356 This option is per window, so it is possible to edit mixed files
6357 simultaneously, or to view the same file in both ways (this is
6358 useful whenever you have a mixed text file with both right-to-left
6359 and left-to-right strings so that both sets are displayed properly
6360 in different windows). Also see |rileft.txt|.
6361
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006362 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363'rightleftcmd' 'rlc' string (default "search")
6364 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 {only available when compiled with the |+rightleft|
6366 feature}
6367 Each word in this option enables the command line editing to work in
6368 right-to-left mode for a group of commands:
6369
6370 search "/" and "?" commands
6371
6372 This is useful for languages such as Hebrew, Arabic and Farsi.
6373 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6374
Bram Moolenaard94464e2015-11-02 15:28:18 +01006375 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006376'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006377 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006378 {only available when compiled with the |+ruby/dyn|
6379 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006380 Specifies the name of the Ruby shared library. The default is
6381 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006382 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006383 This option cannot be set from a |modeline| or in the |sandbox|, for
6384 security reasons.
6385
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006387'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 {not available when compiled without the
6390 |+cmdline_info| feature}
6391 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006392 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 text in the file is shown on the far right:
6394 Top first line is visible
6395 Bot last line is visible
6396 All first and last line are visible
6397 45% relative position in the file
6398 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006399 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006401 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 this option takes precedence over 'ruler' and 'rulerformat'
6403 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006404 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 the text column (byte number) and the screen column are shown,
6406 separated with a dash.
6407 For an empty line "0-1" is shown.
6408 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006409 This option is reset when 'paste' is set and restored when 'paste' is
6410 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 If you don't want to see the ruler all the time but want to know where
6412 you are, use "g CTRL-G" |g_CTRL-G|.
6413 NOTE: This option is reset when 'compatible' is set.
6414
6415 *'rulerformat'* *'ruf'*
6416'rulerformat' 'ruf' string (default empty)
6417 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 {not available when compiled without the |+statusline|
6419 feature}
6420 When this option is not empty, it determines the content of the ruler
6421 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006422 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006423 This option cannot be set in a modeline when 'modelineexpr' is off.
6424
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 The default ruler width is 17 characters. To make the ruler 15
6426 characters wide, put "%15(" at the start and "%)" at the end.
6427 Example: >
6428 :set rulerformat=%15(%c%V\ %p%%%)
6429<
6430 *'runtimepath'* *'rtp'* *vimfiles*
6431'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006432 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 $VIM/vimfiles,
6434 $VIMRUNTIME,
6435 $VIM/vimfiles/after,
6436 $HOME/.vim/after"
6437 Amiga: "home:vimfiles,
6438 $VIM/vimfiles,
6439 $VIMRUNTIME,
6440 $VIM/vimfiles/after,
6441 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006442 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 $VIM/vimfiles,
6444 $VIMRUNTIME,
6445 $VIM/vimfiles/after,
6446 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006447 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 $VIMRUNTIME,
6449 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006450 Haiku: "$BE_USER_SETTINGS/vim,
6451 $VIM/vimfiles,
6452 $VIMRUNTIME,
6453 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006454 $BE_USER_SETTINGS/vim/after"
6455 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 $VIM/vimfiles,
6457 $VIMRUNTIME,
6458 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006459 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 This is a list of directories which will be searched for runtime
6462 files:
6463 filetype.vim filetypes by file name |new-filetype|
6464 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006465 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 colors/ color scheme files |:colorscheme|
6467 compiler/ compiler files |:compiler|
6468 doc/ documentation |write-local-help|
6469 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006470 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 indent/ indent scripts |indent-expression|
6472 keymap/ key mapping files |mbyte-keymap|
6473 lang/ menu translations |:menutrans|
6474 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006475 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 plugin/ plugin scripts |write-plugin|
6477 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006478 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 syntax/ syntax files |mysyntaxfile|
6480 tutor/ files for vimtutor |tutor|
6481
6482 And any other file searched for with the |:runtime| command.
6483
6484 The defaults for most systems are setup to search five locations:
6485 1. In your home directory, for your personal preferences.
6486 2. In a system-wide Vim directory, for preferences from the system
6487 administrator.
6488 3. In $VIMRUNTIME, for files distributed with Vim.
6489 *after-directory*
6490 4. In the "after" directory in the system-wide Vim directory. This is
6491 for the system administrator to overrule or add to the distributed
6492 defaults (rarely needed)
6493 5. In the "after" directory in your home directory. This is for
6494 personal preferences to overrule or add to the distributed defaults
6495 or system-wide settings (rarely needed).
6496
Bram Moolenaard0796902016-09-16 20:02:31 +02006497 More entries are added when using |packages|. If it gets very long
6498 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6499 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006500
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6502 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006503 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 wildcards.
6505 See |:runtime|.
6506 Example: >
6507 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6508< This will use the directory "~/vimruntime" first (containing your
6509 personal Vim runtime files), then "/mygroup/vim" (shared between a
6510 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6511 files).
6512 You probably should always include $VIMRUNTIME somewhere, to use the
6513 distributed runtime files. You can put a directory before $VIMRUNTIME
6514 to find files which replace a distributed runtime files. You can put
6515 a directory after $VIMRUNTIME to find files which add to distributed
6516 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006517 When Vim is started with |--clean| the home directory entries are not
6518 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 This option cannot be set from a |modeline| or in the |sandbox|, for
6520 security reasons.
6521
6522 *'scroll'* *'scr'*
6523'scroll' 'scr' number (default: half the window height)
6524 local to window
6525 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6526 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006527 changes. This may happen when enabling the |status-line| or
6528 'tabline' option after setting the 'scroll' option.
6529 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006530 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006531 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532
6533 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6534'scrollbind' 'scb' boolean (default off)
6535 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 See also |scroll-binding|. When this option is set, the current
6537 window scrolls as other scrollbind windows (windows that also have
6538 this option set) scroll. This option is useful for viewing the
6539 differences between two versions of a file, see 'diff'.
6540 See |'scrollopt'| for options that determine how this option should be
6541 interpreted.
6542 This option is mostly reset when splitting a window to edit another
6543 file. This means that ":split | edit file" results in two windows
6544 with scroll-binding, but ":split file" does not.
6545
Bram Moolenaarae20f342019-11-05 21:09:23 +01006546 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6547'scrollfocus' 'scf' boolean (default off)
6548 global
6549 {only for MS-Windows GUI}
6550 When using the scroll wheel and this option is set, the window under
6551 the mouse pointer is scrolled. With this option off the current
6552 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006553 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006554
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 *'scrolljump'* *'sj'*
6556'scrolljump' 'sj' number (default 1)
6557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 Minimal number of lines to scroll when the cursor gets off the
6559 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6560 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006561 When set to a negative number from -1 to -100 this is used as the
6562 percentage of the window height. Thus -50 scrolls half the window
6563 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 NOTE: This option is set to 1 when 'compatible' is set.
6565
6566 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006567'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006568 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 Minimal number of screen lines to keep above and below the cursor.
6570 This will make some context visible around where you are working. If
6571 you set it to a very large value (999) the cursor line will always be
6572 in the middle of the window (except at the start or end of the file or
6573 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006574 After using the local value, go back the global value with one of
6575 these two: >
6576 setlocal scrolloff<
6577 setlocal scrolloff=-1
6578< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 NOTE: This option is set to 0 when 'compatible' is set.
6580
6581 *'scrollopt'* *'sbo'*
6582'scrollopt' 'sbo' string (default "ver,jump")
6583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006585 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6586 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 The following words are available:
6588 ver Bind vertical scrolling for 'scrollbind' windows
6589 hor Bind horizontal scrolling for 'scrollbind' windows
6590 jump Applies to the offset between two windows for vertical
6591 scrolling. This offset is the difference in the first
6592 displayed line of the bound windows. When moving
6593 around in a window, another 'scrollbind' window may
6594 reach a position before the start or after the end of
6595 the buffer. The offset is not changed though, when
6596 moving back the 'scrollbind' window will try to scroll
6597 to the desired position when possible.
6598 When now making that window the current one, two
6599 things can be done with the relative offset:
6600 1. When "jump" is not included, the relative offset is
6601 adjusted for the scroll position in the new current
6602 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006603 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 2. When "jump" is included, the other windows are
6605 scrolled to keep the same relative offset. When
6606 going back to the other window, it still uses the
6607 same relative offset.
6608 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006609 When 'diff' mode is active there always is vertical scroll binding,
6610 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611
6612 *'sections'* *'sect'*
6613'sections' 'sect' string (default "SHNHH HUnhsh")
6614 global
6615 Specifies the nroff macros that separate sections. These are pairs of
6616 two letters (See |object-motions|). The default makes a section start
6617 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6618
6619 *'secure'* *'nosecure'* *E523*
6620'secure' boolean (default off)
6621 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 When on, ":autocmd", shell and write commands are not allowed in
6623 ".vimrc" and ".exrc" in the current directory and map commands are
6624 displayed. Switch it off only if you know that you will not run into
6625 problems, or when the 'exrc' option is off. On Unix this option is
6626 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006627 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 'secure' at the end of your ~/.vimrc then.
6629 This option cannot be set from a |modeline| or in the |sandbox|, for
6630 security reasons.
6631
6632 *'selection'* *'sel'*
6633'selection' 'sel' string (default "inclusive")
6634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 This option defines the behavior of the selection. It is only used
6636 in Visual and Select mode.
6637 Possible values:
6638 value past line inclusive ~
6639 old no yes
6640 inclusive yes yes
6641 exclusive yes no
6642 "past line" means that the cursor is allowed to be positioned one
6643 character past the line.
6644 "inclusive" means that the last character of the selection is included
6645 in an operation. For example, when "x" is used to delete the
6646 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006647 When "old" is used and 'virtualedit' allows the cursor to move past
6648 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 Note that when "exclusive" is used and selecting from the end
6650 backwards, you cannot include the last character of a line, when
6651 starting in Normal mode and 'virtualedit' empty.
6652
6653 The 'selection' option is set by the |:behave| command.
6654
6655 *'selectmode'* *'slm'*
6656'selectmode' 'slm' string (default "")
6657 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 This is a comma separated list of words, which specifies when to start
6659 Select mode instead of Visual mode, when a selection is started.
6660 Possible values:
6661 mouse when using the mouse
6662 key when using shifted special keys
6663 cmd when using "v", "V" or CTRL-V
6664 See |Select-mode|.
6665 The 'selectmode' option is set by the |:behave| command.
6666
6667 *'sessionoptions'* *'ssop'*
6668'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006669 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006671 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 feature}
6673 Changes the effect of the |:mksession| command. It is a comma
6674 separated list of words. Each word enables saving and restoring
6675 something:
6676 word save and restore ~
6677 blank empty windows
6678 buffers hidden and unloaded buffers, not just those in windows
6679 curdir the current directory
6680 folds manually created folds, opened/closed folds and local
6681 fold options
6682 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006683 and contain at least one lowercase letter. Only
6684 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 help the help window
6686 localoptions options and mappings local to a window or buffer (not
6687 global values for local options)
6688 options all options and mappings (also global values for local
6689 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006690 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 resize size of the Vim window: 'lines' and 'columns'
6692 sesdir the directory in which the session file is located
6693 will become the current directory (useful with
6694 projects accessed over a network from different
6695 systems)
6696 slash backslashes in file names replaced with forward
6697 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006698 tabpages all tab pages; without this only the current tab page
6699 is restored, so that you can make a session for each
6700 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006701 terminal include terminal windows where the command can be
6702 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 unix with Unix end-of-line format (single <NL>), even when
6704 on Windows or DOS
6705 winpos position of the whole Vim window
6706 winsize window sizes
6707
6708 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006709 When neither "curdir" nor "sesdir" is included, file names are stored
6710 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006711 If you leave out "options" many things won't work well after restoring
6712 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 "slash" and "unix" are useful on Windows when sharing session files
6714 with Unix. The Unix version of Vim cannot source dos format scripts,
6715 but the Windows version of Vim can source unix format scripts.
6716
6717 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006718'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 global
6720 Name of the shell to use for ! and :! commands. When changing the
6721 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6722 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006723 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 See |option-backslash| about including spaces and backslashes.
6725 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006726
Bram Moolenaara2baa732022-02-04 16:09:54 +00006727 In |restricted-mode| shell commands will not be possible. This mode
6728 is used if the value of $SHELL ends in "false" or "nologin".
6729
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006730 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006731 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6733< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006734 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006736 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006738 Example with escaped space (Vim will do this when initializing the
6739 option from $SHELL): >
6740 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006741< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006742 backslashes are consumed by `:set`.
6743
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 Under MS-Windows, when the executable ends in ".com" it must be
6745 included. Thus setting the shell to "command.com" or "4dos.com"
6746 works, but "command" and "4dos" do not work for all commands (e.g.,
6747 filtering).
6748 For unknown reasons, when using "4dos.com" the current directory is
6749 changed to "C:\". To avoid this set 'shell' like this: >
6750 :set shell=command.com\ /c\ 4dos
6751< This option cannot be set from a |modeline| or in the |sandbox|, for
6752 security reasons.
6753
6754 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006755'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006756 Win32, when 'shell' contains "powershell":
6757 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006758 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006761 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6762 For MS-Windows, the default is set according to the value of 'shell',
6763 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006764 On Unix it can have more than one flag. Each white space separated
6765 part is passed as an argument to the shell command.
6766 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006767 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 This option cannot be set from a |modeline| or in the |sandbox|, for
6769 security reasons.
6770
6771 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006772'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6773 "2>&1| tee", or
6774 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 {not available when compiled without the |+quickfix|
6777 feature}
6778 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006779 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780 including spaces and backslashes.
6781 The name of the temporary file can be represented by "%s" if necessary
6782 (the file name is appended automatically if no %s appears in the value
6783 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006784 For the Amiga the default is ">". For MS-Windows using powershell the
6785 default is "2>&1 | Out-File -Encoding default", otherwise the default
6786 is ">%s 2>&1". The output is directly saved in a file and not echoed
6787 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006788 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 in a file and echoed to the screen. If the 'shell' option is "csh" or
6790 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006791 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006792 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6793 means that stderr is also included. Before using the 'shell' option a
6794 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006795 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6796 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 The initialization of this option is done after reading the ".vimrc"
6798 and the other initializations, so that when the 'shell' option is set
6799 there, the 'shellpipe' option changes automatically, unless it was
6800 explicitly set before.
6801 When 'shellpipe' is set to an empty string, no redirection of the
6802 ":make" output will be done. This is useful if you use a 'makeprg'
6803 that writes to 'makeef' by itself. If you want no piping, but do
6804 want to include the 'makeef', set 'shellpipe' to a single space.
6805 Don't forget to precede the space with a backslash: ":set sp=\ ".
6806 In the future pipes may be used for filtering and this option will
6807 become obsolete (at least for Unix).
6808 This option cannot be set from a |modeline| or in the |sandbox|, for
6809 security reasons.
6810
6811 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006812'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 Quoting character(s), put around the command passed to the shell, for
6815 the "!" and ":!" commands. The redirection is kept outside of the
6816 quoting. See 'shellxquote' to include the redirection. It's
6817 probably not useful to set both options.
6818 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006819 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006820 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 This option cannot be set from a |modeline| or in the |sandbox|, for
6822 security reasons.
6823
6824 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006825'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6826 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 String to be used to put the output of a filter command in a temporary
6829 file. See also |:!|. See |option-backslash| about including spaces
6830 and backslashes.
6831 The name of the temporary file can be represented by "%s" if necessary
6832 (the file name is appended automatically if no %s appears in the value
6833 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006834 The default is ">". For Unix, if the 'shell' option is "csh" or
6835 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006836 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006837 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6838 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006839 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6840 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006841 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6842 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 The initialization of this option is done after reading the ".vimrc"
6844 and the other initializations, so that when the 'shell' option is set
6845 there, the 'shellredir' option changes automatically unless it was
6846 explicitly set before.
6847 In the future pipes may be used for filtering and this option will
6848 become obsolete (at least for Unix).
6849 This option cannot be set from a |modeline| or in the |sandbox|, for
6850 security reasons.
6851
6852 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6853'shellslash' 'ssl' boolean (default off)
6854 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006855 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006857 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006858 powershell.exe. Backward slashes can still be typed, but they are
6859 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 Note that setting or resetting this option has no effect for some
6861 existing file names, thus this option needs to be set before opening
6862 any file for best results. This might change in the future.
6863 'shellslash' only works when a backslash can be used as a path
6864 separator. To test if this is so use: >
6865 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006866< Also see 'completeslash'.
6867
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006868 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6869'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6870 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006871 When on, use temp files for shell commands. When off use a pipe.
6872 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006873 Currently a pipe is only supported on Unix and MS-Windows 2K and
6874 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006875 :if has("filterpipe")
6876< The advantage of using a pipe is that nobody can read the temp file
6877 and the 'shell' command does not need to support redirection.
6878 The advantage of using a temp file is that the file type and encoding
6879 can be detected.
6880 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6881 |FilterWritePost| autocommands event are not triggered when
6882 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006883 The `system()` function does not respect this option and always uses
6884 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006885 NOTE: This option is set to the Vim default value when 'compatible'
6886 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006887
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 *'shelltype'* *'st'*
6889'shelltype' 'st' number (default 0)
6890 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006891 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 On the Amiga this option influences the way how the commands work
6893 which use a shell.
6894 0 and 1: always use the shell
6895 2 and 3: use the shell only to filter lines
6896 4 and 5: use shell only for ':sh' command
6897 When not using the shell, the command is executed directly.
6898
6899 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6900 1 and 3: use "shell cmd" to start external commands
6901
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006902 *'shellxescape'* *'sxe'*
6903'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006904 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006905 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006906 When 'shellxquote' is set to "(" then the characters listed in this
6907 option will be escaped with a '^' character. This makes it possible
6908 to execute most external commands with cmd.exe.
6909
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 *'shellxquote'* *'sxq'*
6911'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006912 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006913 for Win32, when 'shell' is
6914 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006915 for Win32, when 'shell' contains "sh"
6916 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 for Unix, when using system(): "\"")
6918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 Quoting character(s), put around the command passed to the shell, for
6920 the "!" and ":!" commands. Includes the redirection. See
6921 'shellquote' to exclude the redirection. It's probably not useful
6922 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006923 When the value is '(' then ')' is appended. When the value is '"('
6924 then ')"' is appended.
6925 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006926 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006927 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6928 pwsh.exe which automatically strips off the first and last quote on a
6929 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6930 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006931 'shell', to reduce the need to set this option by the user. See
6932 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 This option cannot be set from a |modeline| or in the |sandbox|, for
6934 security reasons.
6935
6936 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6937'shiftround' 'sr' boolean (default off)
6938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 Round indent to multiple of 'shiftwidth'. Applies to > and <
6940 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6941 a multiple of 'shiftwidth' (this is Vi compatible).
6942 NOTE: This option is reset when 'compatible' is set.
6943
6944 *'shiftwidth'* *'sw'*
6945'shiftwidth' 'sw' number (default 8)
6946 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006947 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006949 When zero the 'ts' value will be used. Use the |shiftwidth()|
6950 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951
6952 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006953'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6954 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 This option helps to avoid all the |hit-enter| prompts caused by file
6957 messages, for example with CTRL-G, and to avoid some other messages.
6958 It is a list of flags:
6959 flag meaning when present ~
6960 f use "(3 of 5)" instead of "(file 3 of 5)"
6961 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006962 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 m use "[+]" instead of "[Modified]"
6964 n use "[New]" instead of "[New File]"
6965 r use "[RO]" instead of "[readonly]"
6966 w use "[w]" instead of "written" for file write message
6967 and "[a]" instead of "appended" for ':w >> file' command
6968 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6969 "[unix format]" and "[mac]" instead of "[mac format]".
6970 a all of the above abbreviations
6971
6972 o overwrite message for writing a file with subsequent message
6973 for reading a file (useful for ":wn" or when 'autowrite' on)
6974 O message for reading a file overwrites any previous message.
6975 Also for quickfix message (e.g., ":cn").
6976 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006977 hit TOP, continuing at BOTTOM" messages; when using the search
6978 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 t truncate file message at the start if it is too long to fit
6980 on the command-line, "<" will appear in the left most column.
6981 Ignored in Ex mode.
6982 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006983 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 Ignored in Ex mode.
6985 W don't give "written" or "[w]" when writing a file
6986 A don't give the "ATTENTION" message when an existing swap file
6987 is found.
6988 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006989 c don't give |ins-completion-menu| messages. For example,
6990 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6991 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006992 q use "recording" instead of "recording @a"
6993 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006994 was used for the command; note that this also affects messages
6995 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006996 S do not show search count message when searching, e.g.
6997 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998
6999 This gives you the opportunity to avoid that a change between buffers
7000 requires you to hit <Enter>, but still gives as useful a message as
7001 possible for the space available. To get the whole message that you
7002 would have got with 'shm' empty, use ":file!"
7003 Useful values:
7004 shm= No abbreviation of message.
7005 shm=a Abbreviation, but no loss of information.
7006 shm=at Abbreviation, and truncate message when necessary.
7007
7008 NOTE: This option is set to the Vi default value when 'compatible' is
7009 set and to the Vim default value when 'compatible' is reset.
7010
7011 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7012'shortname' 'sn' boolean (default off)
7013 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 Filenames are assumed to be 8 characters plus one extension of 3
7015 characters. Multiple dots in file names are not allowed. When this
7016 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007017 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007019 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020
7021 *'showbreak'* *'sbr'* *E595*
7022'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007023 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007024 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 feature}
7026 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007027 values are "> " or "+++ ": >
7028 :set showbreak=>\
7029< Note the backslash to escape the trailing space. It's easier like
7030 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007031 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007032< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 comma (in a future version the comma might be used to separate the
7034 part that is shown at the end and at the start of a line).
7035 The characters are highlighted according to the '@' flag in
7036 'highlight'.
7037 Note that tabs after the showbreak will be displayed differently.
7038 If you want the 'showbreak' to appear in between line numbers, add the
7039 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007040 A window-local value overrules a global value. If the global value is
7041 set and you want no value in the current window use NONE: >
7042 :setlocal showbreak=NONE
7043<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007045'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7046 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 {not available when compiled without the
7049 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007050 Show (partial) command in the last line of the screen. Set this
7051 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 In Visual mode the size of the selected area is shown:
7053 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007054 If the number of bytes is different it is also displayed: "2-6"
7055 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007057 - When selecting a block, the size in screen characters:
7058 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 NOTE: This option is set to the Vi default value when 'compatible' is
7060 set and to the Vim default value when 'compatible' is reset.
7061
7062 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7063'showfulltag' 'sft' boolean (default off)
7064 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 When completing a word in insert mode (see |ins-completion|) from the
7066 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007067 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 matched a C function, you can see a template for what arguments are
7069 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007070 Note that this doesn't work well together with having "longest" in
7071 'completeopt', because the completion from the search pattern may not
7072 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073
7074 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7075'showmatch' 'sm' boolean (default off)
7076 global
7077 When a bracket is inserted, briefly jump to the matching one. The
7078 jump is only done if the match can be seen on the screen. The time to
7079 show the match can be set with 'matchtime'.
7080 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007081 seen or not).
7082 This option is reset when 'paste' is set and restored when 'paste' is
7083 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 When the 'm' flag is not included in 'cpoptions', typing a character
7085 will immediately move the cursor back to where it belongs.
7086 See the "sm" field in 'guicursor' for setting the cursor shape and
7087 blinking when showing the match.
7088 The 'matchpairs' option can be used to specify the characters to show
7089 matches for. 'rightleft' and 'revins' are used to look for opposite
7090 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007091 Also see the matchparen plugin for highlighting the match when moving
7092 around |pi_paren.txt|.
7093 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094
7095 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7096'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7097 global
7098 If in Insert, Replace or Visual mode put a message on the last line.
7099 Use the 'M' flag in 'highlight' to set the type of highlighting for
7100 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007101 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 doesn't mean XIM is really active, especially when 'imactivatekey' is
7103 not set.
7104 NOTE: This option is set to the Vi default value when 'compatible' is
7105 set and to the Vim default value when 'compatible' is reset.
7106
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007107 *'showtabline'* *'stal'*
7108'showtabline' 'stal' number (default 1)
7109 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007110 The value of this option specifies when the line with tab page labels
7111 will be displayed:
7112 0: never
7113 1: only if there are at least two tab pages
7114 2: always
7115 This is both for the GUI and non-GUI implementation of the tab pages
7116 line.
7117 See |tab-page| for more information about tab pages.
7118
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 *'sidescroll'* *'ss'*
7120'sidescroll' 'ss' number (default 0)
7121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 The minimal number of columns to scroll horizontally. Used only when
7123 the 'wrap' option is off and the cursor is moved off of the screen.
7124 When it is zero the cursor will be put in the middle of the screen.
7125 When using a slow terminal set it to a large number or 0. When using
7126 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7127 commands.
7128
7129 *'sidescrolloff'* *'siso'*
7130'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007131 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007133 right of the cursor if 'nowrap' is set. Setting this option to a
7134 value greater than 0 while having |'sidescroll'| also at a non-zero
7135 value makes some context visible in the line you are scrolling in
7136 horizontally (except at beginning of the line). Setting this option
7137 to a large value (like 999) has the effect of keeping the cursor
7138 horizontally centered in the window, as long as one does not come too
7139 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007140 After using the local value, go back the global value with one of
7141 these two: >
7142 setlocal sidescrolloff<
7143 setlocal sidescrolloff=-1
7144< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145
7146 Example: Try this together with 'sidescroll' and 'listchars' as
7147 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007148 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149
7150 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7151 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007152<
7153 *'signcolumn'* *'scl'*
7154'signcolumn' 'scl' string (default "auto")
7155 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007156 {not available when compiled without the |+signs|
7157 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007158 Whether or not to draw the signcolumn. Valid values are:
7159 "auto" only when there is a sign to display
7160 "no" never
7161 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007162 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007163 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164
7165
7166 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7167'smartcase' 'scs' boolean (default off)
7168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 Override the 'ignorecase' option if the search pattern contains upper
7170 case characters. Only used when the search pattern is typed and
7171 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007172 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7174 recalling the search pattern from history and hitting <Enter>.
7175 NOTE: This option is reset when 'compatible' is set.
7176
7177 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7178'smartindent' 'si' boolean (default off)
7179 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 {not available when compiled without the
7181 |+smartindent| feature}
7182 Do smart autoindenting when starting a new line. Works for C-like
7183 programs, but can also be used for other languages. 'cindent' does
7184 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007185 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007186 setting 'si' has no effect. 'indentexpr' is a more advanced
7187 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 Normally 'autoindent' should also be on when using 'smartindent'.
7189 An indent is automatically inserted:
7190 - After a line ending in '{'.
7191 - After a line starting with a keyword from 'cinwords'.
7192 - Before a line starting with '}' (only with the "O" command).
7193 When typing '}' as the first character in a new line, that line is
7194 given the same indent as the matching '{'.
7195 When typing '#' as the first character in a new line, the indent for
7196 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007197 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7199 When using the ">>" command, lines starting with '#' are not shifted
7200 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007201 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007202 This option is reset when 'paste' is set and restored when 'paste' is
7203 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204
7205 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7206'smarttab' 'sta' boolean (default off)
7207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007209 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7210 <BS> will delete a 'shiftwidth' worth of space at the start of the
7211 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007212 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007213 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7214 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007215 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007217 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007218 This option is reset when 'paste' is set and restored when 'paste' is
7219 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 NOTE: This option is reset when 'compatible' is set.
7221
7222 *'softtabstop'* *'sts'*
7223'softtabstop' 'sts' number (default 0)
7224 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 Number of spaces that a <Tab> counts for while performing editing
7226 operations, like inserting a <Tab> or using <BS>. It "feels" like
7227 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7228 used. This is useful to keep the 'ts' setting at its standard value
7229 of 8, while being able to edit like it is set to 'sts'. However,
7230 commands like "x" still work on the actual characters.
7231 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007232 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007233 'softtabstop' is set to 0 when the 'paste' option is set and restored
7234 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7236 spaces is minimized by using <Tab>s.
7237 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7238 set.
7239 NOTE: This option is set to 0 when 'compatible' is set.
7240
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007241 If Vim is compiled with the |+vartabs| feature then the value of
7242 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7243 anything other than an empty string.
7244
Bram Moolenaar217ad922005-03-20 22:37:15 +00007245 *'spell'* *'nospell'*
7246'spell' boolean (default off)
7247 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007248 {not available when compiled without the |+syntax|
7249 feature}
7250 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007251 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007252
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007253 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007254'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007255 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007256 {not available when compiled without the |+syntax|
7257 feature}
7258 Pattern to locate the end of a sentence. The following word will be
7259 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007260 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007261 When this check is not wanted make this option empty.
7262 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007263 Be careful with special characters, see |option-backslash| about
7264 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007265 To set this option automatically depending on the language, see
7266 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007267
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007268 *'spellfile'* *'spf'*
7269'spellfile' 'spf' string (default empty)
7270 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007271 {not available when compiled without the |+syntax|
7272 feature}
7273 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007274 commands. It must end in ".{encoding}.add". You need to include the
7275 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007276 *E765*
7277 It may also be a comma separated list of names. A count before the
7278 |zg| and |zw| commands can be used to access each. This allows using
7279 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007280 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007281 you: Using the first directory in 'runtimepath' that is writable. If
7282 there is no "spell" directory yet it will be created. For the file
7283 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007284 ignoring the region.
7285 The resulting ".spl" file will be used for spell checking, it does not
7286 have to appear in 'spelllang'.
7287 Normally one file is used for all regions, but you can add the region
7288 name if you want to. However, it will then only be used when
7289 'spellfile' is set to it, for entries in 'spelllang' only files
7290 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007291 This option cannot be set from a |modeline| or in the |sandbox|, for
7292 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007293
Bram Moolenaar217ad922005-03-20 22:37:15 +00007294 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007295'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007296 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007297 {not available when compiled without the |+syntax|
7298 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007299 A comma separated list of word list names. When the 'spell' option is
7300 on spellchecking will be done for these languages. Example: >
7301 set spelllang=en_us,nl,medical
7302< This means US English, Dutch and medical words are recognized. Words
7303 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007304 The word list name must consist of alphanumeric characters, a dash or
7305 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007306 recommended to separate the two letter language name from a
7307 specification. Thus "en-rare" is used for rare English words.
7308 A region name must come last and have the form "_xx", where "xx" is
7309 the two-letter, lower case region name. You can use more than one
7310 region by listing them: "en_us,en_ca" supports both US and Canadian
7311 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007312 Britain. (Note: currently en_au and en_nz dictionaries are older than
7313 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007314 If the name "cjk" is included East Asian characters are excluded from
7315 spell checking. This is useful when editing text that also has Asian
7316 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007317 Note that the "medical" dictionary does not exist, it is just an
7318 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007319 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007320 As a special case the name of a .spl file can be given as-is. The
7321 first "_xx" in the name is removed and used as the region name
7322 (_xx is an underscore, two letters and followed by a non-letter).
7323 This is mainly for testing purposes. You must make sure the correct
7324 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007325 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007326 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7327 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007328 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007329
Bram Moolenaar98692072006-02-04 00:57:42 +00007330 If the |spellfile.vim| plugin is active and you use a language name
7331 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7332 will ask you if you want to download the file.
7333
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007334 After this option has been set successfully, Vim will source the files
7335 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007336 up to the first character that is not an ASCII letter or number and
7337 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007338
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007339 *'spelloptions'* *'spo'*
7340'spelloptions' 'spo' string (default "")
7341 local to buffer
7342 {not available when compiled without the |+syntax|
7343 feature}
7344 A comma separated list of options for spell checking:
7345 camel When a word is CamelCased, assume "Cased" is a
7346 separate word: every upper-case character in a word
7347 that comes after a lower case character indicates the
7348 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007349
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007350 *'spellsuggest'* *'sps'*
7351'spellsuggest' 'sps' string (default "best")
7352 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007353 {not available when compiled without the |+syntax|
7354 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007355 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007356 the |spellsuggest()| function. This is a comma-separated list of
7357 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007358
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007359 best Internal method that works best for English. Finds
7360 changes like "fast" and uses a bit of sound-a-like
7361 scoring to improve the ordering.
7362
7363 double Internal method that uses two methods and mixes the
7364 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007365 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007366 word. That only works when the language specifies
7367 sound folding. Can be slow and doesn't always give
7368 better results.
7369
7370 fast Internal method that only checks for simple changes:
7371 character inserts/deletes/swaps. Works well for
7372 simple typing mistakes.
7373
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007374 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007375 Not used for |spellsuggest()|. The number of
7376 suggestions is never more than the value of 'lines'
7377 minus two.
7378
Bram Moolenaar585ee072022-01-29 11:22:17 +00007379 timeout:{millisec} Limit the time searching for suggestions to
7380 {millisec} milli seconds. Applies to the following
7381 methods. When omitted the limit is 5000. When
7382 negative there is no limit. {only works when built
7383 with the +reltime feature}
7384
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007385 file:{filename} Read file {filename}, which must have two columns,
7386 separated by a slash. The first column contains the
7387 bad word, the second column the suggested good word.
7388 Example:
7389 theribal/terrible ~
7390 Use this for common mistakes that do not appear at the
7391 top of the suggestion list with the internal methods.
7392 Lines without a slash are ignored, use this for
7393 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007394 The word in the second column must be correct,
7395 otherwise it will not be used. Add the word to an
7396 ".add" file if it is currently flagged as a spelling
7397 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007398 The file is used for all languages.
7399
7400 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7401 trouble with spaces. |v:val| holds the badly spelled
7402 word. The expression must evaluate to a List of
7403 Lists, each with a suggestion and a score.
7404 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007405 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007406 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007407 internal methods use. A lower score is better.
7408 This may invoke |spellsuggest()| if you temporarily
7409 set 'spellsuggest' to exclude the "expr:" part.
7410 Errors are silently ignored, unless you set the
7411 'verbose' option to a non-zero value.
7412
7413 Only one of "best", "double" or "fast" may be used. The others may
7414 appear several times in any order. Example: >
7415 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7416<
7417 This option cannot be set from a |modeline| or in the |sandbox|, for
7418 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007419
7420
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7422'splitbelow' 'sb' boolean (default off)
7423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 When on, splitting a window will put the new window below the current
7425 one. |:split|
7426
7427 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7428'splitright' 'spr' boolean (default off)
7429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 When on, splitting a window will put the new window right of the
7431 current one. |:vsplit|
7432
7433 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7434'startofline' 'sol' boolean (default on)
7435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007437 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007438 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007439 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 with a linewise operator, with "%" with a count and to buffer changing
7441 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7442 only has a line number, e.g., ":25" or ":+".
7443 In case of buffer changing commands the cursor is placed at the column
7444 where it was the last time the buffer was edited.
7445 NOTE: This option is set when 'compatible' is set.
7446
Bram Moolenaar00654022011-02-25 14:42:19 +01007447 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007449 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 {not available when compiled without the |+statusline|
7451 feature}
7452 When nonempty, this option determines the content of the status line.
7453 Also see |status-line|.
7454
7455 The option consists of printf style '%' items interspersed with
7456 normal text. Each status line item is of the form:
7457 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007458 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007459 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460
Bram Moolenaar238a5642006-02-21 22:12:05 +00007461 When the option starts with "%!" then it is used as an expression,
7462 evaluated and the result is used as the option value. Example: >
7463 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007464< The *g:statusline_winid* variable will be set to the |window-ID| of the
7465 window that the status line belongs to.
7466 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007467 Note that the "%!" expression is evaluated in the context of the
7468 current window and buffer, while %{} items are evaluated in the
7469 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007470
7471 When there is error while evaluating the option then it will be made
7472 empty to avoid further errors. Otherwise screen updating would loop.
7473
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 Note that the only effect of 'ruler' when this option is set (and
7475 'laststatus' is 2) is controlling the output of |CTRL-G|.
7476
7477 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007478 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007480 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 minwid Minimum width of the item, padding as set by '-' & '0'.
7482 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007483 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 on the left for text items. Numeric items will be
7485 shifted down to maxwid-2 digits followed by '>'number
7486 where number is the amount of missing digits, much like
7487 an exponential notation.
7488 item A one letter code as described below.
7489
7490 Following is a description of the possible statusline items. The
7491 second character in "item" is the type:
7492 N for number
7493 S for string
7494 F for flags as described below
7495 - not applicable
7496
7497 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007498 f S Path to the file in the buffer, as typed or relative to current
7499 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500 F S Full path to the file in the buffer.
7501 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007502 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007504 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007506 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007508 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007510 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007512 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7514 being used: "<keymap>"
7515 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007516 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 B N As above, in hexadecimal.
7518 o N Byte number in file of byte under cursor, first byte is 1.
7519 Mnemonic: Offset from start of file (with one added)
7520 {not available when compiled without |+byte_offset| feature}
7521 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007522 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 l N Line number.
7524 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007525 c N Column number (byte index).
7526 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007527 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 p N Percentage through file in lines as in |CTRL-G|.
7529 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007530 percentage described for 'ruler'. Always 3 in length, unless
7531 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007532 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007534 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007535 Note that there is no '%' before the closing '}'. The
7536 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007537 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007538 {% - This is almost same as { except the result of the expression is
7539 re-evaluated as a statusline format string. Thus if the
7540 return value of expr contains % items they will get expanded.
7541 The expression can contain the } character, the end of
7542 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007543 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007544 func! Stl_filename() abort
7545 return "%t"
7546 endfunc
7547< `stl=%{Stl_filename()}` results in `"%t"`
7548 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007549 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 ( - Start of item group. Can be used for setting the width and
7551 alignment of a section. Must be followed by %) somewhere.
7552 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007553 T N For 'tabline': start of tab page N label. Use %T after the last
7554 label. This information is used for mouse clicks.
7555 X N For 'tabline': start of close tab N label. Use %X after the
7556 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7557 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 < - Where to truncate line if too long. Default is at the start.
7559 No width fields allowed.
7560 = - Separation point between left and right aligned items.
7561 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007562 # - Set highlight group. The name must follow and then a # again.
7563 Thus use %#HLname# for highlight group HLname. The same
7564 highlighting is used, also for the statusline of non-current
7565 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007567 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 The difference between User{N} and StatusLine will be applied
7569 to StatusLineNC for the statusline of non-current windows.
7570 The number N must be between 1 and 9. See |hl-User1..9|
7571
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007572 When displaying a flag, Vim removes the leading comma, if any, when
7573 that flag comes right after plaintext. This will make a nice display
7574 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575
Bram Moolenaar582fd852005-03-28 20:58:01 +00007576 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 not set) and a minwid is not set for the group, the whole group will
7578 become empty. This will make a group like the following disappear
7579 completely from the statusline when none of the flags are set. >
7580 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007581< Beware that an expression is evaluated each and every time the status
7582 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007583 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007584 While evaluating %{} the current buffer and current window will be set
7585 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007586 currently being drawn. The expression will evaluate in this context.
7587 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7588 real current buffer and "g:actual_curwin" to the |window-ID| of the
7589 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007590
Bram Moolenaar30b65812012-07-12 22:01:11 +02007591 The 'statusline' option will be evaluated in the |sandbox| if set from
7592 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007593 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007594
7595 It is not allowed to change text or jump to another window while
7596 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597
7598 If the statusline is not updated when you want it (e.g., after setting
7599 a variable that's used in an expression), you can force an update by
7600 setting an option without changing its value. Example: >
7601 :let &ro = &ro
7602
7603< A result of all digits is regarded a number for display purposes.
7604 Otherwise the result is taken as flag text and applied to the rules
7605 described above.
7606
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007607 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007609 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610
7611 Examples:
7612 Emulate standard status line with 'ruler' set >
7613 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7614< Similar, but add ASCII value of char under the cursor (like "ga") >
7615 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7616< Display byte count and byte value, modified flag in red. >
7617 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7618 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7619< Display a ,GZ flag if a compressed file is loaded >
7620 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7621< In the |:autocmd|'s: >
7622 :let b:gzflag = 1
7623< And: >
7624 :unlet b:gzflag
7625< And define this function: >
7626 :function VarExists(var, val)
7627 : if exists(a:var) | return a:val | else | return '' | endif
7628 :endfunction
7629<
7630 *'suffixes'* *'su'*
7631'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 Files with these suffixes get a lower priority when multiple files
7634 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007635 suffixes. Spaces after the comma are ignored. A dot is also seen as
7636 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637 separator, precede it with a backslash (see |option-backslash| about
7638 including spaces and backslashes).
7639 See 'wildignore' for completely ignoring files.
7640 The use of |:set+=| and |:set-=| is preferred when adding or removing
7641 suffixes from the list. This avoids problems when a future version
7642 uses another default.
7643
7644 *'suffixesadd'* *'sua'*
7645'suffixesadd' 'sua' string (default "")
7646 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 {not available when compiled without the
7648 |+file_in_path| feature}
7649 Comma separated list of suffixes, which are used when searching for a
7650 file for the "gf", "[I", etc. commands. Example: >
7651 :set suffixesadd=.java
7652<
7653 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7654'swapfile' 'swf' boolean (default on)
7655 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007656 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 swapfile is not wanted for a specific buffer. For example, with
7658 confidential information that even root must not be able to access.
7659 Careful: All text will be in memory:
7660 - Don't use this for big files.
7661 - Recovery will be impossible!
7662 A swapfile will only be present when |'updatecount'| is non-zero and
7663 'swapfile' is set.
7664 When 'swapfile' is reset, the swap file for the current buffer is
7665 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7666 non-zero, a swap file is immediately created.
7667 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007668 If you want to open a new buffer without creating a swap file for it,
7669 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007670 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671
7672 This option is used together with 'bufhidden' and 'buftype' to
7673 specify special kinds of buffers. See |special-buffers|.
7674
7675 *'swapsync'* *'sws'*
7676'swapsync' 'sws' string (default "fsync")
7677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007679 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007680 When this option is empty parts of the swap file may be in memory and
7681 not written to disk. When the system crashes you may lose more work.
7682 On Unix the system does a sync now and then without Vim asking for it,
7683 so the disadvantage of setting this option off is small. On some
7684 systems the swap file will not be written at all. For a unix system
7685 setting it to "sync" will use the sync() call instead of the default
7686 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007687 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688
7689 *'switchbuf'* *'swb'*
7690'switchbuf' 'swb' string (default "")
7691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007693 Mostly for |quickfix| commands some values are also used for other
7694 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695 Possible values (comma separated list):
7696 useopen If included, jump to the first open window that
7697 contains the specified buffer (if there is one).
7698 Otherwise: Do not examine other windows.
7699 This setting is checked with |quickfix| commands, when
7700 jumping to errors (":cc", ":cn", "cp", etc.). It is
7701 also used in all buffer related split commands, for
7702 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007703 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007704 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007706 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007707 Otherwise: do not split, use current window (when used
7708 in the quickfix window: the previously used window or
7709 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007710 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007711 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007712 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007713 uselast If included, jump to the previously used window when
7714 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007716 *'synmaxcol'* *'smc'*
7717'synmaxcol' 'smc' number (default 3000)
7718 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007719 {not available when compiled without the |+syntax|
7720 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007721 Maximum column in which to search for syntax items. In long lines the
7722 text after this column is not highlighted and following lines may not
7723 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007724 This helps to avoid very slow redrawing for an XML file that is one
7725 long line.
7726 Set to zero to remove the limit.
7727
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 *'syntax'* *'syn'*
7729'syntax' 'syn' string (default empty)
7730 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 {not available when compiled without the |+syntax|
7732 feature}
7733 When this option is set, the syntax with this name is loaded, unless
7734 syntax highlighting has been switched off with ":syntax off".
7735 Otherwise this option does not always reflect the current syntax (the
7736 b:current_syntax variable does).
7737 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007738 not automatically recognized. Example, in an IDL file:
7739 /* vim: set syntax=idl : */ ~
7740 When a dot appears in the value then this separates two filetype
7741 names. Example:
7742 /* vim: set syntax=c.doxygen : */ ~
7743 This will use the "c" syntax first, then the "doxygen" syntax.
7744 Note that the second one must be prepared to be loaded as an addition,
7745 otherwise it will be skipped. More than one dot may appear.
7746 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 :set syntax=OFF
7748< To switch syntax highlighting on according to the current value of the
7749 'filetype' option: >
7750 :set syntax=ON
7751< What actually happens when setting the 'syntax' option is that the
7752 Syntax autocommand event is triggered with the value as argument.
7753 This option is not copied to another buffer, independent of the 's' or
7754 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007755 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007757 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007758'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007759 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007760 When nonempty, this option determines the content of the tab pages
7761 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007762 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007763
7764 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007765 option and only when there is no GUI tab line. When 'e' is in
7766 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007767 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007768
7769 The value is evaluated like with 'statusline'. You can use
7770 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007771 the text to be displayed. Use "%1T" for the first label, "%2T" for
7772 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007773
Bram Moolenaare12bab32019-01-08 22:02:56 +01007774 When changing something that is used in 'tabline' that does not
7775 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007776 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007777
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007778 Keep in mind that only one of the tab pages is the current one, others
7779 are invisible and you can't jump to their windows.
7780
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007781
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007782 *'tabpagemax'* *'tpm'*
7783'tabpagemax' 'tpm' number (default 10)
7784 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007785 Maximum number of tab pages to be opened by the |-p| command line
7786 argument or the ":tab all" command. |tabpage|
7787
7788
7789 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790'tabstop' 'ts' number (default 8)
7791 local to buffer
7792 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007793 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794
7795 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007796 appear wrong in many places, e.g., when printing it.
7797 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798
7799 There are four main ways to use tabs in Vim:
7800 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7801 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007802 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803 behave like a tab appears every 4 (or 3) characters.
7804 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7805 'expandtab'. This way you will always insert spaces. The
7806 formatting will never be messed up when 'tabstop' is changed.
7807 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007808 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 works when using Vim to edit the file.
7810 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7811 'noexpandtab'. This should then work (for initial indents only)
7812 for any tabstop setting that people use. It might be nice to have
7813 tabs after the first non-blank inserted as spaces if you do this
7814 though. Otherwise aligned comments will be wrong when 'tabstop' is
7815 changed.
7816
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007817 If Vim is compiled with the |+vartabs| feature then the value of
7818 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7819 than an empty string.
7820
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7822'tagbsearch' 'tbs' boolean (default on)
7823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007825 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 searching makes searching for a tag a LOT faster, but a linear search
7827 will find more tags if the tags file wasn't properly sorted.
7828 Vim normally assumes that your tags files are sorted, or indicate that
7829 they are not sorted. Only when this is not the case does the
7830 'tagbsearch' option need to be switched off.
7831
7832 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007833 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 certain files, or retry all files with a linear search. When
7835 'tagbsearch' is off, only a linear search is done.
7836
7837 Linear searching is done anyway, for one file, when Vim finds a line
7838 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007839 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840< [The whitespace before and after the '0' must be a single <Tab>]
7841
7842 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007843 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007844 instead of a normal tag name, a retry is done with a linear search.
7845 Tags in unsorted tags files, and matches with different case will only
7846 be found in the retry.
7847
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007848 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007849 linear search can be avoided when case is ignored. Use a value of '2'
7850 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7851 sorted with the -f switch to "sort" in most unices, as in the command:
7852 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7853 (at least 5.5) the --sort=foldcase switch can be used for this as
7854 well. Note that case must be folded to uppercase for this to work.
7855
7856 By default, tag searches are case-sensitive. Case is ignored when
7857 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7858 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007859 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7860 'tagcase' is "smart", and the pattern contains only lowercase
7861 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862
7863 When 'tagbsearch' is off, tags searching is slower when a full match
7864 exists, but faster when no full match exists. Tags in unsorted tags
7865 files may only be found with 'tagbsearch' off.
7866 When the tags file is not sorted, or sorted in a wrong way (not on
7867 ASCII byte value), 'tagbsearch' should be off, or the line given above
7868 must be included in the tags file.
7869 This option doesn't affect commands that find all matching tags (e.g.,
7870 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007872 *'tagcase'* *'tc'*
7873'tagcase' 'tc' string (default "followic")
7874 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007875 This option specifies how case is handled when searching the tags
7876 file:
7877 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007878 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007879 ignore Ignore case
7880 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007881 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007882 NOTE: This option is set to the Vi default value when 'compatible' is
7883 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007884
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007885 *'tagfunc'* *'tfu'*
7886'tagfunc' 'tfu' string (default: empty)
7887 local to buffer
7888 {not available when compiled without the |+eval|
7889 feature}
7890 This option specifies a function to be used to perform tag searches.
7891 The function gets the tag pattern and should return a List of matching
7892 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007893 function and an example. The value can be the name of a function, a
7894 |lambda| or a |Funcref|. See |option-value-function| for more
7895 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007896
Bram Moolenaar071d4272004-06-13 20:20:40 +00007897 *'taglength'* *'tl'*
7898'taglength' 'tl' number (default 0)
7899 global
7900 If non-zero, tags are significant up to this number of characters.
7901
7902 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7903'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7904 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007905 If on and using a tags file in another directory, file names in that
7906 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 NOTE: This option is set to the Vi default value when 'compatible' is
7908 set and to the Vim default value when 'compatible' is reset.
7909
7910 *'tags'* *'tag'* *E433*
7911'tags' 'tag' string (default "./tags,tags", when compiled with
7912 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7913 global or local to buffer |global-local|
7914 Filenames for the tag command, separated by spaces or commas. To
7915 include a space or comma in a file name, precede it with a backslash
7916 (see |option-backslash| about including spaces and backslashes).
7917 When a file name starts with "./", the '.' is replaced with the path
7918 of the current file. But only when the 'd' flag is not included in
7919 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7920 |tags-option|.
7921 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007922 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7923 find all files named "tags" below "/lib". The filename itself cannot
7924 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7925 files called "tags?". {not available when compiled without the
7926 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007927 The |tagfiles()| function can be used to get a list of the file names
7928 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7930 files are also supported. They are automatically recognized. The
7931 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7932 differences are ignored (MS-Windows). |emacs-tags|
7933 The use of |:set+=| and |:set-=| is preferred when adding or removing
7934 file names from the list. This avoids problems when a future version
7935 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936
7937 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7938'tagstack' 'tgst' boolean (default on)
7939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007940 When on, the |tagstack| is used normally. When off, a ":tag" or
7941 ":tselect" command with an argument will not push the tag onto the
7942 tagstack. A following ":tag" without an argument, a ":pop" command or
7943 any other command that uses the tagstack will use the unmodified
7944 tagstack, but does change the pointer to the active entry.
7945 Resetting this option is useful when using a ":tag" command in a
7946 mapping which should not change the tagstack.
7947
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007948 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007949'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007950 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007951 {only available when compiled with the |+tcl/dyn|
7952 feature}
7953 Specifies the name of the Tcl shared library. The default is
7954 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007955 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007956 This option cannot be set from a |modeline| or in the |sandbox|, for
7957 security reasons.
7958
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 *'term'* *E529* *E530* *E531*
7960'term' string (default is $TERM, if that fails:
7961 in the GUI: "builtin_gui"
7962 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007963 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 on Unix: "ansi"
7966 on VMS: "ansi"
7967 on Win 32: "win32")
7968 global
7969 Name of the terminal. Used for choosing the terminal control
7970 characters. Environment variables are expanded |:set_env|.
7971 For example: >
7972 :set term=$TERM
7973< See |termcap|.
7974
7975 *'termbidi'* *'tbidi'*
7976 *'notermbidi'* *'notbidi'*
7977'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 {only available when compiled with the |+arabic|
7980 feature}
7981 The terminal is in charge of Bi-directionality of text (as specified
7982 by Unicode). The terminal is also expected to do the required shaping
7983 that some languages (such as Arabic) require.
7984 Setting this option implies that 'rightleft' will not be set when
7985 'arabic' is set and the value of 'arabicshape' will be ignored.
7986 Note that setting 'termbidi' has the immediate effect that
7987 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7988 This option is reset when the GUI is started.
7989 For further details see |arabic.txt|.
7990
7991 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007992'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994 Encoding used for the terminal. This specifies what character
7995 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007996 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007997 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007998 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007999 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8001 Any attempts to set a different value will be rejected, and an error
8002 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008003 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 because the Win32 system always passes Unicode characters.
8005 When empty, the same encoding is used as for the 'encoding' option.
8006 This is the normal value.
8007 Not all combinations for 'termencoding' and 'encoding' are valid. See
8008 |encoding-table|.
8009 The value for this option must be supported by internal conversions or
8010 iconv(). When this is not possible no conversion will be done and you
8011 will probably experience problems with non-ASCII characters.
8012 Example: You are working with the locale set to euc-jp (Japanese) and
8013 want to edit a UTF-8 file: >
8014 :let &termencoding = &encoding
8015 :set encoding=utf-8
8016< You need to do this when your system has no locale support for UTF-8.
8017
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008018 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008019'termguicolors' 'tgc' boolean (default off)
8020 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008021 {not available when compiled without the
8022 |+termguicolors| feature}
8023 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008024 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008025
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008026 Requires a ISO-8613-3 compatible terminal. If setting this option
8027 does not work (produces a colorless UI) reading |xterm-true-color|
8028 might help.
8029
8030 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8031 is required. Use this check to find out: >
8032 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008033< This requires Vim to be built with the |+vtp| feature.
8034
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008035 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008036 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008037
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008038 *'termwinkey'* *'twk'*
8039'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008040 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008041 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008042 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008043 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008044 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008045< The string must be one key stroke but can be multiple bytes.
8046 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008047 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008048 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008049
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008050 *'termwinscroll'* *'twsl'*
8051'termwinscroll' 'twsl' number (default 10000)
8052 local to buffer
8053 {not available when compiled without the
8054 |+terminal| feature}
8055 Number of scrollback lines to keep. When going over this limit the
8056 first 10% of the scrollback lines are deleted. This is just to reduce
8057 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008058 Also used as a limit for text sent to the terminal in one write,
8059 multiplied by the number of columns times 3 (average number of bytes
8060 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008061
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008062 *'termwinsize'* *'tws'*
8063'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008064 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008065 Size used when opening the |terminal| window. Format:
8066 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008067 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008068 - When set with a "x" (e.g., "24x80") the terminal size is not
8069 adjusted to the window size. If the window is smaller only the
8070 top-left part is displayed.
8071 - When set with a "*" (e.g., "10*50") the terminal size follows the
8072 window size, but will not be smaller than the specified rows and/or
8073 columns.
8074 - When rows is zero then use the height of the window.
8075 - When columns is zero then use the width of the window.
8076 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008077 - Can be overruled in the |term_start()| options with "term_rows" and
8078 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008079
8080 Examples:
8081 "30x0" uses 30 rows and the current window width.
8082 "20*0" uses at least 20 rows and the current window width.
8083 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008084 Note that the command running in the terminal window may still change
8085 the size of the terminal. In that case the Vim window will be
8086 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008087
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008088 *'termwintype'* *'twt'*
8089'termwintype' 'twt' string (default "")
8090 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008091 {only available when compiled with the |terminal|
8092 feature on MS-Windows}
8093 Specify the virtual console (pty) used when opening the terminal
8094 window.
8095
8096 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008097 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008098 "winpty" use winpty, fail if not supported
8099 "conpty" use |ConPTY|, fail if not supported
8100
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008101 |ConPTY| support depends on the platform. Windows 10 October 2018
8102 Update is the first version that supports ConPTY, however it is still
8103 considered unstable. ConPTY might become stable in the next release
8104 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008105 supported then you cannot open a terminal window.
8106
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107 *'terse'* *'noterse'*
8108'terse' boolean (default off)
8109 global
8110 When set: Add 's' flag to 'shortmess' option (this makes the message
8111 for a search that hits the start or end of the file not being
8112 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8113 shortens a lot of messages}
8114
8115 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8116'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 This option is obsolete. Use 'fileformats'.
8119 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8120 set to the default value for the current system. When 'textauto' is
8121 reset, 'fileformats' is made empty.
8122 NOTE: This option is set to the Vi default value when 'compatible' is
8123 set and to the Vim default value when 'compatible' is reset.
8124
8125 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008126'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127 others: default off)
8128 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 This option is obsolete. Use 'fileformat'.
8130 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8131 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8132 "unix".
8133
8134 *'textwidth'* *'tw'*
8135'textwidth' 'tw' number (default 0)
8136 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 Maximum width of text that is being inserted. A longer line will be
8138 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008139 this.
8140 'textwidth' is set to 0 when the 'paste' option is set and restored
8141 when 'paste' is reset.
8142 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008144 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 NOTE: This option is set to 0 when 'compatible' is set.
8146
8147 *'thesaurus'* *'tsr'*
8148'thesaurus' 'tsr' string (default "")
8149 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008151 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8152 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008153
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008154 This option is not used if 'thesaurusfunc' is set, either for the
8155 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008156
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008157 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008159 name. See |option-backslash| about using backslashes. The use of
8160 |:set+=| and |:set-=| is preferred when adding or removing directories
8161 from the list. This avoids problems when a future version uses
8162 another default. Backticks cannot be used in this option for security
8163 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008165 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008166'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008167 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008168 {not available when compiled without the |+eval|
8169 feature}
8170 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008171 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008172 The value can be the name of a function, a |lambda| or a |Funcref|.
8173 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008174
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008175 This option cannot be set from a |modeline| or in the |sandbox|, for
8176 security reasons.
8177
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8179'tildeop' 'top' boolean (default off)
8180 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008181 When on: The tilde command "~" behaves like an operator.
8182 NOTE: This option is reset when 'compatible' is set.
8183
8184 *'timeout'* *'to'* *'notimeout'* *'noto'*
8185'timeout' 'to' boolean (default on)
8186 global
8187 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008188'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 These two options together determine the behavior when part of a
8191 mapped key sequence or keyboard code has been received:
8192
8193 'timeout' 'ttimeout' action ~
8194 off off do not time out
8195 on on or off time out on :mappings and key codes
8196 off on time out on key codes
8197
8198 If both options are off, Vim will wait until either the complete
8199 mapping or key sequence has been received, or it is clear that there
8200 is no mapping or key sequence for the received characters. For
8201 example: if you have mapped "vl" and Vim has received 'v', the next
8202 character is needed to see if the 'v' is followed by an 'l'.
8203 When one of the options is on, Vim will wait for about 1 second for
8204 the next character to arrive. After that the already received
8205 characters are interpreted as single characters. The waiting time can
8206 be changed with the 'timeoutlen' option.
8207 On slow terminals or very busy systems timing out may cause
8208 malfunctioning cursor keys. If both options are off, Vim waits
8209 forever after an entered <Esc> if there are key codes that start
8210 with <Esc>. You will have to type <Esc> twice. If you do not have
8211 problems with key codes, but would like to have :mapped key
8212 sequences not timing out in 1 second, set the 'ttimeout' option and
8213 reset the 'timeout' option.
8214
8215 NOTE: 'ttimeout' is reset when 'compatible' is set.
8216
8217 *'timeoutlen'* *'tm'*
8218'timeoutlen' 'tm' number (default 1000)
8219 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008220
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008222'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 The time in milliseconds that is waited for a key code or mapped key
8225 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8226 when part of a command has been typed.
8227 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8228 different timeout value for key codes is desired set 'ttimeoutlen' to
8229 a non-negative number.
8230
8231 ttimeoutlen mapping delay key code delay ~
8232 < 0 'timeoutlen' 'timeoutlen'
8233 >= 0 'timeoutlen' 'ttimeoutlen'
8234
8235 The timeout only happens when the 'timeout' and 'ttimeout' options
8236 tell so. A useful setting would be >
8237 :set timeout timeoutlen=3000 ttimeoutlen=100
8238< (time out on mapping after three seconds, time out on key codes after
8239 a tenth of a second).
8240
8241 *'title'* *'notitle'*
8242'title' boolean (default off, on when title can be restored)
8243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 When on, the title of the window will be set to the value of
8245 'titlestring' (if it is not empty), or to:
8246 filename [+=-] (path) - VIM
8247 Where:
8248 filename the name of the file being edited
8249 - indicates the file cannot be modified, 'ma' off
8250 + indicates the file was modified
8251 = indicates the file is read-only
8252 =+ indicates the file is read-only and modified
8253 (path) is the path of the file being edited
8254 - VIM the server name |v:servername| or "VIM"
8255 Only works if the terminal supports setting window titles
8256 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008257 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8259 *X11*
8260 When Vim was compiled with HAVE_X11 defined, the original title will
8261 be restored if possible. The output of ":version" will include "+X11"
8262 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8263 works for the icon name |'icon'|.
8264 But: When Vim was started with the |-X| argument, restoring the title
8265 will not work (except in the GUI).
8266 If the title cannot be restored, it is set to the value of 'titleold'.
8267 You might want to restore the title outside of Vim then.
8268 When using an xterm from a remote machine you can use this command:
8269 rsh machine_name xterm -display $DISPLAY &
8270 then the WINDOWID environment variable should be inherited and the
8271 title of the window should change back to what it should be after
8272 exiting Vim.
8273
8274 *'titlelen'*
8275'titlelen' number (default 85)
8276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008278 title. When the title is longer, only the end of the path name is
8279 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280 Using a percentage makes this adapt to the width of the window. But
8281 it won't work perfectly, because the actual number of characters
8282 available also depends on the font used and other things in the title
8283 bar. When 'titlelen' is zero the full path is used. Otherwise,
8284 values from 1 to 30000 percent can be used.
8285 'titlelen' is also used for the 'titlestring' option.
8286
8287 *'titleold'*
8288'titleold' string (default "Thanks for flying Vim")
8289 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008290 This option will be used for the window title when exiting Vim if the
8291 original title cannot be restored. Only happens if 'title' is on or
8292 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008293 This option cannot be set from a |modeline| or in the |sandbox|, for
8294 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 *'titlestring'*
8296'titlestring' string (default "")
8297 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008298 When this option is not empty, it will be used for the title of the
8299 window. This happens only when the 'title' option is on.
8300 Only works if the terminal supports setting window titles (currently
8301 Amiga console, Win32 console, all GUI versions and terminals with a
8302 non-empty 't_ts' option).
8303 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008304 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008305
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 When this option contains printf-style '%' items, they will be
8307 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008308 This option cannot be set in a modeline when 'modelineexpr' is off.
8309
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 Example: >
8311 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8312 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8313< The value of 'titlelen' is used to align items in the middle or right
8314 of the available space.
8315 Some people prefer to have the file name first: >
8316 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8317< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008318 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 separating space only when needed.
8320 NOTE: Use of special characters in 'titlestring' may cause the display
8321 to be garbled (e.g., when it contains a CR or NL character).
8322 {not available when compiled without the |+statusline| feature}
8323
8324 *'toolbar'* *'tb'*
8325'toolbar' 'tb' string (default "icons,tooltips")
8326 global
8327 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8328 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008329 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 possible values are:
8331 icons Toolbar buttons are shown with icons.
8332 text Toolbar buttons shown with text.
8333 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008334 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 tooltips Tooltips are active for toolbar buttons.
8336 Tooltips refer to the popup help text which appears after the mouse
8337 cursor is placed over a toolbar button for a brief moment.
8338
8339 If you want the toolbar to be shown with icons as well as text, do the
8340 following: >
8341 :set tb=icons,text
8342< Motif and Athena cannot display icons and text at the same time. They
8343 will show icons if both are requested.
8344
8345 If none of the strings specified in 'toolbar' are valid or if
8346 'toolbar' is empty, this option is ignored. If you want to disable
8347 the toolbar, you need to set the 'guioptions' option. For example: >
8348 :set guioptions-=T
8349< Also see |gui-toolbar|.
8350
8351 *'toolbariconsize'* *'tbis'*
8352'toolbariconsize' 'tbis' string (default "small")
8353 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008354 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008356 tiny Use tiny icons.
8357 small Use small icons (default).
8358 medium Use medium-sized icons.
8359 large Use large icons.
8360 huge Use even larger icons.
8361 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008363 the current theme. Common dimensions are giant=48x48, huge=32x32,
8364 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365
8366 If 'toolbariconsize' is empty, the global default size as determined
8367 by user preferences or the current theme is used.
8368
8369 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8370'ttybuiltin' 'tbi' boolean (default on)
8371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 When on, the builtin termcaps are searched before the external ones.
8373 When off the builtin termcaps are searched after the external ones.
8374 When this option is changed, you should set the 'term' option next for
8375 the change to take effect, for example: >
8376 :set notbi term=$TERM
8377< See also |termcap|.
8378 Rationale: The default for this option is "on", because the builtin
8379 termcap entries are generally better (many systems contain faulty
8380 xterm entries...).
8381
8382 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8383'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8384 sun-cmd, screen, rxvt, dtterm or
8385 iris-ansi; also on when running Vim in
8386 a DOS console)
8387 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 Indicates a fast terminal connection. More characters will be sent to
8389 the screen for redrawing, instead of using insert/delete line
8390 commands. Improves smoothness of redrawing when there are multiple
8391 windows and the terminal does not support a scrolling region.
8392 Also enables the extra writing of characters at the end of each screen
8393 line for lines that wrap. This helps when using copy/paste with the
8394 mouse in an xterm and other terminals.
8395
8396 *'ttymouse'* *'ttym'*
8397'ttymouse' 'ttym' string (default depends on 'term')
8398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 {only in Unix and VMS, doesn't work in the GUI; not
8400 available when compiled without |+mouse|}
8401 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008402 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 *xterm-mouse*
8404 xterm xterm-like mouse handling. The mouse generates
8405 "<Esc>[Mscr", where "scr" is three bytes:
8406 "s" = button state
8407 "c" = column plus 33
8408 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008409 This only works up to 223 columns! See "dec",
8410 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 xterm2 Works like "xterm", but with the xterm reporting the
8412 mouse position while the mouse is dragged. This works
8413 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008414 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 work. See below for how Vim detects this
8416 automatically.
8417 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008418 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008420 for the row and column. No other mouse events are
8421 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 *dec-mouse*
8423 dec DEC terminal mouse handling. The mouse generates a
8424 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008425 This is also available for an Xterm, if it was
8426 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427 *jsbterm-mouse*
8428 jsbterm JSB term mouse handling.
8429 *pterm-mouse*
8430 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008431 *urxvt-mouse*
8432 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008433 The mouse works only if the terminal supports this
8434 encoding style, but it does not have 223 columns limit
8435 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008436 *sgr-mouse*
8437 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008438 mouse reporting. The mouse works even in columns
8439 beyond 223. This option is backward compatible with
8440 "xterm2" because it can also decode "xterm2" style
8441 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442
8443 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008444 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8445 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8447 recognized, if enabled at compile time. DEC terminal mouse codes
8448 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008449 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8450 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008452 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8453 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8454 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008455 Additionally, if vim is compiled with the |+termresponse| feature and
8456 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008457 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008459 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8460 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8461 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008462 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8463 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008464 :set t_RV=
8465<
8466 *'ttyscroll'* *'tsl'*
8467'ttyscroll' 'tsl' number (default 999)
8468 global
8469 Maximum number of lines to scroll the screen. If there are more lines
8470 to scroll the window is redrawn. For terminals where scrolling is
8471 very slow and redrawing is not slow this can be set to a small number,
8472 e.g., 3, to speed up displaying.
8473
8474 *'ttytype'* *'tty'*
8475'ttytype' 'tty' string (default from $TERM)
8476 global
8477 Alias for 'term', see above.
8478
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008479 *'undodir'* *'udir'*
8480'undodir' 'udir' string (default ".")
8481 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008482 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008483 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008484 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008485 "." means using the directory of the file. The undo file name for
8486 "file.txt" is ".file.txt.un~".
8487 For other directories the file name is the full path of the edited
8488 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008489 When writing: The first directory that exists is used. "." always
8490 works, no directories after "." will be used for writing.
8491 When reading all entries are tried to find an undo file. The first
8492 undo file that exists is used. When it cannot be read an error is
8493 given, no further entry is used.
8494 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008495 This option cannot be set from a |modeline| or in the |sandbox|, for
8496 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008497
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008498 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008499'undofile' 'udf' boolean (default off)
8500 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008501 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008502 When on, Vim automatically saves undo history to an undo file when
8503 writing a buffer to a file, and restores undo history from the same
8504 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008505 The directory where the undo file is stored is specified by 'undodir'.
8506 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008507 The undo file is not read when 'undoreload' causes the buffer from
8508 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008509 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008510 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008511
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008513'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008514 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008515 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008516 is kept in memory, higher numbers will cause more memory to be used.
8517 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8519 itself: >
8520 set ul=0
8521< But you can also get Vi compatibility by including the 'u' flag in
8522 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008523 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008524 Set to -1 for no undo at all. You might want to do this only for the
8525 current buffer: >
8526 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008528
8529 The local value is set to -123456 when the global value is to be used.
8530
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008531 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008533 *'undoreload'* *'ur'*
8534'undoreload' 'ur' number (default 10000)
8535 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008536 Save the whole buffer for undo when reloading it. This applies to the
8537 ":e!" command and reloading for when the buffer changed outside of
8538 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008539 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008540 of lines is smaller than the value of this option.
8541 Set this option to zero to disable undo for a reload.
8542
8543 When saving undo for a reload, any undo file is not read.
8544
8545 Note that this causes the whole buffer to be stored in memory. Set
8546 this option to a lower value if you run out of memory.
8547
Bram Moolenaar071d4272004-06-13 20:20:40 +00008548 *'updatecount'* *'uc'*
8549'updatecount' 'uc' number (default: 200)
8550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 After typing this many characters the swap file will be written to
8552 disk. When zero, no swap file will be created at all (see chapter on
8553 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8554 Vim with the "-n" option, see |startup|. When editing in readonly
8555 mode this option will be initialized to 10000.
8556 The swapfile can be disabled per buffer with |'swapfile'|.
8557 When 'updatecount' is set from zero to non-zero, swap files are
8558 created for all buffers that have 'swapfile' set. When 'updatecount'
8559 is set to zero, existing swap files are not deleted.
8560 Also see |'swapsync'|.
8561 This option has no meaning in buffers where |'buftype'| is "nofile"
8562 or "nowrite".
8563
8564 *'updatetime'* *'ut'*
8565'updatetime' 'ut' number (default 4000)
8566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567 If this many milliseconds nothing is typed the swap file will be
8568 written to disk (see |crash-recovery|). Also used for the
8569 |CursorHold| autocommand event.
8570
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008571 *'varsofttabstop'* *'vsts'*
8572'varsofttabstop' 'vsts' string (default "")
8573 local to buffer
8574 {only available when compiled with the |+vartabs|
8575 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008576 A list of the number of spaces that a <Tab> counts for while editing,
8577 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8578 width <Tab>s are being inserted, while in fact a mixture of spaces
8579 and <Tab>s is used. Tab widths are separated with commas, with the
8580 final value applying to all subsequent tabs.
8581
8582 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008583 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008584 to use the following: >
8585 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008586< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8587 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008588
8589 Note that the value of |'softtabstop'| will be ignored while
8590 'varsofttabstop' is set.
8591
8592 *'vartabstop'* *'vts'*
8593'vartabstop' 'vts' string (default "")
8594 local to buffer
8595 {only available when compiled with the |+vartabs|
8596 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008597 A list of the number of spaces that a <Tab> in the file counts for,
8598 separated by commas. Each value corresponds to one tab, with the
8599 final value applying to all subsequent tabs. For example: >
8600 :set vartabstop=4,20,10,8
8601< This will make the first tab 4 spaces wide, the second 20 spaces,
8602 the third 10 spaces, and all following tabs 8 spaces.
8603
8604 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8605 is set.
8606
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 *'verbose'* *'vbs'*
8608'verbose' 'vbs' number (default 0)
8609 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008610 When bigger than zero, Vim will give messages about what it is doing.
8611 Currently, these messages are given:
8612 >= 1 When the viminfo file is read or written.
8613 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008614 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008615 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 >= 8 Files for which a group of autocommands is executed.
8617 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008618 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 >= 12 Every executed function.
8620 >= 13 When an exception is thrown, caught, finished, or discarded.
8621 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008622 >= 15 Every executed Ex command from a script (truncated at 200
8623 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008624 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625
8626 This option can also be set with the "-V" argument. See |-V|.
8627 This option is also set by the |:verbose| command.
8628
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008629 When the 'verbosefile' option is set then the verbose messages are not
8630 displayed.
8631
8632 *'verbosefile'* *'vfile'*
8633'verbosefile' 'vfile' string (default empty)
8634 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008635 When not empty all messages are written in a file with this name.
8636 When the file exists messages are appended.
8637 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008638 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008639 Setting 'verbosefile' to a new value is like making it empty first.
8640 The difference with |:redir| is that verbose messages are not
8641 displayed when 'verbosefile' is set.
8642
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008644'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 "$VIM/vimfiles/view",
8646 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008647 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008648 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008650 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 feature}
8652 Name of the directory where to store files for |:mkview|.
8653 This option cannot be set from a |modeline| or in the |sandbox|, for
8654 security reasons.
8655
8656 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008657'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008659 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008660 feature}
8661 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008662 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 word save and restore ~
8664 cursor cursor position in file and in window
8665 folds manually created folds, opened/closed folds and local
8666 fold options
8667 options options and mappings local to a window or buffer (not
8668 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008669 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670 slash backslashes in file names replaced with forward
8671 slashes
8672 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008673 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008674 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008676 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008678 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679
8680 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008681'viminfo' 'vi' string (Vi default: "", Vim default for
8682 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008683 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8684 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008686 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008687 feature}
8688 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008689 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8690 "NONE".
8691 The string should be a comma separated list of parameters, each
8692 consisting of a single character identifying the particular parameter,
8693 followed by a number or string which specifies the value of that
8694 parameter. If a particular character is left out, then the default
8695 value is used for that parameter. The following is a list of the
8696 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008698 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 ! When included, save and restore global variables that start
8700 with an uppercase letter, and don't contain a lowercase
8701 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008702 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008703 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008704 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 " Maximum number of lines saved for each register. Old name of
8706 the '<' item, with the disadvantage that you need to put a
8707 backslash before the ", otherwise it will be recognized as the
8708 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008709 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 % When included, save and restore the buffer list. If Vim is
8711 started with a file name argument, the buffer list is not
8712 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008713 buffer list is restored from the viminfo file. Quickfix
8714 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8715 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008716 When followed by a number, the number specifies the maximum
8717 number of buffers that are stored. Without a number all
8718 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008719 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 ' Maximum number of previously edited files for which the marks
8721 are remembered. This parameter must always be included when
8722 'viminfo' is non-empty.
8723 Including this item also means that the |jumplist| and the
8724 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008725 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008726 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008727 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 patterns are also saved. When not included, the value of
8729 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008730 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008732 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008733 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734 < Maximum number of lines saved for each register. If zero then
8735 registers are not saved. When not included, all lines are
8736 saved. '"' is the old name for this item.
8737 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008738 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008739 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008740 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008741 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 c When included, convert the text in the viminfo file from the
8743 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008744 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008745 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 f Whether file marks need to be stored. If zero, file marks ('0
8747 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008748 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008749 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008750 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 h Disable the effect of 'hlsearch' when loading the viminfo
8752 file. When not included, it depends on whether ":nohlsearch"
8753 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008754 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008756 the 'n'. Must be at the end of the option! If the
8757 'viminfofile' option is set, that file name overrides the one
8758 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008759 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008760 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 r Removable media. The argument is a string (up to the next
8762 ','). This parameter can be given several times. Each
8763 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008764 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8766 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8767 ignored. Maximum length of each 'r' argument is 50
8768 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008769 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 s Maximum size of an item in Kbyte. If zero then registers are
8771 not saved. Currently only applies to registers. The default
8772 "s10" will exclude registers with more than 10 Kbyte of text.
8773 Also see the '<' item above: line count limit.
8774
8775 Example: >
8776 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8777<
8778 '50 Marks will be remembered for the last 50 files you
8779 edited.
8780 <1000 Contents of registers (up to 1000 lines each) will be
8781 remembered.
8782 s100 Registers with more than 100 Kbyte text are skipped.
8783 :0 Command-line history will not be saved.
8784 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8785 no / Since '/' is not specified, the default will be used,
8786 that is, save all of the search history, and also the
8787 previous search and substitute patterns.
8788 no % The buffer list will not be saved nor read back.
8789 no h 'hlsearch' highlighting will be restored.
8790
8791 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8792 load the contents of the file, this is not done automatically.
8793
8794 This option cannot be set from a |modeline| or in the |sandbox|, for
8795 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008796 NOTE: This option is set to the Vim default value when 'compatible'
8797 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008799 *'viminfofile'* *'vif'*
8800'viminfofile' 'vif' string (default: "")
8801 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008802 {not available when compiled without the |+viminfo|
8803 feature}
8804 When non-empty, overrides the file name used for viminfo.
8805 When equal to "NONE" no viminfo file will be read or written.
8806 This option can be set with the |-i| command line flag. The |--clean|
8807 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008808 This option cannot be set from a |modeline| or in the |sandbox|, for
8809 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008810
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 *'virtualedit'* *'ve'*
8812'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008813 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 A comma separated list of these words:
8815 block Allow virtual editing in Visual block mode.
8816 insert Allow virtual editing in Insert mode.
8817 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008818 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008819 none When used as the local value, do not allow virtual
8820 editing even when the global value is set. When used
8821 as the global value, "none" is the same as "".
8822 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008823
Bram Moolenaar071d4272004-06-13 20:20:40 +00008824 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008825 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 of the line. Useful for selecting a rectangle in Visual mode and
8827 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008828 "onemore" is not the same, it will only allow moving the cursor just
8829 after the last character of the line. This makes some commands more
8830 consistent. Previously the cursor was always past the end of the line
8831 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008832 break some plugins or Vim scripts. For example because |l| can move
8833 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008834 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008835 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008836 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008837 It doesn't make sense to combine "all" with "onemore", but you will
8838 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008839 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008840 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008841
8842 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8843'visualbell' 'vb' boolean (default off)
8844 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008845 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008847 use: >
8848 :set vb t_vb=
8849< If you want a short flash, you can use this on many terminals: >
8850 :set vb t_vb=[?5h$<100>[?5l
8851< Here $<100> specifies the time, you can use a smaller or bigger value
8852 to get a shorter or longer flash.
8853
8854 Note: Vim will limit the bell to once per half a second. This avoids
8855 having to wait for the flashing to finish when there are lots of
8856 bells, e.g. on key repeat. This also happens without 'visualbell'
8857 set.
8858
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8860 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8861 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008862
8863 Note: When the GUI starts, 't_vb' is reset to its default value. You
8864 might want to set it again in your |gvimrc|.
8865
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 Does not work on the Amiga, you always get a screen flash.
8867 Also see 'errorbells'.
8868
8869 *'warn'* *'nowarn'*
8870'warn' boolean (default on)
8871 global
8872 Give a warning message when a shell command is used while the buffer
8873 has been changed.
8874
8875 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8876'weirdinvert' 'wiv' boolean (default off)
8877 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008878 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879 It is provided for backwards compatibility with version 4.x.
8880 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8881 vice versa. Has no effect when the GUI is running.
8882
8883 *'whichwrap'* *'ww'*
8884'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 Allow specified keys that move the cursor left/right to move to the
8887 previous/next line when the cursor is on the first/last character in
8888 the line. Concatenate characters to allow this for these keys:
8889 char key mode ~
8890 b <BS> Normal and Visual
8891 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008892 h "h" Normal and Visual (not recommended)
8893 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008894 < <Left> Normal and Visual
8895 > <Right> Normal and Visual
8896 ~ "~" Normal
8897 [ <Left> Insert and Replace
8898 ] <Right> Insert and Replace
8899 For example: >
8900 :set ww=<,>,[,]
8901< allows wrap only when cursor keys are used.
8902 When the movement keys are used in combination with a delete or change
8903 operator, the <EOL> also counts for a character. This makes "3h"
8904 different from "3dh" when the cursor crosses the end of a line. This
8905 is also true for "x" and "X", because they do the same as "dl" and
8906 "dh". If you use this, you may also want to use the mapping
8907 ":map <BS> X" to make backspace delete the character in front of the
8908 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008909 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008910 line (not an empty line) then it will not move to the next line. This
8911 makes "dl", "cl", "yl" etc. work normally.
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 *'wildchar'* *'wc'*
8916'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 Character you have to type to start wildcard expansion in the
8919 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008920 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 The character is not recognized when used inside a macro. See
8922 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008923 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008925 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926< NOTE: This option is set to the Vi default value when 'compatible' is
8927 set and to the Vim default value when 'compatible' is reset.
8928
8929 *'wildcharm'* *'wcm'*
8930'wildcharm' 'wcm' number (default: none (0))
8931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008932 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008933 recognized when used inside a macro. You can find "spare" command-line
8934 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935 you'll never actually type 'wildcharm', just use it in mappings that
8936 automatically invoke completion mode, e.g.: >
8937 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008938 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939< Then after typing :ss you can use CTRL-P & CTRL-N.
8940
8941 *'wildignore'* *'wig'*
8942'wildignore' 'wig' string (default "")
8943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 {not available when compiled without the |+wildignore|
8945 feature}
8946 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008947 patterns is ignored when expanding |wildcards|, completing file or
8948 directory names, and influences the result of |expand()|, |glob()| and
8949 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8951 Also see 'suffixes'.
8952 Example: >
8953 :set wildignore=*.o,*.obj
8954< The use of |:set+=| and |:set-=| is preferred when adding or removing
8955 a pattern from the list. This avoids problems when a future version
8956 uses another default.
8957
Bram Moolenaar94950a92010-12-02 16:01:29 +01008958
Bram Moolenaar81af9252010-12-10 20:35:50 +01008959 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008960'wildignorecase' 'wic' boolean (default off)
8961 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008962 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008963 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008964 Does not apply when the shell is used to expand wildcards, which
8965 happens when there are special characters.
8966
8967
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008969'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008970 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008971 {not available if compiled without the |+wildmenu|
8972 feature}
8973 When 'wildmenu' is on, command-line completion operates in an enhanced
8974 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8975 the possible matches are shown just above the command line, with the
8976 first match highlighted (overwriting the status line, if there is
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00008977 one). This is the behavior without "pum" in 'wildoptions.
8978 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00008979 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8980 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8981 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008982 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 If there are more matches than can fit in the line, a ">" is shown on
8984 the right and/or a "<" is shown on the left. The status line scrolls
8985 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00008986 When 'wildoptions' contains "pum", then the completion matches are
8987 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008988 The "wildmenu" mode is abandoned when a key is hit that is not used
8989 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00008990 While the "wildmenu" is active, not using the popup menu, the
8991 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992
8993 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8994 <Down> - in filename/menu name completion: move into a
8995 subdirectory or submenu.
8996 <CR> - in menu completion, when the cursor is just after a
8997 dot: move into a submenu.
8998 <Up> - in filename/menu name completion: move up into
8999 parent directory or parent menu.
9000
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009001 When using the popup menu for command line completion, the following
9002 keys have special meanings:
9003 <Down> - select next match (like CTRL-N)
9004 <Left> - in filename/menu name completion: move up into
9005 parent directory or parent menu.
9006 <Right> - in filename/menu name completion: move into a
9007 subdirectory or submenu.
9008 <Up> - select previous match (like CTRL-P)
9009 CTRL-E - end completion, go back to what was there before
9010 selecting a match.
9011 CTRL-N - go to the next entry
9012 CTRL-P - go to the previous entry
9013 CTRL-Y - accept the currently selected match and stop
9014 completion.
9015
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 This makes the menus accessible from the console |console-menus|.
9017
9018 If you prefer the <Left> and <Right> keys to move the cursor instead
9019 of selecting a different match, use this: >
9020 :cnoremap <Left> <Space><BS><Left>
9021 :cnoremap <Right> <Space><BS><Right>
9022<
9023 The "WildMenu" highlighting is used for displaying the current match
9024 |hl-WildMenu|.
9025
9026 *'wildmode'* *'wim'*
9027'wildmode' 'wim' string (Vim default: "full")
9028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009030 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009031 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 first part specifies the behavior for the first use of 'wildchar',
9033 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009034
9035 Each part consists of a colon separated list consisting of the
9036 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009037 "" Complete only the first match.
9038 "full" Complete the next full match. After the last match,
9039 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009040 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009041 "longest" Complete till longest common string. If this doesn't
9042 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009044 "lastused" When completing buffer names and more than one buffer
9045 matches, sort buffers by time last used (other than
9046 the current buffer).
9047 When there is only a single match, it is fully completed in all cases.
9048
9049 Examples of useful colon-separated values:
9050 "longest:full" Like "longest", but also start 'wildmenu' if it is
9051 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 "list:full" When more than one match, list all matches and
9053 complete first match.
9054 "list:longest" When more than one match, list all matches and
9055 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009056 "list:lastused" When more than one buffer matches, list all matches
9057 and sort buffers by time last used (other than the
9058 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059
9060 Examples: >
9061 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009062< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 :set wildmode=longest,full
9064< Complete longest common string, then each full match >
9065 :set wildmode=list:full
9066< List all matches and complete each full match >
9067 :set wildmode=list,full
9068< List all matches without completing, then each full match >
9069 :set wildmode=longest,list
9070< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009071 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009073 *'wildoptions'* *'wop'*
9074'wildoptions' 'wop' string (default "")
9075 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009076 {not available when compiled without the |+wildignore|
9077 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009078 A list of words that change how |cmdline-completion| is done.
9079 The following values are supported:
9080 pum Display the completion matches using the popupmenu
9081 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009082 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009083 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009084 is displayed per line. Often used tag kinds are:
9085 d #define
9086 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009087
Bram Moolenaar071d4272004-06-13 20:20:40 +00009088 *'winaltkeys'* *'wak'*
9089'winaltkeys' 'wak' string (default "menu")
9090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009091 {only used in Win32, Motif, GTK and Photon GUI}
9092 Some GUI versions allow the access to menu entries by using the ALT
9093 key in combination with a character that appears underlined in the
9094 menu. This conflicts with the use of the ALT key for mappings and
9095 entering special characters. This option tells what to do:
9096 no Don't use ALT keys for menus. ALT key combinations can be
9097 mapped, but there is no automatic handling. This can then be
9098 done with the |:simalt| command.
9099 yes ALT key handling is done by the windowing system. ALT key
9100 combinations cannot be mapped.
9101 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009102 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 keys can be mapped.
9104 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9105 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009106 This option is not used for <F10>; on Win32 and with GTK <F10> will
9107 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009109 *'wincolor'* *'wcr'*
9110'wincolor' 'wcr' string (default empty)
9111 local to window
9112 Highlight group name to use for this window instead of the Normal
9113 color |hl-Normal|.
9114
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009115 *'window'* *'wi'*
9116'window' 'wi' number (default screen height - 1)
9117 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009118 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9119 window and the value is smaller than 'lines' minus one. The screen
9120 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009121 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9122 in a much smarter way, taking care of wrapping lines.
9123 When resizing the Vim window, the value is smaller than 1 or more than
9124 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009125 Note: Do not confuse this with the height of the Vim window, use
9126 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009127
Bram Moolenaar071d4272004-06-13 20:20:40 +00009128 *'winheight'* *'wh'* *E591*
9129'winheight' 'wh' number (default 1)
9130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009131 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009132 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009133 focus goes to a window that is smaller, its size is increased, at the
9134 cost of the height of other windows.
9135 Set 'winheight' to a small number for normal editing.
9136 Set it to 999 to make the current window fill most of the screen.
9137 Other windows will be only 'winminheight' high. This has the drawback
9138 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9139 to create only two windows, set the option after startup is done,
9140 using the |VimEnter| event: >
9141 au VimEnter * set winheight=999
9142< Minimum value is 1.
9143 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 height of the current window.
9145 'winheight' applies to the current window. Use 'winminheight' to set
9146 the minimal height for other windows.
9147
9148 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9149'winfixheight' 'wfh' boolean (default off)
9150 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009151 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009152 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9153 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009154 The height may be changed anyway when running out of room.
9155
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009156 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9157'winfixwidth' 'wfw' boolean (default off)
9158 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009159 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009160 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009161 The width may be changed anyway when running out of room.
9162
Bram Moolenaar071d4272004-06-13 20:20:40 +00009163 *'winminheight'* *'wmh'*
9164'winminheight' 'wmh' number (default 1)
9165 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009166 The minimal height of a window, when it's not the current window.
9167 This is a hard minimum, windows will never become smaller.
9168 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9169 status bar) if necessary. They will return to at least one line when
9170 they become active (since the cursor has to have somewhere to go.)
9171 Use 'winheight' to set the minimal height of the current window.
9172 This option is only checked when making a window smaller. Don't use a
9173 large number, it will cause errors when opening more than a few
9174 windows. A value of 0 to 3 is reasonable.
9175
9176 *'winminwidth'* *'wmw'*
9177'winminwidth' 'wmw' number (default 1)
9178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009179 The minimal width of a window, when it's not the current window.
9180 This is a hard minimum, windows will never become smaller.
9181 When set to zero, windows may be "squashed" to zero columns (i.e. just
9182 a vertical separator) if necessary. They will return to at least one
9183 line when they become active (since the cursor has to have somewhere
9184 to go.)
9185 Use 'winwidth' to set the minimal width of the current window.
9186 This option is only checked when making a window smaller. Don't use a
9187 large number, it will cause errors when opening more than a few
9188 windows. A value of 0 to 12 is reasonable.
9189
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009190 *'winptydll'*
9191'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9192 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009193 {only available when compiled with the |terminal|
9194 feature on MS-Windows}
9195 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009196 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009197 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009198 a fallback.
9199 Environment variables are expanded |:set_env|.
9200 This option cannot be set from a |modeline| or in the |sandbox|, for
9201 security reasons.
9202
Bram Moolenaar071d4272004-06-13 20:20:40 +00009203 *'winwidth'* *'wiw'* *E592*
9204'winwidth' 'wiw' number (default 20)
9205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009206 Minimal number of columns for the current window. This is not a hard
9207 minimum, Vim will use fewer columns if there is not enough room. If
9208 the current window is smaller, its size is increased, at the cost of
9209 the width of other windows. Set it to 999 to make the current window
9210 always fill the screen. Set it to a small number for normal editing.
9211 The width is not adjusted after one of the commands to change the
9212 width of the current window.
9213 'winwidth' applies to the current window. Use 'winminwidth' to set
9214 the minimal width for other windows.
9215
9216 *'wrap'* *'nowrap'*
9217'wrap' boolean (default on)
9218 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 This option changes how text is displayed. It doesn't change the text
9220 in the buffer, see 'textwidth' for that.
9221 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009222 displaying continues on the next line. When off lines will not wrap
9223 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 moved to a part that is not shown, the screen will scroll
9225 horizontally.
9226 The line will be broken in the middle of a word if necessary. See
9227 'linebreak' to get the break at a word boundary.
9228 To make scrolling horizontally a bit more useful, try this: >
9229 :set sidescroll=5
9230 :set listchars+=precedes:<,extends:>
9231< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009232 This option can't be set from a |modeline| when the 'diff' option is
9233 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234
9235 *'wrapmargin'* *'wm'*
9236'wrapmargin' 'wm' number (default 0)
9237 local to buffer
9238 Number of characters from the right window border where wrapping
9239 starts. When typing text beyond this limit, an <EOL> will be inserted
9240 and inserting continues on the next line.
9241 Options that add a margin, such as 'number' and 'foldcolumn', cause
9242 the text width to be further reduced. This is Vi compatible.
9243 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009244 This option is set to 0 when 'paste' is set and restored when 'paste'
9245 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009246 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009247
9248 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9249'wrapscan' 'ws' boolean (default on) *E384* *E385*
9250 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009251 Searches wrap around the end of the file. Also applies to |]s| and
9252 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009253
9254 *'write'* *'nowrite'*
9255'write' boolean (default on)
9256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009257 Allows writing files. When not set, writing a file is not allowed.
9258 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009259 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009260 argument. Filtering text is still possible, even though this requires
9261 writing a temporary file.
9262
9263 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9264'writeany' 'wa' boolean (default off)
9265 global
9266 Allows writing to any file with no need for "!" override.
9267
9268 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9269'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9270 otherwise)
9271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009272 Make a backup before overwriting a file. The backup is removed after
9273 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009274 also on.
9275 WARNING: Switching this option off means that when Vim fails to write
9276 your buffer correctly and then, for whatever reason, Vim exits, you
9277 lose both the original file and what you were writing. Only reset
9278 this option if your file system is almost full and it makes the write
9279 fail (and make sure not to exit Vim until the write was successful).
9280 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009282 Depending on 'backupcopy' the backup is a new file or the original
9283 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009284 NOTE: This option is set to the default value when 'compatible' is
9285 set.
9286
9287 *'writedelay'* *'wd'*
9288'writedelay' 'wd' number (default 0)
9289 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009290 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009291 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009292 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009293
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009294 *'xtermcodes'* *'noxtermcodes'*
9295'xtermcodes' boolean (default on)
9296 global
9297 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009298 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009299 key codes and number of colors from the terminal. This takes care of
9300 various configuration options of the terminal that cannot be obtained
9301 from the termlib/terminfo entry, see |xterm-codes|.
9302 A side effect may be that t_Co changes and Vim will redraw the
9303 display.
9304
9305
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009306 vim:tw=78:ts=8:noet:ft=help:norl: