blob: bdc25223f4fe1c54b3fcc7ea8d919e8984cbf72d [file] [log] [blame]
Bram Moolenaar46eea442022-03-30 10:51:39 +01001*options.txt* For Vim version 8.2. Last change: 2022 Mar 29
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)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000386
387Set to a script-local function: >
388 set opfunc=s:MyLocalFunc
389 set opfunc=<SID>MyLocalFunc
390In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
391the script: >
392 set opfunc=MyLocalFunc
393
394Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000395 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000396 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000397
398Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000399 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000400
401Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000402 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000403 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000404
405In Vim9 script, in a compiled function, you can use a lambda, but a
406closured does not work, because the function will be called without the
407context of where it was defined.
408
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000409
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410Setting the filetype
411
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200412:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 Set the 'filetype' option to {filetype}, but only if
414 not done yet in a sequence of (nested) autocommands.
415 This is short for: >
416 :if !did_filetype()
417 : setlocal filetype={filetype}
418 :endif
419< This command is used in a filetype.vim file to avoid
420 setting the 'filetype' option twice, causing different
421 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200422
423 When the optional FALLBACK argument is present, a
424 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100425 'filetype'. This is to be used for filetype
426 detections that are just a guess. |did_filetype()|
427 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200428
Bram Moolenaard58e9292011-02-09 17:07:58 +0100429 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
431:opt[ions] Open a window for viewing and setting all options.
432 Options are grouped by function.
433 Offers short help for each option. Hit <CR> on the
434 short help to open a help window with more help for
435 the option.
436 Modify the value of the option and hit <CR> on the
437 "set" line to set the new value. For window and
438 buffer specific options, the last accessed window is
439 used to set the option value in, unless this is a help
440 window, in which case the window below help window is
441 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100442 {not available when compiled without the |+eval|
443 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444
445 *$HOME*
446Using "~" is like using "$HOME", but it is only recognized at the start of an
447option and after a space or comma.
448
449On Unix systems "~user" can be used too. It is replaced by the home directory
450of user "user". Example: >
451 :set path=~mool/include,/usr/include,.
452
453On Unix systems the form "${HOME}" can be used too. The name between {} can
454contain non-id characters then. Note that if you want to use this for the
455"gf" command, you need to add the '{' and '}' characters to 'isfname'.
456
457NOTE: expanding environment variables and "~/" is only done with the ":set"
458command, not when assigning a value to an option with ":let".
459
Bram Moolenaarc572da52017-08-27 16:52:01 +0200460 *$HOME-windows*
461On MS-Windows, if $HOME is not defined as an environment variable, then
462at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200463If $HOMEDRIVE is not set then $USERPROFILE is used.
464
465This expanded value is not exported to the environment, this matters when
466running an external command: >
467 :echo system('set | findstr ^HOME=')
468and >
469 :echo luaeval('os.getenv("HOME")')
470should echo nothing (an empty string) despite exists('$HOME') being true.
471When setting $HOME to a non-empty string it will be exported to the
472subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200473
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475Note the maximum length of an expanded option is limited. How much depends on
476the system, mostly it is something like 256 or 1024 characters.
477
478 *:fix* *:fixdel*
479:fix[del] Set the value of 't_kD':
480 't_kb' is 't_kD' becomes ~
481 CTRL-? CTRL-H
482 not CTRL-? CTRL-?
483
Bram Moolenaar82be4842021-01-11 19:40:15 +0100484 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485
486 If your delete key terminal code is wrong, but the
487 code for backspace is alright, you can put this in
488 your .vimrc: >
489 :fixdel
490< This works no matter what the actual code for
491 backspace is.
492
493 If the backspace key terminal code is wrong you can
494 use this: >
495 :if &term == "termname"
496 : set t_kb=^V<BS>
497 : fixdel
498 :endif
499< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000500 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 with your terminal name.
502
503 If your <Delete> key sends a strange key sequence (not
504 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
505 :if &term == "termname"
506 : set t_kD=^V<Delete>
507 :endif
508< Where "^V" is CTRL-V and "<Delete>" is the delete key
509 (don't type eight characters!). Replace "termname"
510 with your terminal name.
511
512 *Linux-backspace*
513 Note about Linux: By default the backspace key
514 produces CTRL-?, which is wrong. You can fix it by
515 putting this line in your rc.local: >
516 echo "keycode 14 = BackSpace" | loadkeys
517<
518 *NetBSD-backspace*
519 Note about NetBSD: If your backspace doesn't produce
520 the right code, try this: >
521 xmodmap -e "keycode 22 = BackSpace"
522< If this works, add this in your .Xmodmap file: >
523 keysym 22 = BackSpace
524< You need to restart for this to take effect.
525
526==============================================================================
5272. Automatically setting options *auto-setting*
528
529Besides changing options with the ":set" command, there are three alternatives
530to set options automatically for one or more files:
531
5321. When starting Vim initializations are read from various places. See
533 |initialization|. Most of them are performed for all editing sessions,
534 and some of them depend on the directory where Vim is started.
535 You can create an initialization file with |:mkvimrc|, |:mkview| and
536 |:mksession|.
5372. If you start editing a new file, the automatic commands are executed.
538 This can be used to set options for files matching a particular pattern and
539 many other things. See |autocommand|.
5403. If you start editing a new file, and the 'modeline' option is on, a
541 number of lines at the beginning and end of the file are checked for
542 modelines. This is explained here.
543
544 *modeline* *vim:* *vi:* *ex:* *E520*
545There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100546 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100548[text{white}] empty or any text followed by at least one blank
549 character (<Space> or <Tab>); "ex:" always requires at
550 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200551{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552[white] optional white space
553{options} a list of option settings, separated with white space
554 or ':', where each part between ':' is the argument
555 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
Bram Moolenaar14b69452013-06-29 23:05:20 +0200557Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000558 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200559 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560
561The second form (this is compatible with some versions of Vi):
562
Bram Moolenaarade0d392020-01-21 22:33:58 +0100563 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaarade0d392020-01-21 22:33:58 +0100565[text{white}] empty or any text followed by at least one blank
566 character (<Space> or <Tab>); "ex:" always requires at
567 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200568{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
569[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200570se[t] the string "set " or "se " (note the space); When
571 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200572{options} a list of options, separated with white space, which
573 is the argument for a ":set" command
574: a colon
575[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
Bram Moolenaar14b69452013-06-29 23:05:20 +0200577Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000578 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200579 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200581The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
582chance that a normal word like "lex:" is caught. There is one exception:
583"vi:" and "vim:" can also be at the start of the line (for compatibility with
584version 3.0). Using "ex:" at the start of the line will be ignored (this
585could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586
Hu Jialun9dcd3492021-08-28 20:42:50 +0200587If the modeline is disabled within a modeline, subsequent modelines will be
588ignored. This is to allow turning off modeline on a per-file basis. This is
589useful when a line looks like a modeline but isn't. For example, it would be
590good to start a YAML file containing strings like "vim:" with
591 # vim: nomodeline ~
592so as to avoid modeline misdetection. Following options on the same line
593after modeline deactivation, if any, are still evaluated (but you would
594normally not have any).
595
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 *modeline-local*
597The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000598buffer and window that contain the file. Although it's possible to set global
599options from a modeline, this is unusual. If you have two windows open and
600the files in it set the same global option to a different value, the result
601depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000603When editing a file that was already loaded, only the window-local options
604from the modeline are used. Thus if you manually changed a buffer-local
605option after opening the file, it won't be changed if you edit the same buffer
606in another window. But window-local options will be set.
607
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 *modeline-version*
609If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200610number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 vim{vers}: version {vers} or later
612 vim<{vers}: version before {vers}
613 vim={vers}: version {vers}
614 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100615{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
616For example, to use a modeline only for Vim 7.0:
617 /* vim700: set foldmethod=marker */ ~
618To use a modeline for Vim after version 7.2:
619 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620There can be no blanks between "vim" and the ":".
621
622
623The number of lines that are checked can be set with the 'modelines' option.
624If 'modeline' is off or 'modelines' is 0 no lines are checked.
625
626Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000627like:
628 /* vi:ts=4: */ ~
629will give an error message for the trailing "*/". This line is OK:
630 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
632If an error is detected the rest of the line is skipped.
633
634If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000635backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100636 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
637This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
638before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200639 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000641might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200642can be set. For some options a flag is set, so that when the value is used
643the |sandbox| is effective. Some options can only be set from the modeline
644when 'modelineexpr' is set (the default is off).
645
646Still, there is always a small risk that a modeline causes trouble. E.g.,
647when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
648So disable modelines before editing untrusted text. The mail ftplugin does
649this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651Hint: If you would like to do something else than setting an option, you could
652define an autocommand that checks the file for a specific string. For
653example: >
654 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
655And define a function SetVar() that does something with the line containing
656"VAR".
657
658==============================================================================
6593. Options summary *option-summary*
660
661In the list below all the options are mentioned with their full name and with
662an abbreviation if there is one. Both forms may be used.
663
664In this document when a boolean option is "set" that means that ":set option"
665is entered. When an option is "reset", ":set nooption" is used.
666
667For some options there are two default values: The "Vim default", which is
668used when 'compatible' is not set, and the "Vi default", which is used when
669'compatible' is set.
670
671Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000672are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673different value in each window. For example the 'list' option can be set in
674one window and reset in another for the same text, giving both types of view
675at the same time. There are a few options that are specific to a certain
676file. These can have a different value for each file or buffer. For example
677the 'textwidth' option can be 78 for a normal text file and 0 for a C
678program.
679
680 global one option for all buffers and windows
681 local to window each window has its own copy of this option
682 local to buffer each buffer has its own copy of this option
683
684When creating a new window the option values from the currently active window
685are used as a default value for the window-specific options. For the
686buffer-specific options this depends on the 's' and 'S' flags in the
687'cpoptions' option. If 's' is included (which is the default) the values for
688buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000689first entered. If 'S' is present the options are copied each time the buffer
690is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691present, the options are copied from the currently active buffer when the
692buffer is created.
693
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000694Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000696Not all options are supported in all versions. This depends on the supported
697features and sometimes on the system. A remark about this is in curly braces
698below. When an option is not supported it may still be set without getting an
699error, this is called a hidden option. You can't get the value of a hidden
700option though, it is not stored.
701
702To test if option "foo" can be used with ":set" use something like this: >
703 if exists('&foo')
704This also returns true for a hidden option. To test if option "foo" is really
705supported use something like this: >
706 if exists('+foo')
707<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 *E355*
709A jump table for the options with a short description can be found at |Q_op|.
710
711 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100712'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 {only available when compiled with the |+rightleft|
715 feature}
716 The ASCII code for the first letter of the Hebrew alphabet. The
717 routine that maps the keyboard in Hebrew mode, both in Insert mode
718 (when hkmap is set) and on the command-line (when hitting CTRL-_)
719 outputs the Hebrew characters in the range [aleph..aleph+26].
720 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
721 See |rileft.txt|.
722
723 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
724'allowrevins' 'ari' boolean (default off)
725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 {only available when compiled with the |+rightleft|
727 feature}
728 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
729 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
730 into reverse Insert mode, and don't know how to get out. See
731 'revins'.
732 NOTE: This option is reset when 'compatible' is set.
733
734 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
735'altkeymap' 'akm' boolean (default off)
736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 {only available when compiled with the |+farsi|
738 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100739 This option was for using Farsi, which has been removed. See
740 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741
742 *'ambiwidth'* *'ambw'*
743'ambiwidth' 'ambw' string (default: "single")
744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
746 Tells Vim what to do with characters with East Asian Width Class
747 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
748 letters, Cyrillic letters).
749
750 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000751 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 expected by most users.
753 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200754 *E834* *E835*
755 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100756 contains a character that would be double width. These errors may
757 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200758
759 The values are overruled for characters specified with
760 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
762 There are a number of CJK fonts for which the width of glyphs for
763 those characters are solely based on how many octets they take in
764 legacy/traditional CJK encodings. In those encodings, Euro,
765 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000766 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000768 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Vim is running inside a terminal (emulators) that uses a CJK font
770 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
771 this option should be set to "double" to match the width perceived
772 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100773 to be set to "double" under CJK MS-Windows when the system locale is
774 set to one of CJK locales. See Unicode Standard Annex #11
775 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100777 Vim may set this option automatically at startup time when Vim is
778 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200779 escape sequence to request cursor position report. The response can
780 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100781
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
783'antialias' 'anti' boolean (default: off)
784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200786 on macOS}
787 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
789 which can be easier to read at certain sizes on certain displays.
790 Setting this option can sometimes cause problems if 'guifont' is set
791 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100792 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
795'autochdir' 'acd' boolean (default off)
796 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200797 {only available when compiled with it, use
798 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000799 When on, Vim will change the current working directory whenever you
800 open a file, switch buffers, delete a buffer or open/close a window.
801 It will change to the directory containing the file which was opened
802 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000803 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200805 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
806'autoshelldir' 'asd' boolean (default off)
807 global
808 When on, Vim will change the current working directory whenever you
809 change the directory of the shell running in a terminal window. You
810 need proper setting-up, so whenever the shell's pwd changes an OSC 7
811 escape sequence will be emitted. For example, on Linux, you can source
812 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000813 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200814
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
816'arabic' 'arab' boolean (default off)
817 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 {only available when compiled with the |+arabic|
819 feature}
820 This option can be set to start editing Arabic text.
821 Setting this option will:
822 - Set the 'rightleft' option, unless 'termbidi' is set.
823 - Set the 'arabicshape' option, unless 'termbidi' is set.
824 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
825 between typing English and Arabic key mapping.
826 - Set the 'delcombine' option
827 Note that 'encoding' must be "utf-8" for working with Arabic text.
828
829 Resetting this option will:
830 - Reset the 'rightleft' option.
831 - Disable the use of 'keymap' (without changing its value).
832 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200833 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100834 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Also see |arabic.txt|.
836
837 *'arabicshape'* *'arshape'*
838 *'noarabicshape'* *'noarshape'*
839'arabicshape' 'arshape' boolean (default on)
840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 {only available when compiled with the |+arabic|
842 feature}
843 When on and 'termbidi' is off, the required visual character
844 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200845 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 one which encompasses:
847 a) the changing/morphing of characters based on their location
848 within a word (initial, medial, final and stand-alone).
849 b) the enabling of the ability to compose characters
850 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100851 When disabled the display shows each character's true stand-alone
852 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 Arabic is a complex language which requires other settings, for
854 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100855 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
857 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
858'autoindent' 'ai' boolean (default off)
859 local to buffer
860 Copy indent from current line when starting a new line (typing <CR>
861 in Insert mode or when using the "o" or "O" command). If you do not
862 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000863 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
864 to another line has the same effect, unless the 'I' flag is included
865 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000866 When autoindent is on, formatting (with the "gq" command or when you
867 reach 'textwidth' in Insert mode) uses the indentation of the first
868 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 When 'smartindent' or 'cindent' is on the indent is changed in
870 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200871 The 'autoindent' option is reset when the 'paste' option is set and
872 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873
874 *'autoread'* *'ar'* *'noautoread'* *'noar'*
875'autoread' 'ar' boolean (default off)
876 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 When a file has been detected to have been changed outside of Vim and
878 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200879 When the file has been deleted this is not done, so you have the text
880 from before it was deleted. When it appears again then it is read.
881 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 If this option has a local value, use this command to switch back to
883 using the global value: >
884 :set autoread<
885<
886 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
887'autowrite' 'aw' boolean (default off)
888 global
889 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000890 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000891 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
892 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000893 to another file.
894 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000895 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 Note that for some commands the 'autowrite' option is not used, see
897 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200898 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200899 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
901 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
902'autowriteall' 'awa' boolean (default off)
903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
905 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
906 Setting this option also implies that Vim behaves like 'autowrite' has
907 been set.
908
909 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200910'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 When set to "dark", Vim will try to use colors that look good on a
913 dark background. When set to "light", Vim will try to use colors that
914 look good on a light background. Any other value is illegal.
915 Vim tries to set the default value according to the terminal used.
916 This will not always be correct.
917 Setting this option does not change the background color, it tells Vim
918 what the background color looks like. For changing the background
919 color, see |:hi-normal|.
920
921 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000922 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000923 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100924 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 setting 'background' will cause the color scheme to be reloaded. If
926 the color scheme adjusts to the value of 'background' this will work.
927 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100928 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 When setting 'background' to the default value with: >
931 :set background&
932< Vim will guess the value. In the GUI this should work correctly,
933 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200934 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200935 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200937 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200938 color from the terminal. If the returned RGB value is dark/light and
939 'background' is not dark/light, 'background' will be set and the
940 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200941 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100942 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200943
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 When starting the GUI, the default value for 'background' will be
945 "light". When the value is not set in the .gvimrc, and Vim detects
946 that the background is actually quite dark, 'background' is set to
947 "dark". But this happens only AFTER the .gvimrc file has been read
948 (because the window needs to be opened to find the actual background
949 color). To get around this, force the GUI window to be opened by
950 putting a ":gui" command in the .gvimrc file, before where the value
951 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200952
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100953 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200954 For other systems "dark" is used when 'term' is "linux",
955 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
956 background. Otherwise the default is "light".
957
Bram Moolenaarc572da52017-08-27 16:52:01 +0200958 The |:terminal| command and the |term_start()| function use the
959 'background' value to decide whether the terminal window will start
960 with a white or black background.
961
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 Normally this option would be set in the .vimrc file. Possibly
963 depending on the terminal name. Example: >
964 :if &term == "pcterm"
965 : set background=dark
966 :endif
967< When this option is set, the default settings for the highlight groups
968 will change. To use other settings, place ":highlight" commands AFTER
969 the setting of the 'background' option.
970 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
971 to select the colors for syntax highlighting. After changing this
972 option, you must load syntax.vim again to see the result. This can be
973 done with ":syntax on".
974
975 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200976'backspace' 'bs' string (default "", set to "indent,eol,start"
977 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
980 mode. This is a list of items, separated by commas. Each item allows
981 a way to backspace over something:
982 value effect ~
983 indent allow backspacing over autoindent
984 eol allow backspacing over line breaks (join lines)
985 start allow backspacing over the start of insert; CTRL-W and CTRL-U
986 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200987 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
988 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989
Bram Moolenaar46eea442022-03-30 10:51:39 +0100990 When the value is empty, Vi compatible backspacing is used, none of
991 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992
993 For backwards compatibility with version 5.4 and earlier:
994 value effect ~
995 0 same as ":set backspace=" (Vi compatible)
996 1 same as ":set backspace=indent,eol"
997 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200998 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999
1000 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1001 NOTE: This option is set to "" when 'compatible' is set.
1002
1003 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1004'backup' 'bk' boolean (default off)
1005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 Make a backup before overwriting a file. Leave it around after the
1007 file has been successfully written. If you do not want to keep the
1008 backup file, but you do want a backup while the file is being
1009 written, reset this option and set the 'writebackup' option (this is
1010 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001011 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 |backup-table| for more explanations.
1013 When the 'backupskip' pattern matches, a backup is not made anyway.
1014 When 'patchmode' is set, the backup may be renamed to become the
1015 oldest version of a file.
1016 NOTE: This option is reset when 'compatible' is set.
1017
1018 *'backupcopy'* *'bkc'*
1019'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001020 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 When writing a file and a backup is made, this option tells how it's
1022 done. This is a comma separated list of words.
1023
1024 The main values are:
1025 "yes" make a copy of the file and overwrite the original one
1026 "no" rename the file and write a new one
1027 "auto" one of the previous, what works best
1028
1029 Extra values that can be combined with the ones above are:
1030 "breaksymlink" always break symlinks when writing
1031 "breakhardlink" always break hardlinks when writing
1032
1033 Making a copy and overwriting the original file:
1034 - Takes extra time to copy the file.
1035 + When the file has special attributes, is a (hard/symbolic) link or
1036 has a resource fork, all this is preserved.
1037 - When the file is a link the backup will have the name of the link,
1038 not of the real file.
1039
1040 Renaming the file and writing a new one:
1041 + It's fast.
1042 - Sometimes not all attributes of the file can be copied to the new
1043 file.
1044 - When the file is a link the new file will not be a link.
1045
1046 The "auto" value is the middle way: When Vim sees that renaming file
1047 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001048 the file is not a link) that is used. When problems are expected, a
1049 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
1051 The "breaksymlink" and "breakhardlink" values can be used in
1052 combination with any of "yes", "no" and "auto". When included, they
1053 force Vim to always break either symbolic or hard links by doing
1054 exactly what the "no" option does, renaming the original file to
1055 become the backup and writing a new file in its place. This can be
1056 useful for example in source trees where all the files are symbolic or
1057 hard links and any changes should stay in the local source tree, not
1058 be propagated back to the original source.
1059 *crontab*
1060 One situation where "no" and "auto" will cause problems: A program
1061 that opens a file, invokes Vim to edit that file, and then tests if
1062 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001063 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 example.
1065
1066 When a copy is made, the original file is truncated and then filled
1067 with the new text. This means that protection bits, owner and
1068 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001069 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 group of the backup is set to the group of the original file. If this
1071 fails, the protection bits for the group are made the same as for
1072 others.
1073
1074 When the file is renamed this is the other way around: The backup has
1075 the same attributes of the original file, and the newly written file
1076 is owned by the current user. When the file was a (hard/symbolic)
1077 link, the new file will not! That's why the "auto" value doesn't
1078 rename when the file is a link. The owner and group of the newly
1079 written file will be set to the same ones as the original file, but
1080 the system may refuse to do this. In that case the "auto" value will
1081 again not rename the file.
1082
Bram Moolenaar036986f2017-03-16 17:41:02 +01001083 NOTE: This option is set to the Vi default value when 'compatible' is
1084 set and to the Vim default value when 'compatible' is reset.
1085
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 *'backupdir'* *'bdir'*
1087'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001088 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 for Unix: ".,~/tmp,~/")
1090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 List of directories for the backup file, separated with commas.
1092 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001093 where this is possible. The directory must exist, Vim will not
1094 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001095 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 impossible!). Writing may fail because of this.
1097 - A directory "." means to put the backup file in the same directory
1098 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001099 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1100 the backup file relative to where the edited file is. The leading
1101 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 ("." inside a directory name has no special meaning).
1103 - Spaces after the comma are ignored, other spaces are considered part
1104 of the directory name. To have a space at the start of a directory
1105 name, precede it with a backslash.
1106 - To include a comma in a directory name precede it with a backslash.
1107 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001108 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001109 the backup file name will be built from the complete path to the
1110 file with all path separators changed to percent '%' signs. This
1111 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001112 On Win32, it is also possible to end with "\\". However, When a
1113 separating comma is following, you must use "//", since "\\" will
1114 include the comma in the file name. Therefore it is recommended to
1115 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 - Environment variables are expanded |:set_env|.
1117 - Careful with '\' characters, type one before a space, type two to
1118 get one in the option (see |option-backslash|), for example: >
1119 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1120< - For backwards compatibility with Vim version 3.0 a '>' at the start
1121 of the option is removed.
1122 See also 'backup' and 'writebackup' options.
1123 If you want to hide your backup files on Unix, consider this value: >
1124 :set backupdir=./.backup,~/.backup,.,/tmp
1125< You must create a ".backup" directory in each directory and in your
1126 home directory for this to work properly.
1127 The use of |:set+=| and |:set-=| is preferred when adding or removing
1128 directories from the list. This avoids problems when a future version
1129 uses another default.
1130 This option cannot be set from a |modeline| or in the |sandbox|, for
1131 security reasons.
1132
1133 *'backupext'* *'bex'* *E589*
1134'backupext' 'bex' string (default "~", for VMS: "_")
1135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 String which is appended to a file name to make the name of the
1137 backup file. The default is quite unusual, because this avoids
1138 accidentally overwriting existing files with a backup file. You might
1139 prefer using ".bak", but make sure that you don't have files with
1140 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001141 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001143 If you like to keep a lot of backups, you could use a BufWritePre
1144 autocommand to change 'backupext' just before writing the file to
1145 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001146 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001147< Use 'backupdir' to put the backup in a different directory.
1148
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001150'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1151 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1152 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 {not available when compiled without the |+wildignore|
1155 feature}
1156 A list of file patterns. When one of the patterns matches with the
1157 name of the file which is written, no backup file is created. Both
1158 the specified file name and the full path name of the file are used.
1159 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1160 Watch out for special characters, see |option-backslash|.
1161 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001162 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001163
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001164 WARNING: Not having a backup file means that when Vim fails to write
1165 your buffer correctly and then, for whatever reason, Vim exits, you
1166 lose both the original file and what you were writing. Only disable
1167 backups if you don't care about losing the file.
1168
Bram Moolenaar02467872007-05-06 13:22:01 +00001169 Note that environment variables are not expanded. If you want to use
1170 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001171 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001172
1173< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001174 backup would be made by renaming the original file crontab won't see
1175 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176
1177 *'balloondelay'* *'bdlay'*
1178'balloondelay' 'bdlay' number (default: 600)
1179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 {only available when compiled with the |+balloon_eval|
1181 feature}
1182 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1183
1184 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1185'ballooneval' 'beval' boolean (default off)
1186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001188 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001189 Switch on the |balloon-eval| functionality for the GUI.
1190
1191 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1192 *'nobevalterm'*
1193'balloonevalterm' 'bevalterm' boolean (default off)
1194 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001195 {only available when compiled with the
1196 |+balloon_eval_term| feature}
1197 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001199 *'balloonexpr'* *'bexpr'*
1200'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001201 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001202 {only available when compiled with the |+balloon_eval|
1203 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001204 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001205 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1206 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001207
1208 v:beval_bufnr number of the buffer in which balloon is going to show
1209 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001210 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001211 v:beval_lnum line number
1212 v:beval_col column number (byte index)
1213 v:beval_text word under or after the mouse pointer
1214
Bram Moolenaar54775062019-07-31 21:07:14 +02001215 Instead of showing a balloon, which is limited to plain text, consider
1216 using a popup window, see |popup_beval_example|. A popup window can
1217 use highlighting and show a border.
1218
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001219 The evaluation of the expression must not have side effects!
1220 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001221 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001222 return 'Cursor is at line ' .. v:beval_lnum ..
1223 \ ', column ' .. v:beval_col ..
1224 \ ' of file ' .. bufname(v:beval_bufnr) ..
1225 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001226 endfunction
1227 set bexpr=MyBalloonExpr()
1228 set ballooneval
1229<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001230 Also see |balloon_show()|, it can be used if the content of the balloon
1231 is to be fetched asynchronously. In that case evaluating
1232 'balloonexpr' should result in an empty string. If you get a balloon
1233 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001234
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001235 NOTE: The balloon is displayed only if the cursor is on a text
1236 character. If the result of evaluating 'balloonexpr' is not empty,
1237 Vim does not try to send a message to an external debugger (Netbeans
1238 or Sun Workshop).
1239
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001240 If the expression starts with s: or |<SID>|, then it is replaced with
1241 the script ID (|local-function|). Example: >
1242 set bexpr=s:MyBalloonExpr()
1243 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001244< Otherwise, the expression is evaluated in the context of the script
1245 where the option was set, thus script-local items are available.
1246
Bram Moolenaar30b65812012-07-12 22:01:11 +02001247 The expression will be evaluated in the |sandbox| when set from a
1248 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001249 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001250
1251 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001252 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001253
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001254 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001255 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001256< When they are supported "\n" characters will start a new line. If the
1257 expression evaluates to a |List| this is equal to using each List item
1258 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001259 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001260
Bram Moolenaar165bc692015-07-21 17:53:25 +02001261 *'belloff'* *'bo'*
1262'belloff' 'bo' string (default "")
1263 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001264 Specifies for which events the bell will not be rung. It is a comma
1265 separated list of items. For each item that is present, the bell
1266 will be silenced. This is most useful to specify specific events in
1267 insert mode to be silenced.
1268
1269 item meaning when present ~
1270 all All events.
1271 backspace When hitting <BS> or <Del> and deleting results in an
1272 error.
1273 cursor Fail to move around using the cursor keys or
1274 <PageUp>/<PageDown> in |Insert-mode|.
1275 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1276 |i_CTRL-X_CTRL-T|.
1277 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1278 |i_CTRL-E|.
1279 ctrlg Unknown Char after <C-G> in Insert mode.
1280 error Other Error occurred (e.g. try to join last line)
1281 (mostly used in |Normal-mode| or |Cmdline-mode|).
1282 esc hitting <Esc> in |Normal-mode|.
1283 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001284 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001285 insertmode Pressing <Esc> in 'insertmode'.
1286 lang Calling the beep module for Lua/Mzscheme/TCL.
1287 mess No output available for |g<|.
1288 showmatch Error occurred for 'showmatch' function.
1289 operator Empty region error |cpo-E|.
1290 register Unknown register after <C-R> in |Insert-mode|.
1291 shell Bell from shell output |:!|.
1292 spell Error happened on spell suggest.
1293 wildmode More matches in |cmdline-completion| available
1294 (depends on the 'wildmode' setting).
1295
Bram Moolenaar036986f2017-03-16 17:41:02 +01001296 This is most useful to fine tune when in Insert mode the bell should
1297 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001298 indicate that an error occurred. It can be silenced by adding the
1299 "error" keyword.
1300
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1302'binary' 'bin' boolean (default off)
1303 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 This option should be set before editing a binary file. You can also
1305 use the |-b| Vim argument. When this option is switched on a few
1306 options will be changed (also when it already was on):
1307 'textwidth' will be set to 0
1308 'wrapmargin' will be set to 0
1309 'modeline' will be off
1310 'expandtab' will be off
1311 Also, 'fileformat' and 'fileformats' options will not be used, the
1312 file is read and written like 'fileformat' was "unix" (a single <NL>
1313 separates lines).
1314 The 'fileencoding' and 'fileencodings' options will not be used, the
1315 file is read without conversion.
1316 NOTE: When you start editing a(nother) file while the 'bin' option is
1317 on, settings from autocommands may change the settings again (e.g.,
1318 'textwidth'), causing trouble when editing. You might want to set
1319 'bin' again when the file has been loaded.
1320 The previous values of these options are remembered and restored when
1321 'bin' is switched from on to off. Each buffer has its own set of
1322 saved option values.
1323 To edit a file with 'binary' set you can use the |++bin| argument.
1324 This avoids you have to do ":set bin", which would have effect for all
1325 files you edit.
1326 When writing a file the <EOL> for the last line is only written if
1327 there was one in the original file (normally Vim appends an <EOL> to
1328 the last line if there is none; this would make the file longer). See
1329 the 'endofline' option.
1330
1331 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1332'bioskey' 'biosk' boolean (default on)
1333 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001334 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001335 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336
1337 *'bomb'* *'nobomb'*
1338'bomb' boolean (default off)
1339 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340 When writing a file and the following conditions are met, a BOM (Byte
1341 Order Mark) is prepended to the file:
1342 - this option is on
1343 - the 'binary' option is off
1344 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1345 endian variants.
1346 Some applications use the BOM to recognize the encoding of the file.
1347 Often used for UCS-2 files on MS-Windows. For other applications it
1348 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001349 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1351 check for the presence of the BOM is done and 'bomb' set accordingly.
1352 Unless 'binary' is set, it is removed from the first line, so that you
1353 don't see it when editing. When you don't change the options, the BOM
1354 will be restored when writing the file.
1355
1356 *'breakat'* *'brk'*
1357'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1358 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001359 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 feature}
1361 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001362 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1363 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001365 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001366'breakindent' 'bri' boolean (default off)
1367 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001368 {not available when compiled without the |+linebreak|
1369 feature}
1370 Every wrapped line will continue visually indented (same amount of
1371 space as the beginning of that line), thus preserving horizontal blocks
1372 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001373 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001374
1375 *'breakindentopt'* *'briopt'*
1376'breakindentopt' 'briopt' string (default empty)
1377 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001378 {not available when compiled without the |+linebreak|
1379 feature}
1380 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001381 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001382 min:{n} Minimum text width that will be kept after
1383 applying 'breakindent', even if the resulting
1384 text should normally be narrower. This prevents
1385 text indented almost to the right window border
1386 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001387 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001388 shift:{n} After applying 'breakindent', the wrapped line's
1389 beginning will be shifted by the given number of
1390 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001391 indentation (negative) or emphasizing the line
1392 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001393 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001394 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001395 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001396 numbered or bulleted list (using the
1397 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001398 list:-1 Uses the length of a match with 'formatlistpat'
1399 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001400 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001401
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001403'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001405 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001407 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001408 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409 buffer Use the directory of the related buffer.
1410 current Use the current directory.
1411 {path} Use the specified directory
1412
1413 *'bufhidden'* *'bh'*
1414'bufhidden' 'bh' string (default: "")
1415 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416 This option specifies what happens when a buffer is no longer
1417 displayed in a window:
1418 <empty> follow the global 'hidden' option
1419 hide hide the buffer (don't unload it), also when 'hidden'
1420 is not set
1421 unload unload the buffer, also when 'hidden' is set or using
1422 |:hide|
1423 delete delete the buffer from the buffer list, also when
1424 'hidden' is set or using |:hide|, like using
1425 |:bdelete|
1426 wipe wipe out the buffer from the buffer list, also when
1427 'hidden' is set or using |:hide|, like using
1428 |:bwipeout|
1429
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001430 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001431 are lost without a warning. Also, these values may break autocommands
1432 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 This option is used together with 'buftype' and 'swapfile' to specify
1434 special kinds of buffers. See |special-buffers|.
1435
1436 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1437'buflisted' 'bl' boolean (default: on)
1438 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439 When this option is set, the buffer shows up in the buffer list. If
1440 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1441 This option is reset by Vim for buffers that are only used to remember
1442 a file name or marks. Vim sets it when starting to edit a buffer.
1443 But not when moving to a buffer with ":buffer".
1444
1445 *'buftype'* *'bt'* *E382*
1446'buftype' 'bt' string (default: "")
1447 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 The value of this option specifies the type of a buffer:
1449 <empty> normal buffer
1450 nofile buffer which is not related to a file and will not be
1451 written
1452 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001453 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001454 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001456 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 help help buffer (you are not supposed to set this
1458 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001459 terminal buffer for a |terminal| (you are not supposed to set
1460 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001461 prompt buffer where only the last line can be edited, meant
1462 to be used by a plugin, see |prompt-buffer|
1463 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001464 popup buffer used in a popup window, see |popup|.
1465 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466
1467 This option is used together with 'bufhidden' and 'swapfile' to
1468 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001469 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470
1471 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001472 One such effect is that Vim will not check the timestamp of the file,
1473 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
Bram Moolenaar280f1262006-01-30 00:14:18 +00001475 A "quickfix" buffer is only used for the error list and the location
1476 list. This value is set by the |:cwindow| and |:lwindow| commands and
1477 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478
1479 "nofile" and "nowrite" buffers are similar:
1480 both: The buffer is not to be written to disk, ":w" doesn't
1481 work (":w filename" does work though).
1482 both: The buffer is never considered to be |'modified'|.
1483 There is no warning when the changes will be lost, for
1484 example when you quit Vim.
1485 both: A swap file is only created when using too much memory
1486 (when 'swapfile' has been reset there is never a swap
1487 file).
1488 nofile only: The buffer name is fixed, it is not handled like a
1489 file name. It is not modified in response to a |:cd|
1490 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001491 both: When using ":e bufname" and already editing "bufname"
1492 the buffer is made empty and autocommands are
1493 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001494 *E676*
1495 "acwrite" implies that the buffer name is not related to a file, like
1496 "nofile", but it will be written. Thus, in contrast to "nofile" and
1497 "nowrite", ":w" does work and a modified buffer can't be abandoned
1498 without saving. For writing there must be matching |BufWriteCmd|,
1499 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500
1501 *'casemap'* *'cmp'*
1502'casemap' 'cmp' string (default: "internal,keepascii")
1503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 Specifies details about changing the case of letters. It may contain
1505 these words, separated by a comma:
1506 internal Use internal case mapping functions, the current
1507 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001508 matters when 'encoding' is a Unicode encoding,
1509 "latin1" or "iso-8859-15". When "internal" is
1510 omitted, the towupper() and towlower() system library
1511 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1513 case mapping, the current locale is not effective.
1514 This probably only matters for Turkish.
1515
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001516 *'cdhome'* *'cdh'*
1517'cdhome' 'cdh' boolean (default: off)
1518 global
1519 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1520 current working directory to the |$HOME| directory like in Unix.
1521 When off, those commands just print the current directory name.
1522 On Unix this option has no effect.
1523 NOTE: This option is reset when 'compatible' is set.
1524
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525 *'cdpath'* *'cd'* *E344* *E346*
1526'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1527 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 {not available when compiled without the
1529 |+file_in_path| feature}
1530 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001531 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1532 searched for has a relative path, not an absolute part starting with
1533 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 The 'cdpath' option's value has the same form and semantics as
1535 |'path'|. Also see |file-searching|.
1536 The default value is taken from $CDPATH, with a "," prepended to look
1537 in the current directory first.
1538 If the default value taken from $CDPATH is not what you want, include
1539 a modified version of the following command in your vimrc file to
1540 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001541 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542< This option cannot be set from a |modeline| or in the |sandbox|, for
1543 security reasons.
1544 (parts of 'cdpath' can be passed to the shell to expand file names).
1545
1546 *'cedit'*
1547'cedit' string (Vi default: "", Vim default: CTRL-F)
1548 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 The key used in Command-line Mode to open the command-line window.
1550 The default is CTRL-F when 'compatible' is off.
1551 Only non-printable keys are allowed.
1552 The key can be specified as a single character, but it is difficult to
1553 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001554 :exe "set cedit=\<C-Y>"
1555 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556< |Nvi| also has this option, but it only uses the first character.
1557 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001558 NOTE: This option is set to the Vim default value when 'compatible'
1559 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560
1561 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1562'charconvert' 'ccv' string (default "")
1563 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001564 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 An expression that is used for character encoding conversion. It is
1566 evaluated when a file that is to be read or has been written has a
1567 different encoding from what is desired.
1568 'charconvert' is not used when the internal iconv() function is
1569 supported and is able to do the conversion. Using iconv() is
1570 preferred, because it is much faster.
1571 'charconvert' is not used when reading stdin |--|, because there is no
1572 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001573 The expression must return zero, false or an empty string for success,
1574 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575 The possible encoding names encountered are in 'encoding'.
1576 Additionally, names given in 'fileencodings' and 'fileencoding' are
1577 used.
1578 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1579 is done internally by Vim, 'charconvert' is not used for this.
1580 'charconvert' is also used to convert the viminfo file, if the 'c'
1581 flag is present in 'viminfo'. Also used for Unicode conversion.
1582 Example: >
1583 set charconvert=CharConvert()
1584 fun CharConvert()
1585 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001586 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1587 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 return v:shell_error
1589 endfun
1590< The related Vim variables are:
1591 v:charconvert_from name of the current encoding
1592 v:charconvert_to name of the desired encoding
1593 v:fname_in name of the input file
1594 v:fname_out name of the output file
1595 Note that v:fname_in and v:fname_out will never be the same.
1596 Note that v:charconvert_from and v:charconvert_to may be different
1597 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001598
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 Encryption is not done by Vim when using 'charconvert'. If you want
1600 to encrypt the file after conversion, 'charconvert' should take care
1601 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001602
1603 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1604 replaced with the script ID (|local-function|). Example: >
1605 set charconvert=s:MyConvert()
1606 set charconvert=<SID>SomeConvert()
1607< Otherwise the expression is evaluated in the context of the script
1608 where the option was set, thus script-local items are available.
1609
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 This option cannot be set from a |modeline| or in the |sandbox|, for
1611 security reasons.
1612
1613 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1614'cindent' 'cin' boolean (default off)
1615 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 {not available when compiled without the |+cindent|
1617 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001618 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 that trigger reindenting in insert mode and 'cinoptions' to set your
1620 preferred indent style.
1621 If 'indentexpr' is not empty, it overrules 'cindent'.
1622 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1623 the "=" operator indents using this algorithm rather than calling an
1624 external program.
1625 See |C-indenting|.
1626 When you don't like the way 'cindent' works, try the 'smartindent'
1627 option or 'indentexpr'.
1628 This option is not used when 'paste' is set.
1629 NOTE: This option is reset when 'compatible' is set.
1630
1631 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001632'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 {not available when compiled without the |+cindent|
1635 feature}
1636 A list of keys that, when typed in Insert mode, cause reindenting of
1637 the current line. Only used if 'cindent' is on and 'indentexpr' is
1638 empty.
1639 For the format of this option see |cinkeys-format|.
1640 See |C-indenting|.
1641
1642 *'cinoptions'* *'cino'*
1643'cinoptions' 'cino' string (default "")
1644 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 {not available when compiled without the |+cindent|
1646 feature}
1647 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1648 program. See |cinoptions-values| for the values of this option, and
1649 |C-indenting| for info on C indenting in general.
1650
1651
1652 *'cinwords'* *'cinw'*
1653'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1654 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 {not available when compiled without both the
1656 |+cindent| and the |+smartindent| features}
1657 These keywords start an extra indent in the next line when
1658 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1659 an appropriate place (inside {}).
1660 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1661 matter, include the keyword both the uppercase and lowercase:
1662 "if,If,IF".
1663
1664 *'clipboard'* *'cb'*
1665'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1666 for X-windows, "" otherwise)
1667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 {only in GUI versions or when the |+xterm_clipboard|
1669 feature is included}
1670 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001671 Note: if one of the items is "exclude:", then you can't add an item
1672 after that. Therefore do append an item with += but use ^= to
1673 prepend, e.g.: >
1674 set clipboard^=unnamed
1675< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001677 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 unnamed When included, Vim will use the clipboard register '*'
1679 for all yank, delete, change and put operations which
1680 would normally go to the unnamed register. When a
1681 register is explicitly specified, it will always be
1682 used regardless of whether "unnamed" is in 'clipboard'
1683 or not. The clipboard register can always be
1684 explicitly accessed using the "* notation. Also see
1685 |gui-clipboard|.
1686
Bram Moolenaar30b65812012-07-12 22:01:11 +02001687 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001688 unnamedplus A variant of the "unnamed" flag which uses the
1689 clipboard register '+' (|quoteplus|) instead of
1690 register '*' for all yank, delete, change and put
1691 operations which would normally go to the unnamed
1692 register. When "unnamed" is also included to the
1693 option, yank operations (but not delete, change or
1694 put) will additionally copy the text into register
1695 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001696 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001697 Availability can be checked with: >
1698 if has('unnamedplus')
1699<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001700 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 autoselect Works like the 'a' flag in 'guioptions': If present,
1702 then whenever Visual mode is started, or the Visual
1703 area extended, Vim tries to become the owner of the
1704 windowing system's global selection or put the
1705 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001706 register "*. See |'go-a'| and |quotestar| for details.
1707 When the GUI is active, the 'a' flag in 'guioptions'
1708 is used, when the GUI is not active, this "autoselect"
1709 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 Also applies to the modeless selection.
1711
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001712 *clipboard-autoselectplus*
1713 autoselectplus Like "autoselect" but using the + register instead of
1714 the * register. Compare to the 'P' flag in
1715 'guioptions'.
1716
1717 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 autoselectml Like "autoselect", but for the modeless selection
1719 only. Compare to the 'A' flag in 'guioptions'.
1720
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001721 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001722 html When the clipboard contains HTML, use this when
1723 pasting. When putting text on the clipboard, mark it
1724 as HTML. This works to copy rendered HTML from
1725 Firefox, paste it as raw HTML in Vim, select the HTML
1726 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001727 You probably want to add this only temporarily,
1728 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001729 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001730
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001731 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 exclude:{pattern}
1733 Defines a pattern that is matched against the name of
1734 the terminal 'term'. If there is a match, no
1735 connection will be made to the X server. This is
1736 useful in this situation:
1737 - Running Vim in a console.
1738 - $DISPLAY is set to start applications on another
1739 display.
1740 - You do not want to connect to the X server in the
1741 console, but do want this in a terminal emulator.
1742 To never connect to the X server use: >
1743 exclude:.*
1744< This has the same effect as using the |-X| argument.
1745 Note that when there is no connection to the X server
1746 the window title won't be restored and the clipboard
1747 cannot be accessed.
1748 The value of 'magic' is ignored, {pattern} is
1749 interpreted as if 'magic' was on.
1750 The rest of the option value will be used for
1751 {pattern}, this must be the last entry.
1752
1753 *'cmdheight'* *'ch'*
1754'cmdheight' 'ch' number (default 1)
1755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756 Number of screen lines to use for the command-line. Helps avoiding
1757 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001758 The value of this option is stored with the tab page, so that each tab
1759 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760
1761 *'cmdwinheight'* *'cwh'*
1762'cmdwinheight' 'cwh' number (default 7)
1763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 Number of screen lines to use for the command-line window. |cmdwin|
1765
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001766 *'colorcolumn'* *'cc'*
1767'colorcolumn' 'cc' string (default "")
1768 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001769 {not available when compiled without the |+syntax|
1770 feature}
1771 'colorcolumn' is a comma separated list of screen columns that are
1772 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1773 text. Will make screen redrawing slower.
1774 The screen column can be an absolute number, or a number preceded with
1775 '+' or '-', which is added to or subtracted from 'textwidth'. >
1776
1777 :set cc=+1 " highlight column after 'textwidth'
1778 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1779 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1780<
1781 When 'textwidth' is zero then the items with '-' and '+' are not used.
1782 A maximum of 256 columns are highlighted.
1783
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 *'columns'* *'co'* *E594*
1785'columns' 'co' number (default 80 or terminal width)
1786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001788 initialization and does not have to be set by hand. Also see
1789 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 When Vim is running in the GUI or in a resizable window, setting this
1791 option will cause the window size to be changed. When you only want
1792 to use the size for the GUI, put the command in your |gvimrc| file.
1793 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001794 number of columns of the display, the display may be messed up. For
1795 the GUI it is always possible and Vim limits the number of columns to
1796 what fits on the screen. You can use this command to get the widest
1797 window possible: >
1798 :set columns=9999
1799< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800
1801 *'comments'* *'com'* *E524* *E525*
1802'comments' 'com' string (default
1803 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1804 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 A comma separated list of strings that can start a comment line. See
1806 |format-comments|. See |option-backslash| about using backslashes to
1807 insert a space.
1808
1809 *'commentstring'* *'cms'* *E537*
1810'commentstring' 'cms' string (default "/*%s*/")
1811 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 {not available when compiled without the |+folding|
1813 feature}
1814 A template for a comment. The "%s" in the value is replaced with the
1815 comment text. Currently only used to add markers for folding, see
1816 |fold-marker|.
1817
1818 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001819'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001820 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 This option has the effect of making Vim either more Vi-compatible, or
1823 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001824
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001826 other options are also changed as a side effect.
1827 NOTE: Setting or resetting this option can have a lot of unexpected
1828 effects: Mappings are interpreted in another way, undo behaves
1829 differently, etc. If you set this option in your vimrc file, you
1830 should probably put it at the very start.
1831
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 By default this option is on and the Vi defaults are used for the
1833 options. This default was chosen for those people who want to use Vim
1834 just like Vi, and don't even (want to) know about the 'compatible'
1835 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001836 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001837 this option is switched off, and all options that have not been
1838 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001839 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001840 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001841 happen for the system-wide vimrc or gvimrc file, nor for a file given
1842 with the |-u| argument). Also see |compatible-default| and
1843 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 You can also set this option with the "-C" argument, and reset it with
1845 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001846 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847
Bram Moolenaar214641f2017-03-05 17:04:09 +01001848 When this option is set, numerous other options are set to make Vim as
1849 Vi-compatible as possible. When this option is unset, various options
1850 are set to make Vim more useful. The table below lists all the
1851 options affected.
1852 The {?} column indicates when the options are affected:
1853 + Means that the option is set to the value given in {set value} when
1854 'compatible' is set.
1855 & Means that the option is set to the value given in {set value} when
1856 'compatible' is set AND is set to its Vim default value when
1857 'compatible' is unset.
1858 - Means the option is NOT changed when setting 'compatible' but IS
1859 set to its Vim default when 'compatible' is unset.
1860 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861
Bram Moolenaar036986f2017-03-16 17:41:02 +01001862 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001863
1864 'allowrevins' + off no CTRL-_ command
1865 'antialias' + off don't use antialiased fonts
1866 'arabic' + off reset arabic-related options
1867 'arabicshape' + on correct character shapes
1868 'backspace' + "" normal backspace
1869 'backup' + off no backup file
1870 'backupcopy' & Unix: "yes" backup file is a copy
1871 else: "auto" copy or rename backup file
1872 'balloonexpr' + "" text to show in evaluation balloon
1873 'breakindent' + off don't indent when wrapping lines
1874 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001875 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001876 'cindent' + off no C code indentation
1877 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1878 'copyindent' + off don't copy indent structure
1879 'cpoptions' & (all flags) Vi-compatible flags
1880 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001881 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001882 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001883 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001884 'cscopeverbose' + off see |cscopeverbose|
1885 'delcombine' + off unicode: delete whole char combination
1886 'digraph' + off no digraphs
1887 'esckeys' & off no <Esc>-keys in Insert mode
1888 'expandtab' + off tabs not expanded to spaces
1889 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001890 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001891 'formatexpr' + "" use 'formatprg' for auto-formatting
1892 'formatoptions' & "vt" Vi compatible formatting
1893 'gdefault' + off no default 'g' flag for ":s"
1894 'history' & 0 no commandline history
1895 'hkmap' + off no Hebrew keyboard mapping
1896 'hkmapp' + off no phonetic Hebrew keyboard mapping
1897 'hlsearch' + off no highlighting of search matches
1898 'incsearch' + off no incremental searching
1899 'indentexpr' + "" no indenting by expression
1900 'insertmode' + off do not start in Insert mode
1901 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001903 'joinspaces' + on insert 2 spaces after period
1904 'modeline' & off no modelines
1905 'more' & off no pauses in listings
1906 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1907 'numberwidth' & 8 min number of columns for line number
1908 'preserveindent'+ off don't preserve current indent structure
1909 when changing it
1910 'revins' + off no reverse insert
1911 'ruler' + off no ruler
1912 'scrolljump' + 1 no jump scroll
1913 'scrolloff' + 0 no scroll offset
1914 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1915 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001916 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001917 'showcmd' & off command characters not shown
1918 'showmode' & off current mode not shown
1919 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1920 'smartcase' + off no automatic ignore case switch
1921 'smartindent' + off no smart indentation
1922 'smarttab' + off no smart tab size
1923 'softtabstop' + 0 tabs are always 'tabstop' positions
1924 'startofline' + on goto startofline with some commands
1925 'tagcase' & "followic" 'ignorecase' when searching tags file
1926 'tagrelative' & off tag file names are not relative
1927 'termguicolors' + off don't use highlight-(guifg|guibg)
1928 'textauto' & off no automatic textmode detection
1929 'textwidth' + 0 no automatic line wrap
1930 'tildeop' + off tilde is not an operator
1931 'ttimeout' + off no terminal timeout
1932 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001933 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001934 'virtualedit' + "" cursor can only be placed on characters
1935 'whichwrap' & "" left-right movements don't wrap
1936 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001938 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939
1940 *'complete'* *'cpt'* *E535*
1941'complete' 'cpt' string (default: ".,w,b,u,t,i")
1942 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 This option specifies how keyword completion |ins-completion| works
1944 when CTRL-P or CTRL-N are used. It is also used for whole-line
1945 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1946 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001947 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948 w scan buffers from other windows
1949 b scan other loaded buffers that are in the buffer list
1950 u scan the unloaded buffers that are in the buffer list
1951 U scan the buffers that are not in the buffer list
1952 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001953 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 k{dict} scan the file {dict}. Several "k" flags can be given,
1955 patterns are valid too. For example: >
1956 :set cpt=k/usr/dict/*,k~/spanish
1957< s scan the files given with the 'thesaurus' option
1958 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1959 are valid too.
1960 i scan current and included files
1961 d scan current and included files for defined name or macro
1962 |i_CTRL-X_CTRL-D|
1963 ] tag completion
1964 t same as "]"
1965
1966 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1967 not executed, this may lead to unexpected completions from some files
1968 (gzipped files for example). Unloaded buffers are not scanned for
1969 whole-line completion.
1970
1971 The default is ".,w,b,u,t,i", which means to scan:
1972 1. the current buffer
1973 2. buffers in other windows
1974 3. other loaded buffers
1975 4. unloaded buffers
1976 5. tags
1977 6. included files
1978
1979 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001980 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1981 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001983 *'completefunc'* *'cfu'*
1984'completefunc' 'cfu' string (default: empty)
1985 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001986 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001987 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001988 This option specifies a function to be used for Insert mode completion
1989 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001990 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001991 invoked and what it should return. The value can be the name of a
1992 function, a |lambda| or a |Funcref|. See |option-value-function| for
1993 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001994 This option cannot be set from a |modeline| or in the |sandbox|, for
1995 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001996
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001997 *'completeslash'* *'csl'*
1998'completeslash' 'csl' string (default: "")
1999 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002000 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002001 When this option is set it overrules 'shellslash' for completion:
2002 - When this option is set to "slash", a forward slash is used for path
2003 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002004 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002005 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002006 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002007 - When this option is empty, same character is used as for
2008 'shellslash'.
2009 For Insert mode completion the buffer-local value is used. For
2010 command line completion the global value is used.
2011
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002012 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002013'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002014 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002015 A comma separated list of options for Insert mode completion
2016 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002017
2018 menu Use a popup menu to show the possible completions. The
2019 menu is only shown when there is more than one match and
2020 sufficient colors are available. |ins-completion-menu|
2021
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002022 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002023 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002024 match, e.g., what file it comes from.
2025
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002026 longest Only insert the longest common text of the matches. If
2027 the menu is displayed you can use CTRL-L to add more
2028 characters. Whether case is ignored depends on the kind
2029 of completion. For buffer text the 'ignorecase' option is
2030 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002031
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002032 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002033 completion in the preview window. Only works in
2034 combination with "menu" or "menuone".
2035
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002036 popup Show extra information about the currently selected
2037 completion in a popup window. Only works in combination
2038 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002039 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002040 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002041
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002042 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002043 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002044 |CompleteChanged| autocommand to fetch the info and call
2045 |popup_show()| once the popup has been filled.
2046 See the example at |complete-popuphidden|.
2047 {only works when compiled with the |+textprop| feature}
2048
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002049 noinsert Do not insert any text for a match until the user selects
2050 a match from the menu. Only works in combination with
2051 "menu" or "menuone". No effect if "longest" is present.
2052
2053 noselect Do not select a match in the menu, force the user to
2054 select one from the menu. Only works in combination with
2055 "menu" or "menuone".
2056
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002057
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002058 *'completepopup'* *'cpp'*
2059'completepopup' 'cpp' string (default empty)
2060 global
2061 {not available when compiled without the |+textprop|
2062 or |+quickfix| feature}
2063 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002064 properties of the info popup when it is created. If an info popup
2065 window already exists it is closed, so that the option value is
2066 applied when it is created again.
2067 You can also use |popup_findinfo()| and then set properties for an
2068 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002069
2070
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002071 *'concealcursor'* *'cocu'*
2072'concealcursor' 'cocu' string (default: "")
2073 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002074 {not available when compiled without the |+conceal|
2075 feature}
2076 Sets the modes in which text in the cursor line can also be concealed.
2077 When the current mode is listed then concealing happens just like in
2078 other lines.
2079 n Normal mode
2080 v Visual mode
2081 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002082 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002083
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002084 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002085 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002086 are moving around text is concealed, but when starting to insert text
2087 or selecting a Visual area the concealed text is displayed, so that
2088 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002089 Keep in mind that the cursor position is not always where it's
2090 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002091
2092
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002093 *'conceallevel'* *'cole'*
2094'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002095 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002096 {not available when compiled without the |+conceal|
2097 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002098 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2099 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002100
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002101 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002102 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002103 1 Each block of concealed text is replaced with one
2104 character. If the syntax item does not have a custom
2105 replacement character defined (see |:syn-cchar|) the
2106 character defined in 'listchars' is used (default is a
2107 space).
2108 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002109 2 Concealed text is completely hidden unless it has a
2110 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002111 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002112 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002113
Bram Moolenaara7781e02010-07-19 20:13:22 +02002114 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002115 edit and copy the text. This can be changed with the 'concealcursor'
2116 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002117
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2119'confirm' 'cf' boolean (default off)
2120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 When 'confirm' is on, certain operations that would normally
2122 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2123 instead raise a |dialog| asking if you wish to save the current
2124 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2125 If 'confirm' is off you can still activate confirmation for one
2126 command only (this is most useful in mappings) with the |:confirm|
2127 command.
2128 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2129
2130 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2131'conskey' 'consk' boolean (default off)
2132 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002133 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134
2135 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2136'copyindent' 'ci' boolean (default off)
2137 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 Copy the structure of the existing lines indent when autoindenting a
2139 new line. Normally the new indent is reconstructed by a series of
2140 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2141 in which case only spaces are used). Enabling this option makes the
2142 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002143 existing line. 'expandtab' has no effect on these characters, a Tab
2144 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002146 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 Also see 'preserveindent'.
2148
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002149 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150'cpoptions' 'cpo' string (Vim default: "aABceFs",
2151 Vi default: all flags)
2152 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002154 this indicates Vi-compatible behavior. This is used for things where
2155 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 'cpoptions' stands for "compatible-options".
2157 Commas can be added for readability.
2158 To avoid problems with flags that are added in the future, use the
2159 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002160
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 NOTE: This option is set to the Vi default value when 'compatible' is
2162 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002163
2164 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2165 is saved, 'cpoptions' is set to the Vim default, and the saved value
2166 is restored at the end of the script. Changes to the value of
2167 'cpoptions' will be applied to the saved value, but keep in mind that
2168 removing a flag that is not present when 'cpoptions' is changed has no
2169 effect. In the |.vimrc| file the value is not restored, thus using
2170 `vim9script` in the |.vimrc| file results in using the Vim default.
2171
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002172 NOTE: This option is set to the POSIX default value at startup when
2173 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002174 variable exists |posix|. This means Vim tries to behave like the
2175 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176
2177 contains behavior ~
2178 *cpo-a*
2179 a When included, a ":read" command with a file name
2180 argument will set the alternate file name for the
2181 current window.
2182 *cpo-A*
2183 A When included, a ":write" command with a file name
2184 argument will set the alternate file name for the
2185 current window.
2186 *cpo-b*
2187 b "\|" in a ":map" command is recognized as the end of
2188 the map command. The '\' is included in the mapping,
2189 the text after the '|' is interpreted as the next
2190 command. Use a CTRL-V instead of a backslash to
2191 include the '|' in the mapping. Applies to all
2192 mapping, abbreviation, menu and autocmd commands.
2193 See also |map_bar|.
2194 *cpo-B*
2195 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002196 abbreviations, user commands and the "to" part of the
2197 menu commands. Remove this flag to be able to use a
2198 backslash like a CTRL-V. For example, the command
2199 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 'B' included: "\^[" (^[ is a real <Esc>)
2201 'B' excluded: "<Esc>" (5 characters)
2202 ('<' excluded in both cases)
2203 *cpo-c*
2204 c Searching continues at the end of any match at the
2205 cursor position, but not further than the start of the
2206 next line. When not present searching continues
2207 one character from the cursor position. With 'c'
2208 "abababababab" only gets three matches when repeating
2209 "/abab", without 'c' there are five matches.
2210 *cpo-C*
2211 C Do not concatenate sourced lines that start with a
2212 backslash. See |line-continuation|.
2213 *cpo-d*
2214 d Using "./" in the 'tags' option doesn't mean to use
2215 the tags file relative to the current file, but the
2216 tags file in the current directory.
2217 *cpo-D*
2218 D Can't use CTRL-K to enter a digraph after Normal mode
2219 commands with a character argument, like |r|, |f| and
2220 |t|.
2221 *cpo-e*
2222 e When executing a register with ":@r", always add a
2223 <CR> to the last line, also when the register is not
2224 linewise. If this flag is not present, the register
2225 is not linewise and the last line does not end in a
2226 <CR>, then the last line is put on the command-line
2227 and can be edited before hitting <CR>.
2228 *cpo-E*
2229 E It is an error when using "y", "d", "c", "g~", "gu" or
2230 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002231 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 This makes "y0" fail in the first column.
2233 *cpo-f*
2234 f When included, a ":read" command with a file name
2235 argument will set the file name for the current buffer,
2236 if the current buffer doesn't have a file name yet.
2237 *cpo-F*
2238 F When included, a ":write" command with a file name
2239 argument will set the file name for the current
2240 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002241 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 *cpo-g*
2243 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002244 *cpo-H*
2245 H When using "I" on a line with only blanks, insert
2246 before the last blank. Without this flag insert after
2247 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 *cpo-i*
2249 i When included, interrupting the reading of a file will
2250 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002251 *cpo-I*
2252 I When moving the cursor up or down just after inserting
2253 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 *cpo-j*
2255 j When joining lines, only add two spaces after a '.',
2256 not after '!' or '?'. Also see 'joinspaces'.
2257 *cpo-J*
2258 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002259 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 white space.
2261 *cpo-k*
2262 k Disable the recognition of raw key codes in
2263 mappings, abbreviations, and the "to" part of menu
2264 commands. For example, if <Key> sends ^[OA (where ^[
2265 is <Esc>), the command ":map X ^[OA" results in X
2266 being mapped to:
2267 'k' included: "^[OA" (3 characters)
2268 'k' excluded: "<Key>" (one key code)
2269 Also see the '<' flag below.
2270 *cpo-K*
2271 K Don't wait for a key code to complete when it is
2272 halfway a mapping. This breaks mapping <F1><F1> when
2273 only part of the second <F1> has been read. It
2274 enables cancelling the mapping by typing <F1><Esc>.
2275 *cpo-l*
2276 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002277 literally, only "\]", "\^", "\-" and "\\" are special.
2278 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2280 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002281 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 *cpo-L*
2283 L When the 'list' option is set, 'wrapmargin',
2284 'textwidth', 'softtabstop' and Virtual Replace mode
2285 (see |gR|) count a <Tab> as two characters, instead of
2286 the normal behavior of a <Tab>.
2287 *cpo-m*
2288 m When included, a showmatch will always wait half a
2289 second. When not included, a showmatch will wait half
2290 a second or until a character is typed. |'showmatch'|
2291 *cpo-M*
2292 M When excluded, "%" matching will take backslashes into
2293 account. Thus in "( \( )" and "\( ( \)" the outer
2294 parenthesis match. When included "%" ignores
2295 backslashes, which is Vi compatible.
2296 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002297 n When included, the column used for 'number' and
2298 'relativenumber' will also be used for text of wrapped
2299 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 *cpo-o*
2301 o Line offset to search command is not remembered for
2302 next search.
2303 *cpo-O*
2304 O Don't complain if a file is being overwritten, even
2305 when it didn't exist when editing it. This is a
2306 protection against a file unexpectedly created by
2307 someone else. Vi didn't complain about this.
2308 *cpo-p*
2309 p Vi compatible Lisp indenting. When not present, a
2310 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002311 *cpo-P*
2312 P When included, a ":write" command that appends to a
2313 file will set the file name for the current buffer, if
2314 the current buffer doesn't have a file name yet and
2315 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002316 *cpo-q*
2317 q When joining multiple lines leave the cursor at the
2318 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 *cpo-r*
2320 r Redo ("." command) uses "/" to repeat a search
2321 command, instead of the actually used search string.
2322 *cpo-R*
2323 R Remove marks from filtered lines. Without this flag
2324 marks are kept like |:keepmarks| was used.
2325 *cpo-s*
2326 s Set buffer options when entering the buffer for the
2327 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002328 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 set when the buffer is created.
2330 *cpo-S*
2331 S Set buffer options always when entering a buffer
2332 (except 'readonly', 'fileformat', 'filetype' and
2333 'syntax'). This is the (most) Vi compatible setting.
2334 The options are set to the values in the current
2335 buffer. When you change an option and go to another
2336 buffer, the value is copied. Effectively makes the
2337 buffer options global to all buffers.
2338
2339 's' 'S' copy buffer options
2340 no no when buffer created
2341 yes no when buffer first entered (default)
2342 X yes each time when buffer entered (vi comp.)
2343 *cpo-t*
2344 t Search pattern for the tag command is remembered for
2345 "n" command. Otherwise Vim only puts the pattern in
2346 the history for search pattern, but doesn't change the
2347 last used search pattern.
2348 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002349 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 *cpo-v*
2351 v Backspaced characters remain visible on the screen in
2352 Insert mode. Without this flag the characters are
2353 erased from the screen right away. With this flag the
2354 screen newly typed text overwrites backspaced
2355 characters.
2356 *cpo-w*
2357 w When using "cw" on a blank character, only change one
2358 character and not all blanks until the start of the
2359 next word.
2360 *cpo-W*
2361 W Don't overwrite a readonly file. When omitted, ":w!"
2362 overwrites a readonly file, if possible.
2363 *cpo-x*
2364 x <Esc> on the command-line executes the command-line.
2365 The default in Vim is to abandon the command-line,
2366 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002367 *cpo-X*
2368 X When using a count with "R" the replaced text is
2369 deleted only once. Also when repeating "R" with "."
2370 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002372 y A yank command can be redone with ".". Think twice if
2373 you really want to use this, it may break some
2374 plugins, since most people expect "." to only repeat a
2375 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002376 *cpo-Z*
2377 Z When using "w!" while the 'readonly' option is set,
2378 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 *cpo-!*
2380 ! When redoing a filter command, use the last used
2381 external command, whatever it was. Otherwise the last
2382 used -filter- command is used.
2383 *cpo-$*
2384 $ When making a change to one line, don't redisplay the
2385 line, but put a '$' at the end of the changed text.
2386 The changed text will be overwritten when you type the
2387 new text. The line is redisplayed if you type any
2388 command that moves the cursor from the insertion
2389 point.
2390 *cpo-%*
2391 % Vi-compatible matching is done for the "%" command.
2392 Does not recognize "#if", "#endif", etc.
2393 Does not recognize "/*" and "*/".
2394 Parens inside single and double quotes are also
2395 counted, causing a string that contains a paren to
2396 disturb the matching. For example, in a line like
2397 "if (strcmp("foo(", s))" the first paren does not
2398 match the last one. When this flag is not included,
2399 parens inside single and double quotes are treated
2400 specially. When matching a paren outside of quotes,
2401 everything inside quotes is ignored. When matching a
2402 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002403 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002404 This flag is also used for other features, such as
2405 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002406 *cpo--*
2407 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002408 it would go above the first line or below the last
2409 line. Without it the cursor moves to the first or
2410 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002411 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002412 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002413 *cpo-+*
2414 + When included, a ":write file" command will reset the
2415 'modified' flag of the buffer, even though the buffer
2416 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002417 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 * Use ":*" in the same way as ":@". When not included,
2419 ":*" is an alias for ":'<,'>", select the Visual area.
2420 *cpo-<*
2421 < Disable the recognition of special key codes in |<>|
2422 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002423 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424 ":map X <Tab>" results in X being mapped to:
2425 '<' included: "<Tab>" (5 characters)
2426 '<' excluded: "^I" (^I is a real <Tab>)
2427 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002428 *cpo->*
2429 > When appending to a register, put a line break before
2430 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002431 *cpo-;*
2432 ; When using |,| or |;| to repeat the last |t| search
2433 and the cursor is right in front of the searched
2434 character, the cursor won't move. When not included,
2435 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002436 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002437
2438 POSIX flags. These are not included in the Vi default value, except
2439 when $VIM_POSIX was set on startup. |posix|
2440
2441 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002442 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002443 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002444 *cpo-&*
2445 & When ":preserve" was used keep the swap file when
2446 exiting normally while this buffer is still loaded.
2447 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002448 *cpo-\*
2449 \ Backslash in a [] range in a search pattern is taken
2450 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002451 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2452 '\' excluded: "/[ \-]" finds <Space> and '-'
2453 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002454 *cpo-/*
2455 / When "%" is used as the replacement string in a |:s|
2456 command, use the previous replacement string. |:s%|
2457 *cpo-{*
2458 { The |{| and |}| commands also stop at a "{" character
2459 at the start of a line.
2460 *cpo-.*
2461 . The ":chdir" and ":cd" commands fail if the current
2462 buffer is modified, unless ! is used. Vim doesn't
2463 need this, since it remembers the full path of an
2464 opened file.
2465 *cpo-bar*
2466 | The value of the $LINES and $COLUMNS environment
2467 variables overrule the terminal size values obtained
2468 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002469
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002471 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002472'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002473 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002474 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002475 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002476 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002477 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002478 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002479 blowfish Blowfish method. Medium strong encryption but it has
2480 an implementation flaw. Requires Vim 7.3 or later,
2481 files can NOT be read by Vim 7.2 and older. This adds
2482 a "seed" to the file, every time you write the file
2483 the encrypted bytes will be different.
2484 *blowfish2*
2485 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002486 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002487 and older. This adds a "seed" to the file, every time
2488 you write the file the encrypted bytes will be
2489 different. The whole undo file is encrypted, not just
2490 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002491 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002492 *E1197* *E1198* *E1199* *E1200* *E1201*
2493 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2494 Code. Medium strong till strong encryption.
2495 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002496 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002497 It adds a seed and a message authentication code (MAC)
2498 to the file. This needs at least a Vim 8.2.3022 to
2499 read the encrypted file.
2500 Encryption of swap files is not supported, therefore
2501 no swap file will be used when xchacha20 encryption is
2502 enabled.
2503 Encryption of undo files is not yet supported,
2504 therefore no undo file will currently be written.
2505 CURRENTLY EXPERIMENTAL: Files written with this method
2506 might have to be read back with the same version of
2507 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002508
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002509 You should use "blowfish2", also to re-encrypt older files.
2510
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002511 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002512 to the detected method of the file being read. Thus if you write it
2513 without changing 'cryptmethod' the same method will be used.
2514 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002515 explicitly write it, you don't get a warning unless there are other
2516 modifications. Also see |:X|.
2517
2518 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002519 the value "blowfish2". When setting the local value to an empty
2520 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002521
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002522 When a new encryption method is added in a later version of Vim, and
2523 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002524 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002525
2526
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 *'cscopepathcomp'* *'cspc'*
2528'cscopepathcomp' 'cspc' number (default 0)
2529 global
2530 {not available when compiled without the |+cscope|
2531 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 Determines how many components of the path to show in a list of tags.
2533 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002534 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535
2536 *'cscopeprg'* *'csprg'*
2537'cscopeprg' 'csprg' string (default "cscope")
2538 global
2539 {not available when compiled without the |+cscope|
2540 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541 Specifies the command to execute cscope. See |cscopeprg|.
2542 This option cannot be set from a |modeline| or in the |sandbox|, for
2543 security reasons.
2544
2545 *'cscopequickfix'* *'csqf'*
2546'cscopequickfix' 'csqf' string (default "")
2547 global
2548 {not available when compiled without the |+cscope|
2549 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 Specifies whether to use quickfix window to show cscope results.
2551 See |cscopequickfix|.
2552
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002553 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002554'cscoperelative' 'csre' boolean (default off)
2555 global
2556 {not available when compiled without the |+cscope|
2557 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002558 In the absence of a prefix (-P) for cscope. setting this option enables
2559 to use the basename of cscope.out path as the prefix.
2560 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002561 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002562
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2564'cscopetag' 'cst' boolean (default off)
2565 global
2566 {not available when compiled without the |+cscope|
2567 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 Use cscope for tag commands. See |cscope-options|.
2569 NOTE: This option is reset when 'compatible' is set.
2570
2571 *'cscopetagorder'* *'csto'*
2572'cscopetagorder' 'csto' number (default 0)
2573 global
2574 {not available when compiled without the |+cscope|
2575 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 Determines the order in which ":cstag" performs a search. See
2577 |cscopetagorder|.
2578 NOTE: This option is set to 0 when 'compatible' is set.
2579
2580 *'cscopeverbose'* *'csverb'*
2581 *'nocscopeverbose'* *'nocsverb'*
2582'cscopeverbose' 'csverb' boolean (default off)
2583 global
2584 {not available when compiled without the |+cscope|
2585 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 Give messages when adding a cscope database. See |cscopeverbose|.
2587 NOTE: This option is reset when 'compatible' is set.
2588
Bram Moolenaar860cae12010-06-05 23:22:07 +02002589 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2590'cursorbind' 'crb' boolean (default off)
2591 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002592 When this option is set, as the cursor in the current
2593 window moves other cursorbound windows (windows that also have
2594 this option set) move their cursors to the corresponding line and
2595 column. This option is useful for viewing the
2596 differences between two versions of a file (see 'diff'); in diff mode,
2597 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002598 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002599
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002600
2601 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2602'cursorcolumn' 'cuc' boolean (default off)
2603 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002604 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002605 feature}
2606 Highlight the screen column of the cursor with CursorColumn
2607 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2608 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002609 If you only want the highlighting in the current window you can use
2610 these autocommands: >
2611 au WinLeave * set nocursorline nocursorcolumn
2612 au WinEnter * set cursorline cursorcolumn
2613<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002614
2615 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2616'cursorline' 'cul' boolean (default off)
2617 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002618 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002619 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002620 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2621 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002622 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002623 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002624
2625
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002626 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002627'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002628 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002629 {not available when compiled without the |+syntax|
2630 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002631 Comma separated list of settings for how 'cursorline' is displayed.
2632 Valid values:
2633 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002634 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002635 "screenline" Highlight only the screen line of the cursor with
2636 CursorLine |hl-CursorLine|.
2637 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002638 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002639
2640 Special value:
2641 "both" Alias for the values "line,number".
2642
2643 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002644
2645
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 *'debug'*
2647'debug' string (default "")
2648 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002649 These values can be used:
2650 msg Error messages that would otherwise be omitted will be given
2651 anyway.
2652 throw Error messages that would otherwise be omitted will be given
2653 anyway and also throw an exception and set |v:errmsg|.
2654 beep A message will be given when otherwise only a beep would be
2655 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002656 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002657 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2658 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659
2660 *'define'* *'def'*
2661'define' 'def' string (default "^\s*#\s*define")
2662 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002663 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 pattern, just like for the "/" command. This option is used for the
2665 commands like "[i" and "[d" |include-search|. The 'isident' option is
2666 used to recognize the defined name after the match:
2667 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2668 See |option-backslash| about inserting backslashes to include a space
2669 or backslash.
2670 The default value is for C programs. For C++ this value would be
2671 useful, to include const type declarations: >
2672 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002673< You can also use "\ze" just before the name and continue the pattern
2674 to check what is following. E.g. for Javascript, if a function is
2675 defined with "func_name = function(args)": >
2676 ^\s*\ze\i\+\s*=\s*function(
2677< If the function is defined with "func_name : function() {...": >
2678 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002680 To avoid that use `:let` with a single quote string: >
2681 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002682<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683
2684 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2685'delcombine' 'deco' boolean (default off)
2686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 If editing Unicode and this option is set, backspace and Normal mode
2688 "x" delete each combining character on its own. When it is off (the
2689 default) the character along with its combining characters are
2690 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002691 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692
2693 This is useful for Arabic, Hebrew and many other languages where one
2694 may have combining characters overtop of base characters, and want
2695 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002696 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697
2698 *'dictionary'* *'dict'*
2699'dictionary' 'dict' string (default "")
2700 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 List of file names, separated by commas, that are used to lookup words
2702 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2703 contain a list of words. This can be one word per line, or several
2704 words per line, separated by non-keyword characters (white space is
2705 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002706
2707 When this option is empty or an entry "spell" is present, and spell
2708 checking is enabled, words in the word lists for the currently active
2709 'spelllang' are used. See |spell|.
2710
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002711 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 after a comma are ignored, otherwise spaces are included in the file
2713 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002714 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 Where to find a list of words?
2716 - On FreeBSD, there is the file "/usr/share/dict/words".
2717 - In the Simtel archive, look in the "msdos/linguist" directory.
2718 - In "miscfiles" of the GNU collection.
2719 The use of |:set+=| and |:set-=| is preferred when adding or removing
2720 directories from the list. This avoids problems when a future version
2721 uses another default.
2722 Backticks cannot be used in this option for security reasons.
2723
2724 *'diff'* *'nodiff'*
2725'diff' boolean (default off)
2726 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 {not available when compiled without the |+diff|
2728 feature}
2729 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002730 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
2732 *'dex'* *'diffexpr'*
2733'diffexpr' 'dex' string (default "")
2734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 {not available when compiled without the |+diff|
2736 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002737 Expression which is evaluated to obtain a diff file (either ed-style
2738 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 This option cannot be set from a |modeline| or in the |sandbox|, for
2740 security reasons.
2741
2742 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002743'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 {not available when compiled without the |+diff|
2746 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002747 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 All are optional. Items must be separated by a comma.
2749
2750 filler Show filler lines, to keep the text
2751 synchronized with a window that has inserted
2752 lines at the same position. Mostly useful
2753 when windows are side-by-side and 'scrollbind'
2754 is set.
2755
2756 context:{n} Use a context of {n} lines between a change
2757 and a fold that contains unchanged lines.
2758 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002759 When using zero the context is actually one,
2760 since folds require a line in between, also
2761 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 See |fold-diff|.
2763
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002764 iblank Ignore changes where lines are all blank. Adds
2765 the "-B" flag to the "diff" command if
2766 'diffexpr' is empty. Check the documentation
2767 of the "diff" command for what this does
2768 exactly.
2769 NOTE: the diff windows will get out of sync,
2770 because no differences between blank lines are
2771 taken into account.
2772
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 icase Ignore changes in case of text. "a" and "A"
2774 are considered the same. Adds the "-i" flag
2775 to the "diff" command if 'diffexpr' is empty.
2776
2777 iwhite Ignore changes in amount of white space. Adds
2778 the "-b" flag to the "diff" command if
2779 'diffexpr' is empty. Check the documentation
2780 of the "diff" command for what this does
2781 exactly. It should ignore adding trailing
2782 white space, but not leading white space.
2783
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002784 iwhiteall Ignore all white space changes. Adds
2785 the "-w" flag to the "diff" command if
2786 'diffexpr' is empty. Check the documentation
2787 of the "diff" command for what this does
2788 exactly.
2789
2790 iwhiteeol Ignore white space changes at end of line.
2791 Adds the "-Z" flag to the "diff" command if
2792 'diffexpr' is empty. Check the documentation
2793 of the "diff" command for what this does
2794 exactly.
2795
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002796 horizontal Start diff mode with horizontal splits (unless
2797 explicitly specified otherwise).
2798
2799 vertical Start diff mode with vertical splits (unless
2800 explicitly specified otherwise).
2801
Bram Moolenaarc8234772019-11-10 21:00:27 +01002802 closeoff When a window is closed where 'diff' is set
2803 and there is only one window remaining in the
2804 same tab page with 'diff' set, execute
2805 `:diffoff` in that window. This undoes a
2806 `:diffsplit` command.
2807
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002808 hiddenoff Do not use diff mode for a buffer when it
2809 becomes hidden.
2810
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002811 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2812 starting diff mode. Without this 2 is used.
2813
Bram Moolenaar4223d432021-02-10 13:18:17 +01002814 followwrap Follow the 'wrap' option and leave as it is.
2815
Bram Moolenaare828b762018-09-10 17:51:58 +02002816 internal Use the internal diff library. This is
2817 ignored when 'diffexpr' is set. *E960*
2818 When running out of memory when writing a
2819 buffer this item will be ignored for diffs
2820 involving that buffer. Set the 'verbose'
2821 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822
Bram Moolenaare828b762018-09-10 17:51:58 +02002823 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002824 Use the indent heuristic for the internal
2825 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002826
2827 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002828 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002829 algorithms are:
2830 myers the default algorithm
2831 minimal spend extra time to generate the
2832 smallest possible diff
2833 patience patience diff algorithm
2834 histogram histogram diff algorithm
2835
2836 Examples: >
2837 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002839 :set diffopt=internal,filler,foldcolumn:3
2840 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841<
2842 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2843'digraph' 'dg' boolean (default off)
2844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 {not available when compiled without the |+digraphs|
2846 feature}
2847 Enable the entering of digraphs in Insert mode with {char1} <BS>
2848 {char2}. See |digraphs|.
2849 NOTE: This option is reset when 'compatible' is set.
2850
2851 *'directory'* *'dir'*
2852'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002853 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854 for Unix: ".,~/tmp,/var/tmp,/tmp")
2855 global
2856 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002857 Recommended value: ".,~/vimswap//" - this will put the swap file next
2858 to the edited file if possible, and in your personal swap directory
2859 otherwise. Make sure "~/vimswap//" is only readable for you.
2860
2861 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 - The swap file will be created in the first directory where this is
2863 possible.
2864 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002865 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 - A directory "." means to put the swap file in the same directory as
2867 the edited file. On Unix, a dot is prepended to the file name, so
2868 it doesn't show in a directory listing. On MS-Windows the "hidden"
2869 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002870 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2871 the swap file relative to where the edited file is. The leading "."
2872 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002873 - For Unix and Win32, if a directory ends in two path separators "//",
2874 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002875 with all path separators replaced by percent '%' signs (including
2876 the colon following the drive letter on Win32). This will ensure
2877 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002878 On Win32, it is also possible to end with "\\". However, When a
2879 separating comma is following, you must use "//", since "\\" will
2880 include the comma in the file name. Therefore it is recommended to
2881 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 - Spaces after the comma are ignored, other spaces are considered part
2883 of the directory name. To have a space at the start of a directory
2884 name, precede it with a backslash.
2885 - To include a comma in a directory name precede it with a backslash.
2886 - A directory name may end in an ':' or '/'.
2887 - Environment variables are expanded |:set_env|.
2888 - Careful with '\' characters, type one before a space, type two to
2889 get one in the option (see |option-backslash|), for example: >
2890 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2891< - For backwards compatibility with Vim version 3.0 a '>' at the start
2892 of the option is removed.
2893 Using "." first in the list is recommended. This means that editing
2894 the same file twice will result in a warning. Using "/tmp" on Unix is
2895 discouraged: When the system crashes you lose the swap file.
2896 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002897 choice than "/tmp". But others on the computer may be able to see the
2898 files, and it can contain a lot of files, your swap files get lost in
2899 the crowd. That is why a "tmp" directory in your home directory is
2900 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 The use of |:set+=| and |:set-=| is preferred when adding or removing
2902 directories from the list. This avoids problems when a future version
2903 uses another default.
2904 This option cannot be set from a |modeline| or in the |sandbox|, for
2905 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906
2907 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002908'display' 'dy' string (default "", set to "truncate" in
2909 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 Change the way text is displayed. This is comma separated list of
2912 flags:
2913 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002914 in a window will be displayed. "@@@" is put in the
2915 last columns of the last screen line to indicate the
2916 rest of the line is not displayed.
2917 truncate Like "lastline", but "@@@" is displayed in the first
2918 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 uhex Show unprintable characters hexadecimal as <xx>
2920 instead of using ^C and ~C.
2921
Bram Moolenaard0796902016-09-16 20:02:31 +02002922 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002923 doesn't fit is replaced with "@" lines.
2924
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 *'eadirection'* *'ead'*
2926'eadirection' 'ead' string (default "both")
2927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 Tells when the 'equalalways' option applies:
2929 ver vertically, width of windows is not affected
2930 hor horizontally, height of windows is not affected
2931 both width and height of windows is affected
2932
2933 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2934'edcompatible' 'ed' boolean (default off)
2935 global
2936 Makes the 'g' and 'c' flags of the ":substitute" command to be
2937 toggled each time the flag is given. See |complex-change|. See
2938 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002939 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002940 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941
Bram Moolenaar03413f42016-04-12 21:07:15 +02002942 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002943'emoji' 'emo' boolean (default: on)
2944 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002945 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002946 This excludes "text emoji" characters, which are normally displayed as
2947 single width. Unfortunately there is no good specification for this
2948 and it has been determined on trial-and-error basis. Use the
2949 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002950
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002952'encoding' 'enc' string (default for MS-Windows: "utf-8",
2953 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 Sets the character encoding used inside Vim. It applies to text in
2956 the buffers, registers, Strings in expressions, text stored in the
2957 viminfo file, etc. It sets the kind of characters which Vim can work
2958 with. See |encoding-names| for the possible values.
2959
2960 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002961 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002963 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964
Bram Moolenaar865242e2010-07-14 21:12:05 +02002965 This option cannot be set from a |modeline|. It would most likely
2966 corrupt the text.
2967
Bram Moolenaar3df01732017-02-17 22:47:16 +01002968 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2969 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 'encoding', "utf-8" is the natural choice for the environment and
2971 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002972 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 versions, and to avoid changing the encoding of newly created files
2974 without your knowledge (in case 'fileencodings' is empty).
2975
2976 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002977 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 iconv() or as specified with 'charconvert'.
2979
Bram Moolenaar207f0092020-08-30 17:20:20 +02002980 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002981 can use: >
2982 if has("multi_byte_encoding")
2983<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 Normally 'encoding' will be equal to your current locale. This will
2985 be the default if Vim recognizes your environment settings. If
2986 'encoding' is not set to the current locale, 'termencoding' must be
2987 set to convert typed and displayed text. See |encoding-table|.
2988
2989 When you set this option, it fires the |EncodingChanged| autocommand
2990 event so that you can set up fonts if necessary.
2991
2992 When the option is set, the value is converted to lowercase. Thus
2993 you can set it with uppercase values too. Underscores are translated
2994 to '-' signs.
2995 When the encoding is recognized, it is changed to the standard name.
2996 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2997 "iso-8859-2" and "utf8" becomes "utf-8".
2998
2999 Note: "latin1" is also used when the encoding could not be detected.
3000 This only works when editing files in the same encoding! When the
3001 actual character set is not latin1, make sure 'fileencoding' and
3002 'fileencodings' are empty. When conversion is needed, switch to using
3003 utf-8.
3004
3005 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3006 You don't notice this while editing, but it does matter for the
3007 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3008 setting 'encoding' to one of these values instead of utf-8 only has
3009 effect for encoding used for files when 'fileencoding' is empty.
3010
Bram Moolenaar661b1822005-07-28 22:36:45 +00003011 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3012 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013
3014 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3015'endofline' 'eol' boolean (default on)
3016 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003018 is on, or 'fixeol' option is off, no <EOL> will be written for the
3019 last line in the file. This option is automatically set or reset when
3020 starting to edit a new file, depending on whether file has an <EOL>
3021 for the last line in the file. Normally you don't have to set or
3022 reset this option.
3023 When 'binary' is off and 'fixeol' is on the value is not used when
3024 writing the file. When 'binary' is on or 'fixeol' is off it is used
3025 to remember the presence of a <EOL> for the last line in the file, so
3026 that when you write the file the situation from the original file can
3027 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028
3029 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3030'equalalways' 'ea' boolean (default on)
3031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003033 splitting or closing a window. This also happens the moment the
3034 option is switched on. When off, splitting a window will reduce the
3035 size of the current window and leave the other windows the same. When
3036 closing a window the extra lines are given to the window next to it
3037 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 When mixing vertically and horizontally split windows, a minimal size
3039 is computed and some windows may be larger if there is room. The
3040 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003041 Changing the height and width of a window can be avoided by setting
3042 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003043 If a window size is specified when creating a new window sizes are
3044 currently not equalized (it's complicated, but may be implemented in
3045 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046
3047 *'equalprg'* *'ep'*
3048'equalprg' 'ep' string (default "")
3049 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003051 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003052 or 'indentexpr'. When Vim was compiled without internal formatting,
3053 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003054 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 about including spaces and backslashes.
3056 This option cannot be set from a |modeline| or in the |sandbox|, for
3057 security reasons.
3058
3059 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3060'errorbells' 'eb' boolean (default off)
3061 global
3062 Ring the bell (beep or screen flash) for error messages. This only
3063 makes a difference for error messages, the bell will be used always
3064 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003065 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003066 screen flash or do nothing. See 'belloff' to finetune when to ring the
3067 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068
3069 *'errorfile'* *'ef'*
3070'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3071 others: "errors.err")
3072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 {not available when compiled without the |+quickfix|
3074 feature}
3075 Name of the errorfile for the QuickFix mode (see |:cf|).
3076 When the "-q" command-line argument is used, 'errorfile' is set to the
3077 following argument. See |-q|.
3078 NOT used for the ":make" command. See 'makeef' for that.
3079 Environment variables are expanded |:set_env|.
3080 See |option-backslash| about including spaces and backslashes.
3081 This option cannot be set from a |modeline| or in the |sandbox|, for
3082 security reasons.
3083
3084 *'errorformat'* *'efm'*
3085'errorformat' 'efm' string (default is very long)
3086 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 {not available when compiled without the |+quickfix|
3088 feature}
3089 Scanf-like description of the format for the lines in the error file
3090 (see |errorformat|).
3091
3092 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3093'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 Function keys that start with an <Esc> are recognized in Insert
3096 mode. When this option is off, the cursor and function keys cannot be
3097 used in Insert mode if they start with an <Esc>. The advantage of
3098 this is that the single <Esc> is recognized immediately, instead of
3099 after one second. Instead of resetting this option, you might want to
3100 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3101 when 'esckeys' is off, you can still map anything, but the cursor keys
3102 won't work by default.
3103 NOTE: This option is set to the Vi default value when 'compatible' is
3104 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003105 NOTE: when this option is off then the |modifyOtherKeys| functionality
3106 is disabled while in Insert mode to avoid ending Insert mode with any
3107 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108
3109 *'eventignore'* *'ei'*
3110'eventignore' 'ei' string (default "")
3111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003113 When set to "all" or when "all" is one of the items, all autocommand
3114 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 Otherwise this is a comma separated list of event names. Example: >
3116 :set ei=WinEnter,WinLeave
3117<
3118 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3119'expandtab' 'et' boolean (default off)
3120 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003122 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3124 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003125 This option is reset when the 'paste' option is set and restored when
3126 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 NOTE: This option is reset when 'compatible' is set.
3128
3129 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3130'exrc' 'ex' boolean (default off)
3131 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003133 directory.
3134
3135 Setting this option is a potential security leak. E.g., consider
3136 unpacking a package or fetching files from github, a .vimrc in there
3137 might be a trojan horse. BETTER NOT SET THIS OPTION!
3138 Instead, define an autocommand in your .vimrc to set options for a
3139 matching directory.
3140
3141 If you do switch this option on you should also consider setting the
3142 'secure' option (see |initialization|).
3143 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 This option cannot be set from a |modeline| or in the |sandbox|, for
3145 security reasons.
3146
3147 *'fileencoding'* *'fenc'* *E213*
3148'fileencoding' 'fenc' string (default: "")
3149 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003151
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003153 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 When 'fileencoding' is empty, the same value as 'encoding' will be
3155 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003156 No error will be given when the value is set, only when it is used,
3157 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003158 Conversion will also be done when 'encoding' and 'fileencoding' are
3159 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3160 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003162 'encoding' is "utf-8" or another Unicode encoding, conversion
3163 is most likely done in a way that the reverse conversion
3164 results in the same text. When 'encoding' is not "utf-8" some
3165 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003166
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 See 'encoding' for the possible values. Additionally, values may be
3168 specified that can be handled by the converter, see
3169 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003170
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 When reading a file 'fileencoding' will be set from 'fileencodings'.
3172 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003173 'fileencoding', use the |++enc| argument. One exception: when
3174 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003175 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003176
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3178 When the option is set, the value is converted to lowercase. Thus
3179 you can set it with uppercase values too. '_' characters are
3180 replaced with '-'. If a name is recognized from the list for
3181 'encoding', it is replaced by the standard name. For example
3182 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003183
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 When this option is set, after starting to edit a file, the 'modified'
3185 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003186
3187 Keep in mind that changing 'fenc' from a modeline happens
3188 AFTER the text has been read, thus it applies to when the file will be
3189 written. If you do set 'fenc' in a modeline, you might want to set
3190 'nomodified' to avoid not being able to ":q".
3191
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 This option can not be changed when 'modifiable' is off.
3193
3194 *'fe'*
3195 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003196 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 old short name was 'fe', which is no longer used.
3198
3199 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003200'fileencodings' 'fencs' string (default: "ucs-bom",
3201 "ucs-bom,utf-8,default,latin1" when
3202 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 This is a list of character encodings considered when starting to edit
3205 an existing file. When a file is read, Vim tries to use the first
3206 mentioned character encoding. If an error is detected, the next one
3207 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003208 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 an empty string, which means the value of 'encoding' is used.
3210 WARNING: Conversion can cause loss of information! When
3211 'encoding' is "utf-8" (or one of the other Unicode variants)
3212 conversion is most likely done in a way that the reverse
3213 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003214 "utf-8" some non-ASCII characters may be lost! You can use
3215 the |++bad| argument to specify what is done with characters
3216 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 For an empty file or a file with only ASCII characters most encodings
3218 will work and the first entry of 'fileencodings' will be used (except
3219 "ucs-bom", which requires the BOM to be present). If you prefer
3220 another encoding use an BufReadPost autocommand event to test if your
3221 preferred encoding is to be used. Example: >
3222 au BufReadPost * if search('\S', 'w') == 0 |
3223 \ set fenc=iso-2022-jp | endif
3224< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3225 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003226 When the |++enc| argument is used then the value of 'fileencodings' is
3227 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003228 Note that 'fileencodings' is not used for a new file, the global value
3229 of 'fileencoding' is used instead. You can set it with: >
3230 :setglobal fenc=iso-8859-2
3231< This means that a non-existing file may get a different encoding than
3232 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 The special value "ucs-bom" can be used to check for a Unicode BOM
3234 (Byte Order Mark) at the start of the file. It must not be preceded
3235 by "utf-8" or another Unicode encoding for this to work properly.
3236 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3237 because Vim cannot detect an error, thus the encoding is always
3238 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003239 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003240 environment. On MS-Windows this is the system encoding. Otherwise
3241 this is the default value for 'encoding'. It is useful when
3242 'encoding' is set to "utf-8" and your environment uses a non-latin1
3243 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003244 When 'encoding' is "utf-8" and a file contains an illegal byte
3245 sequence it won't be recognized as UTF-8. You can use the |8g8|
3246 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 WRONG VALUES: WHAT'S WRONG:
3248 latin1,utf-8 "latin1" will always be used
3249 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3250 file
3251 cp1250,latin1 "cp1250" will always be used
3252 If 'fileencodings' is empty, 'fileencoding' is not modified.
3253 See 'fileencoding' for the possible values.
3254 Setting this option does not have an effect until the next time a file
3255 is read.
3256
3257 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003258'fileformat' 'ff' string (MS-Windows default: "dos",
3259 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 This gives the <EOL> of the current buffer, which is used for
3262 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003263 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 unix <NL>
3265 mac <CR>
3266 When "dos" is used, CTRL-Z at the end of a file is ignored.
3267 See |file-formats| and |file-read|.
3268 For the character encoding of the file see 'fileencoding'.
3269 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003270 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 This option is set automatically when starting to edit a file and
3272 'fileformats' is not empty and 'binary' is off.
3273 When this option is set, after starting to edit a file, the 'modified'
3274 option is set, because the file would be different when written.
3275 This option can not be changed when 'modifiable' is off.
3276 For backwards compatibility: When this option is set to "dos",
3277 'textmode' is set, otherwise 'textmode' is reset.
3278
3279 *'fileformats'* *'ffs'*
3280'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003281 Vim+Vi MS-Windows: "dos,unix",
3282 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 Vi Cygwin: "unix,dos",
3284 Vi others: "")
3285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 This gives the end-of-line (<EOL>) formats that will be tried when
3287 starting to edit a new buffer and when reading a file into an existing
3288 buffer:
3289 - When empty, the format defined with 'fileformat' will be used
3290 always. It is not set automatically.
3291 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003292 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 'fileformats' name will be used when a file is read into an existing
3294 buffer, no matter what 'fileformat' for that buffer is set to.
3295 - When more than one name is present, separated by commas, automatic
3296 <EOL> detection will be done when reading a file. When starting to
3297 edit a file, a check is done for the <EOL>:
3298 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3299 'fileformat' is set to "dos".
3300 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003301 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003303 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3304 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003305 This means that "mac" is only chosen when:
3306 "unix" is not present or no <NL> is found in the file, and
3307 "dos" is not present or no <CR><NL> is found in the file.
3308 Except: if "unix" was chosen, but there is a <CR> before
3309 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003310 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 4. If 'fileformat' is still not set, the first name from
3312 'fileformats' is used.
3313 When reading a file into an existing buffer, the same is done, but
3314 this happens like 'fileformat' has been set appropriately for that
3315 file only, the option is not changed.
3316 When 'binary' is set, the value of 'fileformats' is not used.
3317
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003318 When Vim starts up with an empty buffer the first item is used. You
3319 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003320
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3322 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3323 done:
3324 - When 'fileformats' is empty, there is no automatic detection. Dos
3325 format will be used.
3326 - When 'fileformats' is set to one or more names, automatic detection
3327 is done. This is based on the first <NL> in the file: If there is a
3328 <CR> in front of it, Dos format is used, otherwise Unix format is
3329 used.
3330 Also see |file-formats|.
3331 For backwards compatibility: When this option is set to an empty
3332 string or one format (no comma is included), 'textauto' is reset,
3333 otherwise 'textauto' is set.
3334 NOTE: This option is set to the Vi default value when 'compatible' is
3335 set and to the Vim default value when 'compatible' is reset.
3336
Bram Moolenaarbf884932013-04-05 22:26:15 +02003337 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3338'fileignorecase' 'fic' boolean (default on for systems where case in file
3339 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003340 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003341 When set case is ignored when using file names and directories.
3342 See 'wildignorecase' for only ignoring case when doing completion.
3343
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 *'filetype'* *'ft'*
3345'filetype' 'ft' string (default: "")
3346 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 When this option is set, the FileType autocommand event is triggered.
3348 All autocommands that match with the value of this option will be
3349 executed. Thus the value of 'filetype' is used in place of the file
3350 name.
3351 Otherwise this option does not always reflect the current file type.
3352 This option is normally set when the file type is detected. To enable
3353 this use the ":filetype on" command. |:filetype|
3354 Setting this option to a different value is most useful in a modeline,
3355 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003356 Example, for in an IDL file:
3357 /* vim: set filetype=idl : */ ~
3358 |FileType| |filetypes|
3359 When a dot appears in the value then this separates two filetype
3360 names. Example:
3361 /* vim: set filetype=c.doxygen : */ ~
3362 This will use the "c" filetype first, then the "doxygen" filetype.
3363 This works both for filetype plugins and for syntax files. More than
3364 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 This option is not copied to another buffer, independent of the 's' or
3366 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003367 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368
3369 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003370'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003372 {not available when compiled without the |+folding|
3373 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 Characters to fill the statuslines and vertical separators.
3375 It is a comma separated list of items:
3376
3377 item default Used for ~
3378 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003379 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 vert:c '|' vertical separators |:vsplit|
3381 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003382 foldopen:c '-' mark the beginning of a fold
3383 foldclose:c '+' show a closed fold
3384 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003386 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003388 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003389 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 otherwise.
3391
3392 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003393 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394< This is similar to the default, except that these characters will also
3395 be used when there is highlighting.
3396
Bram Moolenaar008bff92021-03-04 21:55:58 +01003397 For "stl" and "stlnc" single-byte and multibyte characters are
3398 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003399
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 The highlighting used for these items:
3401 item highlight group ~
3402 stl:c StatusLine |hl-StatusLine|
3403 stlnc:c StatusLineNC |hl-StatusLineNC|
3404 vert:c VertSplit |hl-VertSplit|
3405 fold:c Folded |hl-Folded|
3406 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003407 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003409 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3410'fixendofline' 'fixeol' boolean (default on)
3411 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003412 When writing a file and this option is on, <EOL> at the end of file
3413 will be restored if missing. Turn this option off if you want to
3414 preserve the situation from the original file.
3415 When the 'binary' option is set the value of this option doesn't
3416 matter.
3417 See the 'endofline' option.
3418
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003420'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 {only available when compiled with the |+rightleft|
3423 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003424 This option was for using Farsi, which has been removed. See
3425 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426
3427 *'foldclose'* *'fcl'*
3428'foldclose' 'fcl' string (default "")
3429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 {not available when compiled without the |+folding|
3431 feature}
3432 When set to "all", a fold is closed when the cursor isn't in it and
3433 its level is higher than 'foldlevel'. Useful if you want folds to
3434 automatically close when moving out of them.
3435
3436 *'foldcolumn'* *'fdc'*
3437'foldcolumn' 'fdc' number (default 0)
3438 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 {not available when compiled without the |+folding|
3440 feature}
3441 When non-zero, a column with the specified width is shown at the side
3442 of the window which indicates open and closed folds. The maximum
3443 value is 12.
3444 See |folding|.
3445
3446 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3447'foldenable' 'fen' boolean (default on)
3448 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 {not available when compiled without the |+folding|
3450 feature}
3451 When off, all folds are open. This option can be used to quickly
3452 switch between showing all text unfolded and viewing the text with
3453 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003454 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 'foldenable' is off.
3456 This option is set by commands that create a new fold or close a fold.
3457 See |folding|.
3458
3459 *'foldexpr'* *'fde'*
3460'foldexpr' 'fde' string (default: "0")
3461 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003463 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003465 for each line to obtain its fold level. The context is set to the
3466 script where 'foldexpr' was set, script-local items can be accessed.
3467 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003468
Bram Moolenaar30b65812012-07-12 22:01:11 +02003469 The expression will be evaluated in the |sandbox| if set from a
3470 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003471 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003472 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003473
3474 It is not allowed to change text or jump to another window while
3475 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476
3477 *'foldignore'* *'fdi'*
3478'foldignore' 'fdi' string (default: "#")
3479 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 {not available when compiled without the |+folding|
3481 feature}
3482 Used only when 'foldmethod' is "indent". Lines starting with
3483 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003484 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 The default "#" works well for C programs. See |fold-indent|.
3486
3487 *'foldlevel'* *'fdl'*
3488'foldlevel' 'fdl' number (default: 0)
3489 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 {not available when compiled without the |+folding|
3491 feature}
3492 Sets the fold level: Folds with a higher level will be closed.
3493 Setting this option to zero will close all folds. Higher numbers will
3494 close fewer folds.
3495 This option is set by commands like |zm|, |zM| and |zR|.
3496 See |fold-foldlevel|.
3497
3498 *'foldlevelstart'* *'fdls'*
3499'foldlevelstart' 'fdls' number (default: -1)
3500 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 {not available when compiled without the |+folding|
3502 feature}
3503 Sets 'foldlevel' when starting to edit another buffer in a window.
3504 Useful to always start editing with all folds closed (value zero),
3505 some folds closed (one) or no folds closed (99).
3506 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003507 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 ignores this option and closes all folds.
3509 It is also done before BufReadPre autocommands, to allow an autocmd to
3510 overrule the 'foldlevel' value for specific files.
3511 When the value is negative, it is not used.
3512
3513 *'foldmarker'* *'fmr'* *E536*
3514'foldmarker' 'fmr' string (default: "{{{,}}}")
3515 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 {not available when compiled without the |+folding|
3517 feature}
3518 The start and end marker used when 'foldmethod' is "marker". There
3519 must be one comma, which separates the start and end marker. The
3520 marker is a literal string (a regular expression would be too slow).
3521 See |fold-marker|.
3522
3523 *'foldmethod'* *'fdm'*
3524'foldmethod' 'fdm' string (default: "manual")
3525 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 {not available when compiled without the |+folding|
3527 feature}
3528 The kind of folding used for the current window. Possible values:
3529 |fold-manual| manual Folds are created manually.
3530 |fold-indent| indent Lines with equal indent form a fold.
3531 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3532 |fold-marker| marker Markers are used to specify folds.
3533 |fold-syntax| syntax Syntax highlighting items specify folds.
3534 |fold-diff| diff Fold text that is not changed.
3535
3536 *'foldminlines'* *'fml'*
3537'foldminlines' 'fml' number (default: 1)
3538 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 {not available when compiled without the |+folding|
3540 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003541 Sets the number of screen lines above which a fold can be displayed
3542 closed. Also for manually closed folds. With the default value of
3543 one a fold can only be closed if it takes up two or more screen lines.
3544 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003545 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 "zc" to close a fold, which is displayed open because it's smaller
3547 than 'foldminlines', a following "zc" may close a containing fold.
3548
3549 *'foldnestmax'* *'fdn'*
3550'foldnestmax' 'fdn' number (default: 20)
3551 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 {not available when compiled without the |+folding|
3553 feature}
3554 Sets the maximum nesting of folds for the "indent" and "syntax"
3555 methods. This avoids that too many folds will be created. Using more
3556 than 20 doesn't work, because the internal limit is 20.
3557
3558 *'foldopen'* *'fdo'*
3559'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3560 search,tag,undo")
3561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 {not available when compiled without the |+folding|
3563 feature}
3564 Specifies for which type of commands folds will be opened, if the
3565 command moves the cursor into a closed fold. It is a comma separated
3566 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003567 NOTE: When the command is part of a mapping this option is not used.
3568 Add the |zv| command to the mapping to get the same effect.
3569 (rationale: the mapping may want to control opening folds itself)
3570
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 item commands ~
3572 all any
3573 block "(", "{", "[[", "[{", etc.
3574 hor horizontal movements: "l", "w", "fx", etc.
3575 insert any command in Insert mode
3576 jump far jumps: "G", "gg", etc.
3577 mark jumping to a mark: "'m", CTRL-O, etc.
3578 percent "%"
3579 quickfix ":cn", ":crew", ":make", etc.
3580 search search for a pattern: "/", "n", "*", "gd", etc.
3581 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003582 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 tag jumping to a tag: ":ta", CTRL-T, etc.
3584 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 When a movement command is used for an operator (e.g., "dl" or "y%")
3586 this option is not used. This means the operator will include the
3587 whole closed fold.
3588 Note that vertical movements are not here, because it would make it
3589 very difficult to move onto a closed fold.
3590 In insert mode the folds containing the cursor will always be open
3591 when text is inserted.
3592 To close folds you can re-apply 'foldlevel' with the |zx| command or
3593 set the 'foldclose' option to "all".
3594
3595 *'foldtext'* *'fdt'*
3596'foldtext' 'fdt' string (default: "foldtext()")
3597 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 {not available when compiled without the |+folding|
3599 feature}
3600 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003601 fold. The context is set to the script where 'foldexpr' was set,
3602 script-local items can be accessed. See |fold-foldtext| for the
3603 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604
Bram Moolenaar30b65812012-07-12 22:01:11 +02003605 The expression will be evaluated in the |sandbox| if set from a
3606 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003607 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003608
3609 It is not allowed to change text or jump to another window while
3610 evaluating 'foldtext' |textlock|.
3611
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003612 *'formatexpr'* *'fex'*
3613'formatexpr' 'fex' string (default "")
3614 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003615 {not available when compiled without the |+eval|
3616 feature}
3617 Expression which is evaluated to format a range of lines for the |gq|
3618 operator or automatic formatting (see 'formatoptions'). When this
3619 option is empty 'formatprg' is used.
3620
3621 The |v:lnum| variable holds the first line to be formatted.
3622 The |v:count| variable holds the number of lines to be formatted.
3623 The |v:char| variable holds the character that is going to be
3624 inserted if the expression is being evaluated due to
3625 automatic formatting. This can be empty. Don't insert
3626 it yet!
3627
3628 Example: >
3629 :set formatexpr=mylang#Format()
3630< This will invoke the mylang#Format() function in the
3631 autoload/mylang.vim file in 'runtimepath'. |autoload|
3632
3633 The expression is also evaluated when 'textwidth' is set and adding
3634 text beyond that limit. This happens under the same conditions as
3635 when internal formatting is used. Make sure the cursor is kept in the
3636 same spot relative to the text then! The |mode()| function will
3637 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003638
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003639 When the expression evaluates to non-zero Vim will fall back to using
3640 the internal format mechanism.
3641
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003642 If the expression starts with s: or |<SID>|, then it is replaced with
3643 the script ID (|local-function|). Example: >
3644 set formatexpr=s:MyFormatExpr()
3645 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003646< Otherwise, the expression is evaluated in the context of the script
3647 where the option was set, thus script-local items are available.
3648
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003649 The expression will be evaluated in the |sandbox| when set from a
3650 modeline, see |sandbox-option|. That stops the option from working,
3651 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003652 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003653 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003654
Bram Moolenaar86b68352004-12-27 21:59:20 +00003655 *'formatlistpat'* *'flp'*
3656'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3657 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003658 A pattern that is used to recognize a list header. This is used for
3659 the "n" flag in 'formatoptions'.
3660 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003661 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003662 while still checking more characters. There must be a character
3663 following the pattern, when it matches the whole line it is handled
3664 like there is no match.
3665 The default recognizes a number, followed by an optional punctuation
3666 character and white space.
3667
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003668 *'formatoptions'* *'fo'*
3669'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3670 local to buffer
3671 This is a sequence of letters which describes how automatic
3672 formatting is to be done. See |fo-table|. When the 'paste' option is
3673 on, no formatting is done (like 'formatoptions' is empty). Commas can
3674 be inserted for readability.
3675 To avoid problems with flags that are added in the future, use the
3676 "+=" and "-=" feature of ":set" |add-option-flags|.
3677 NOTE: This option is set to the Vi default value when 'compatible' is
3678 set and to the Vim default value when 'compatible' is reset.
3679
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 *'formatprg'* *'fp'*
3681'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003682 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003684 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003686 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003687 If the 'formatexpr' option is not empty it will be used instead.
3688 Otherwise, if 'formatprg' option is an empty string, the internal
3689 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003690 Environment variables are expanded |:set_env|. See |option-backslash|
3691 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003692 This option cannot be set from a |modeline| or in the |sandbox|, for
3693 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694
Bram Moolenaard94464e2015-11-02 15:28:18 +01003695 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003696'fsync' 'fs' boolean (default on)
3697 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003698 When on, the library function fsync() will be called after writing a
3699 file. This will flush a file to disk, ensuring that it is safely
3700 written even on filesystems which do metadata-only journaling. This
3701 will force the harddrive to spin up on Linux systems running in laptop
3702 mode, so it may be undesirable in some situations. Be warned that
3703 turning this off increases the chances of data loss after a crash. On
3704 systems without an fsync() implementation, this variable is always
3705 off.
3706 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003707 'fsync' also applies to |writefile()| (unless a flag is used to
3708 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003709 This option cannot be set from a |modeline| or in the |sandbox|, for
3710 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003711
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3713'gdefault' 'gd' boolean (default off)
3714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 When on, the ":substitute" flag 'g' is default on. This means that
3716 all matches in a line are substituted instead of one. When a 'g' flag
3717 is given to a ":substitute" command, this will toggle the substitution
3718 of all or one match. See |complex-change|.
3719
3720 command 'gdefault' on 'gdefault' off ~
3721 :s/// subst. all subst. one
3722 :s///g subst. one subst. all
3723 :s///gg subst. all subst. one
3724
3725 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003726 DEPRECATED: Setting this option may break plugins that are not aware
3727 of this option. Also, many users get confused that adding the /g flag
3728 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003729 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730
3731 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003732'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 Format to recognize for the ":grep" command output.
3735 This is a scanf-like string that uses the same format as the
3736 'errorformat' option: see |errorformat|.
3737
3738 *'grepprg'* *'gp'*
3739'grepprg' 'gp' string (default "grep -n ",
3740 Unix: "grep -n $* /dev/null",
3741 Win32: "findstr /n" or "grep -n",
3742 VMS: "SEARCH/NUMBERS ")
3743 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003744 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 and '#' characters, which are expanded like when used in a command-
3746 line. The placeholder "$*" is allowed to specify where the arguments
3747 will be included. Environment variables are expanded |:set_env|. See
3748 |option-backslash| about including spaces and backslashes.
3749 When your "grep" accepts the "-H" argument, use this to make ":grep"
3750 also work well with a single file: >
3751 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003752< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003753 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3754 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003755 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 apply equally to 'grepprg'.
3757 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3758 otherwise it's "grep -n".
3759 This option cannot be set from a |modeline| or in the |sandbox|, for
3760 security reasons.
3761
3762 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3763'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3764 ve:ver35-Cursor,
3765 o:hor50-Cursor,
3766 i-ci:ver25-Cursor/lCursor,
3767 r-cr:hor20-Cursor/lCursor,
3768 sm:block-Cursor
3769 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003770 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 "n-v-c:block,o:hor50,i-ci:hor15,
3772 r-cr:hor30,sm:block")
3773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003775 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003777 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003778 height of the cursor can be changed. This can be done by specifying a
3779 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003780 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3781 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003783 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 mode-list and an argument-list:
3785 mode-list:argument-list,mode-list:argument-list,..
3786 The mode-list is a dash separated list of these modes:
3787 n Normal mode
3788 v Visual mode
3789 ve Visual mode with 'selection' "exclusive" (same as 'v',
3790 if not specified)
3791 o Operator-pending mode
3792 i Insert mode
3793 r Replace mode
3794 c Command-line Normal (append) mode
3795 ci Command-line Insert mode
3796 cr Command-line Replace mode
3797 sm showmatch in Insert mode
3798 a all modes
3799 The argument-list is a dash separated list of these arguments:
3800 hor{N} horizontal bar, {N} percent of the character height
3801 ver{N} vertical bar, {N} percent of the character width
3802 block block cursor, fills the whole character
3803 [only one of the above three should be present]
3804 blinkwait{N} *cursor-blinking*
3805 blinkon{N}
3806 blinkoff{N}
3807 blink times for cursor: blinkwait is the delay before
3808 the cursor starts blinking, blinkon is the time that
3809 the cursor is shown and blinkoff is the time that the
3810 cursor is not shown. The times are in msec. When one
3811 of the numbers is zero, there is no blinking. The
3812 default is: "blinkwait700-blinkon400-blinkoff250".
3813 These numbers are used for a missing entry. This
3814 means that blinking is enabled by default. To switch
3815 blinking off you can use "blinkon0". The cursor only
3816 blinks when Vim is waiting for input, not while
3817 executing a command.
3818 To make the cursor blink in an xterm, see
3819 |xterm-blink|.
3820 {group-name}
3821 a highlight group name, that sets the color and font
3822 for the cursor
3823 {group-name}/{group-name}
3824 Two highlight group names, the first is used when
3825 no language mappings are used, the other when they
3826 are. |language-mapping|
3827
3828 Examples of parts:
3829 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3830 block cursor with colors from the "nCursor"
3831 highlight group
3832 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3833 In Insert and Command-line Insert mode, use a
3834 30% vertical bar cursor with colors from the
3835 "iCursor" highlight group. Blink a bit
3836 faster.
3837
3838 The 'a' mode is different. It will set the given argument-list for
3839 all modes. It does not reset anything to defaults. This can be used
3840 to do a common setting for all modes. For example, to switch off
3841 blinking: "a:blinkon0"
3842
3843 Examples of cursor highlighting: >
3844 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3845 :highlight Cursor gui=NONE guifg=bg guibg=fg
3846<
3847 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003848 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849'guifont' 'gfn' string (default "")
3850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 {only available when compiled with GUI enabled}
3852 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003853 In its simplest form the value is just one font name.
3854 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855
3856 *'guifontset'* *'gfs'*
3857 *E250* *E252* *E234* *E597* *E598*
3858'guifontset' 'gfs' string (default "")
3859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 {only available when compiled with GUI enabled and
3861 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003862 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 When not empty, specifies two (or more) fonts to be used. The first
3864 one for normal English, the second one for your special language. See
3865 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003866
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3868'guifontwide' 'gfw' string (default "")
3869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 {only available when compiled with GUI enabled}
3871 When not empty, specifies a comma-separated list of fonts to be used
3872 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003873 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003874
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 *'guiheadroom'* *'ghr'*
3876'guiheadroom' 'ghr' number (default 50)
3877 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003878 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 The number of pixels subtracted from the screen height when fitting
3880 the GUI window on the screen. Set this before the GUI is started,
3881 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003882 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 lines will be left for window decorations and other items on the
3884 screen. Set it to a negative value to allow windows taller than the
3885 screen.
3886
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003887 *'guiligatures'* *'gli'* *E1243*
3888'guiligatures' 'gli' string (default "")
3889 global
3890 {only for GTK GUI}
3891 List of ASCII characters that, when combined together, can create more
3892 complex shapes. Each character must be a printable ASCII character
3893 with a value in the 32-127 range.
3894 Example: >
3895 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3896< Changing this option updates screen output immediately. Set it to an
3897 empty string to disable ligatures.
3898
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003900'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3901 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003902 "aegimrLtT" (GTK, Motif and Athena),
3903 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003906 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 sequence of letters which describes what components and options of the
3908 GUI should be used.
3909 To avoid problems with flags that are added in the future, use the
3910 "+=" and "-=" feature of ":set" |add-option-flags|.
3911
Bram Moolenaar13568252018-03-16 20:46:58 +01003912 Valid characters are as follows:
3913 *'go-!'*
3914 '!' External commands are executed in a terminal window. Without
3915 this flag the MS-Windows GUI will open a console window to
3916 execute the command. The Unix GUI will simulate a dumb
3917 terminal to list the command output.
3918 The terminal window will be positioned at the bottom, and grow
3919 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003920 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 'a' Autoselect: If present, then whenever VISUAL mode is started,
3922 or the Visual area extended, Vim tries to become the owner of
3923 the windowing system's global selection. This means that the
3924 Visually highlighted text is available for pasting into other
3925 applications as well as into Vim itself. When the Visual mode
3926 ends, possibly due to an operation on the text, or when an
3927 application wants to paste the selection, the highlighted text
3928 is automatically yanked into the "* selection register.
3929 Thus the selection is still available for pasting into other
3930 applications after the VISUAL mode has ended.
3931 If not present, then Vim won't become the owner of the
3932 windowing system's global selection unless explicitly told to
3933 by a yank or delete operation for the "* register.
3934 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003935 *'go-P'*
3936 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003937 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003938 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003939 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 applies to the modeless selection.
3941
3942 'guioptions' autoselect Visual autoselect modeless ~
3943 "" - -
3944 "a" yes yes
3945 "A" - yes
3946 "aA" yes yes
3947
Bram Moolenaar02467872007-05-06 13:22:01 +00003948 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 'c' Use console dialogs instead of popup dialogs for simple
3950 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003951 *'go-d'*
3952 'd' Use dark theme variant if available. Currently only works for
3953 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003954 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003955 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003956 'guitablabel' can be used to change the text in the labels.
3957 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003958 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003959 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003960 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 'f' Foreground: Don't use fork() to detach the GUI from the shell
3962 where it was started. Use this for programs that wait for the
3963 editor to finish (e.g., an e-mail program). Alternatively you
3964 can use "gvim -f" or ":gui -f" to start the GUI in the
3965 foreground. |gui-fork|
3966 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003967 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003968 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3970 corner of the window. It's black&white on non-GTK, because of
3971 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003972 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003974 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003975 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003977 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003979 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003980 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 'g' Grey menu items: Make menu items that are not active grey. If
3982 'g' is not included inactive menu items are not shown at all.
3983 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003984 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 't' Include tearoff menu items. Currently only works for Win32,
3986 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003987 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003988 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003989 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003990 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003992 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 'R' Right-hand scrollbar is present when there is a vertically
3994 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003995 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003997 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 'L' Left-hand scrollbar is present when there is a vertically
3999 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004000 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4002 the longest visible line, or on the cursor line if the 'h'
4003 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004004 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 'h' Limit horizontal scrollbar size to the length of the cursor
4006 line. Reduces computations. |gui-horiz-scroll|
4007
4008 And yes, you may even have scrollbars on the left AND the right if
4009 you really want to :-). See |gui-scrollbars| for more information.
4010
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004011 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 'v' Use a vertical button layout for dialogs. When not included,
4013 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004014 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004015 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 'p' Use Pointer callbacks for X11 GUI. This is required for some
4017 window managers. If the cursor is not blinking or hollow at
4018 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004019 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004021 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004022 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004023 *'go-k'*
4024 'k' Keep the GUI window size when adding/removing a scrollbar, or
4025 toolbar, tabline, etc. Instead, the behavior is similar to
4026 when the window is maximized and will adjust 'lines' and
4027 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004028 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004029 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004030
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 *'guipty'* *'noguipty'*
4032'guipty' boolean (default on)
4033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 {only available when compiled with GUI enabled}
4035 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4036 I/O to/from shell commands. See |gui-pty|.
4037
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004038 *'guitablabel'* *'gtl'*
4039'guitablabel' 'gtl' string (default empty)
4040 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004041 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004042 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004043 pages line. When empty and when the result is empty Vim will use a
4044 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004045
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004046 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004047 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004048 The expression will be evaluated in the |sandbox| when set from a
4049 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004050 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004051
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004052 Only used when the GUI tab pages line is displayed. 'e' must be
4053 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4054 used.
4055
Bram Moolenaar57657d82006-04-21 22:12:41 +00004056 *'guitabtooltip'* *'gtt'*
4057'guitabtooltip' 'gtt' string (default empty)
4058 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004059 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004060 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004061 pages line. When empty Vim will use a default tooltip.
4062 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004063 You can include a line break. Simplest method is to use |:let|: >
4064 :let &guitabtooltip = "line one\nline two"
4065<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004066
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004068'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 (others) "$VIMRUNTIME/doc/help.txt")
4070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 Name of the main help file. All distributed help files should be
4072 placed together in one directory. Additionally, all "doc" directories
4073 in 'runtimepath' will be used.
4074 Environment variables are expanded |:set_env|. For example:
4075 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004076 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 spaces and backslashes.
4078 This option cannot be set from a |modeline| or in the |sandbox|, for
4079 security reasons.
4080
4081 *'helpheight'* *'hh'*
4082'helpheight' 'hh' number (default 20)
4083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 Minimal initial height of the help window when it is opened with the
4085 ":help" command. The initial height of the help window is half of the
4086 current window, or (when the 'ea' option is on) the same as other
4087 windows. When the height is less than 'helpheight', the height is
4088 set to 'helpheight'. Set to zero to disable.
4089
4090 *'helplang'* *'hlg'*
4091'helplang' 'hlg' string (default: messages language or empty)
4092 global
4093 {only available when compiled with the |+multi_lang|
4094 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 Comma separated list of languages. Vim will use the first language
4096 for which the desired help can be found. The English help will always
4097 be used as a last resort. You can add "en" to prefer English over
4098 another language, but that will only find tags that exist in that
4099 language and not in the English help.
4100 Example: >
4101 :set helplang=de,it
4102< This will first search German, then Italian and finally English help
4103 files.
4104 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4105 try to find the tag in the current language before using this option.
4106 See |help-translated|.
4107
4108 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4109'hidden' 'hid' boolean (default off)
4110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 When off a buffer is unloaded when it is |abandon|ed. When on a
4112 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4113 displayed in another window, it does not become hidden, of course.
4114 The commands that move through the buffer list sometimes make a buffer
4115 hidden although the 'hidden' option is off: When the buffer is
4116 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004117 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004118 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 This option is set for one command with ":hide {command}" |:hide|.
4120 WARNING: It's easy to forget that you have changes in hidden buffers.
4121 Think twice when using ":q!" or ":qa!".
4122
4123 *'highlight'* *'hl'*
4124'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004125 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4126 d:Directory,e:ErrorMsg,i:IncSearch,
4127 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004128 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004129 N:CursorLineNr,r:Question,s:StatusLine,
4130 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004131 v:Visual,V:VisualNOS,w:WarningMsg,
4132 W:WildMenu,f:Folded,F:FoldColumn,
4133 A:DiffAdd,C:DiffChange,D:DiffDelete,
4134 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004135 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004136 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004137 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4138 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004139 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004140 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 This option can be used to set highlighting mode for various
4143 occasions. It is a comma separated list of character pairs. The
4144 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004145 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004147 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4148 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 characters from 'showbreak'
4150 |hl-Directory| d directories in CTRL-D listing and other special
4151 things in listings
4152 |hl-ErrorMsg| e error messages
4153 h (obsolete, ignored)
4154 |hl-IncSearch| i 'incsearch' highlighting
4155 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4156 |hl-MoreMsg| m |more-prompt|
4157 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004158 |hl-LineNr| n line number for ":number" and ":#" commands, and
4159 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004160 |hl-LineNrAbove| a line number above the cursor for when the
4161 'relativenumber' option is set.
4162 |hl-LineNrBelow| b line number below the cursor for when the
4163 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004164 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4165 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 |hl-Question| r |hit-enter| prompt and yes/no questions
4167 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004168 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4170 |hl-VertSplit| c column used to separate vertically split windows
4171 |hl-Visual| v Visual mode
4172 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4173 Selection" Only X11 Gui's |gui-x11| and
4174 |xterm-clipboard|.
4175 |hl-WarningMsg| w warning messages
4176 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4177 |hl-Folded| f line used for closed folds
4178 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004179 |hl-DiffAdd| A added line in diff mode
4180 |hl-DiffChange| C changed line in diff mode
4181 |hl-DiffDelete| D deleted line in diff mode
4182 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004184 |hl-Conceal| - the placeholders used for concealed characters
4185 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004186 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004187 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004188 |hl-SpellRare| R rare word |spell|
4189 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004190 |hl-Pmenu| + popup menu normal line
4191 |hl-PmenuSel| = popup menu selected line
4192 |hl-PmenuSbar| x popup menu scrollbar
4193 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194
4195 The display modes are:
4196 r reverse (termcap entry "mr" and "me")
4197 i italic (termcap entry "ZH" and "ZR")
4198 b bold (termcap entry "md" and "me")
4199 s standout (termcap entry "so" and "se")
4200 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004201 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004202 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 n no highlighting
4204 - no highlighting
4205 : use a highlight group
4206 The default is used for occasions that are not included.
4207 If you want to change what the display modes do, see |dos-colors|
4208 for an example.
4209 When using the ':' display mode, this must be followed by the name of
4210 a highlight group. A highlight group can be used to define any type
4211 of highlighting, including using color. See |:highlight| on how to
4212 define one. The default uses a different group for each occasion.
4213 See |highlight-default| for the default highlight groups.
4214
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004216'history' 'hi' number (Vim default: 50, Vi default: 0,
4217 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004220 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004222 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 NOTE: This option is set to the Vi default value when 'compatible' is
4224 set and to the Vim default value when 'compatible' is reset.
4225
4226 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4227'hkmap' 'hk' boolean (default off)
4228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 {only available when compiled with the |+rightleft|
4230 feature}
4231 When on, the keyboard is mapped for the Hebrew character set.
4232 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4233 toggle this option. See |rileft.txt|.
4234 NOTE: This option is reset when 'compatible' is set.
4235
4236 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4237'hkmapp' 'hkp' boolean (default off)
4238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 {only available when compiled with the |+rightleft|
4240 feature}
4241 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4242 This is useful if you have a non-Hebrew keyboard.
4243 See |rileft.txt|.
4244 NOTE: This option is reset when 'compatible' is set.
4245
Bram Moolenaar036986f2017-03-16 17:41:02 +01004246 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4247'hlsearch' 'hls' boolean (default off)
4248 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004249 {not available when compiled without the
4250 |+extra_search| feature}
4251 When there is a previous search pattern, highlight all its matches.
4252 The type of highlighting used can be set with the 'l' occasion in the
4253 'highlight' option. This uses the "Search" highlight group by
4254 default. Note that only the matching text is highlighted, any offsets
4255 are not applied.
4256 See also: 'incsearch' and |:match|.
4257 When you get bored looking at the highlighted matches, you can turn it
4258 off with |:nohlsearch|. This does not change the option value, as
4259 soon as you use a search command, the highlighting comes back.
4260 'redrawtime' specifies the maximum time spent on finding matches.
4261 When the search pattern can match an end-of-line, Vim will try to
4262 highlight all of the matched text. However, this depends on where the
4263 search starts. This will be the first line in the window or the first
4264 line below a closed fold. A match in a previous line which is not
4265 drawn may not continue in a newly drawn line.
4266 You can specify whether the highlight status is restored on startup
4267 with the 'h' flag in 'viminfo' |viminfo-h|.
4268 NOTE: This option is reset when 'compatible' is set.
4269
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 *'icon'* *'noicon'*
4271'icon' boolean (default off, on when title can be restored)
4272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 When on, the icon text of the window will be set to the value of
4274 'iconstring' (if it is not empty), or to the name of the file
4275 currently being edited. Only the last part of the name is used.
4276 Overridden by the 'iconstring' option.
4277 Only works if the terminal supports setting window icons (currently
4278 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4279 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4280 builtin termcap).
4281 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004282 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004284 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285
4286 *'iconstring'*
4287'iconstring' string (default "")
4288 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 When this option is not empty, it will be used for the icon text of
4290 the window. This happens only when the 'icon' option is on.
4291 Only works if the terminal supports setting window icon text
4292 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004293 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 When Vim was compiled with HAVE_X11 defined, the original icon will be
4295 restored if possible |X11|.
4296 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004297 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004299 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 {not available when compiled without the |+statusline| feature}
4301
4302 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4303'ignorecase' 'ic' boolean (default off)
4304 global
4305 Ignore case in search patterns. Also used when searching in the tags
4306 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004307 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 Can be overruled by using "\c" or "\C" in the pattern, see
4309 |/ignorecase|.
4310
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004311 *'imactivatefunc'* *'imaf'*
4312'imactivatefunc' 'imaf' string (default "")
4313 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004314 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004315 activate or deactivate the Input Method. The value can be the name of
4316 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4317 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004318 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004319 The expression will be evaluated in the |sandbox| when set from a
4320 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004321
4322 Example: >
4323 function ImActivateFunc(active)
4324 if a:active
4325 ... do something
4326 else
4327 ... do something
4328 endif
4329 " return value is not used
4330 endfunction
4331 set imactivatefunc=ImActivateFunc
4332<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 *'imactivatekey'* *'imak'*
4334'imactivatekey' 'imak' string (default "")
4335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004337 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 Specifies the key that your Input Method in X-Windows uses for
4339 activation. When this is specified correctly, vim can fully control
4340 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4341 You can't use this option to change the activation key, the option
4342 tells Vim what the key is.
4343 Format:
4344 [MODIFIER_FLAG-]KEY_STRING
4345
4346 These characters can be used for MODIFIER_FLAG (case is ignored):
4347 S Shift key
4348 L Lock key
4349 C Control key
4350 1 Mod1 key
4351 2 Mod2 key
4352 3 Mod3 key
4353 4 Mod4 key
4354 5 Mod5 key
4355 Combinations are allowed, for example "S-C-space" or "SC-space" are
4356 both shift+ctrl+space.
4357 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4358
4359 Example: >
4360 :set imactivatekey=S-space
4361< "S-space" means shift+space. This is the activation key for kinput2 +
4362 canna (Japanese), and ami (Korean).
4363
4364 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4365'imcmdline' 'imc' boolean (default off)
4366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 When set the Input Method is always on when starting to edit a command
4368 line, unless entering a search pattern (see 'imsearch' for that).
4369 Setting this option is useful when your input method allows entering
4370 English characters directly, e.g., when it's used to type accented
4371 characters with dead keys.
4372
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004373 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 When set the Input Method is never used. This is useful to disable
4377 the IM when it doesn't work properly.
4378 Currently this option is on by default for SGI/IRIX machines. This
4379 may change in later releases.
4380
4381 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004382'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 Specifies whether :lmap or an Input Method (IM) is to be used in
4385 Insert mode. Valid values:
4386 0 :lmap is off and IM is off
4387 1 :lmap is ON and IM is off
4388 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 To always reset the option to zero when leaving Insert mode with <Esc>
4390 this can be used: >
4391 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4392< This makes :lmap and IM turn off automatically when leaving Insert
4393 mode.
4394 Note that this option changes when using CTRL-^ in Insert mode
4395 |i_CTRL-^|.
4396 The value is set to 1 when setting 'keymap' to a valid keymap name.
4397 It is also used for the argument of commands like "r" and "f".
4398 The value 0 may not work correctly with Athena and Motif with some XIM
4399 methods. Use 'imdisable' to disable XIM then.
4400
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004401 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004402 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004403 |+multi_byte_ime| or |global-ime|.
4404
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004406'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 Specifies whether :lmap or an Input Method (IM) is to be used when
4409 entering a search pattern. Valid values:
4410 -1 the value of 'iminsert' is used, makes it look like
4411 'iminsert' is also used when typing a search pattern
4412 0 :lmap is off and IM is off
4413 1 :lmap is ON and IM is off
4414 2 :lmap is off and IM is ON
4415 Note that this option changes when using CTRL-^ in Command-line mode
4416 |c_CTRL-^|.
4417 The value is set to 1 when it is not -1 and setting the 'keymap'
4418 option to a valid keymap name.
4419 The value 0 may not work correctly with Athena and Motif with some XIM
4420 methods. Use 'imdisable' to disable XIM then.
4421
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004422 *'imstatusfunc'* *'imsf'*
4423'imstatusfunc' 'imsf' string (default "")
4424 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004425 This option specifies a function that is called to obtain the status
4426 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004427 The value can be the name of a function, a |lambda| or a |Funcref|.
4428 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004429 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004430
4431 Example: >
4432 function ImStatusFunc()
4433 let is_active = ...do something
4434 return is_active ? 1 : 0
4435 endfunction
4436 set imstatusfunc=ImStatusFunc
4437<
4438 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004439 The expression will be evaluated in the |sandbox| when set from a
4440 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004441
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004442 *'imstyle'* *'imst'*
4443'imstyle' 'imst' number (default 1)
4444 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004445 {only available when compiled with |+xim| and
4446 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004447 This option specifies the input style of Input Method:
4448 0 use on-the-spot style
4449 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004450 See: |xim-input-style|
4451
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004452 For a long time on-the-spot style had been used in the GTK version of
4453 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004454 |single-repeat|, etc. Therefore over-the-spot style becomes the
4455 default now. This should work fine for most people, however if you
4456 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004457 The expression will be evaluated in the |sandbox| when set from a
4458 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004459
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 *'include'* *'inc'*
4461'include' 'inc' string (default "^\s*#\s*include")
4462 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 {not available when compiled without the
4464 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004465 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 pattern, just like for the "/" command (See |pattern|). The default
4467 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004468 "]I", "[d", etc.
4469 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004470 comes after the matched pattern. But if "\zs" appears in the pattern
4471 then the text matched from "\zs" to the end, or until "\ze" if it
4472 appears, is used as the file name. Use this to include characters
4473 that are not in 'isfname', such as a space. You can then use
4474 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004475 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476
4477 *'includeexpr'* *'inex'*
4478'includeexpr' 'inex' string (default "")
4479 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004481 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004483 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 :set includeexpr=substitute(v:fname,'\\.','/','g')
4485< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004486
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004488 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 Also used for |<cfile>|.
4490
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004491 If the expression starts with s: or |<SID>|, then it is replaced with
4492 the script ID (|local-function|). Example: >
4493 set includeexpr=s:MyIncludeExpr(v:fname)
4494 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004495< Otherwise, the expression is evaluated in the context of the script
4496 where the option was set, thus script-local items are available.
4497
Bram Moolenaar30b65812012-07-12 22:01:11 +02004498 The expression will be evaluated in the |sandbox| when set from a
4499 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004500 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004501
4502 It is not allowed to change text or jump to another window while
4503 evaluating 'includeexpr' |textlock|.
4504
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004506'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4507 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004510 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004511 While typing a search command, show where the pattern, as it was typed
4512 so far, matches. The matched string is highlighted. If the pattern
4513 is invalid or not found, nothing is shown. The screen will be updated
4514 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004515 Also applies to the pattern in commands: >
4516 :global
4517 :lvimgrep
4518 :lvimgrepadd
4519 :smagic
4520 :snomagic
4521 :sort
4522 :substitute
4523 :vglobal
4524 :vimgrep
4525 :vimgrepadd
4526< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004527 original position when no match is found and when pressing <Esc>. You
4528 still need to finish the search command with <Enter> to move the
4529 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004530 You can use the CTRL-G and CTRL-T keys to move to the next and
4531 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004532 When compiled with the |+reltime| feature Vim only searches for about
4533 half a second. With a complicated pattern and/or a lot of text the
4534 match may not be found. This is to avoid that Vim hangs while you
4535 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004536 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004537 When 'hlsearch' is on, all matched strings are highlighted too while
4538 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004539 If you don't want to turn 'hlsearch' on, but want to highlight all
4540 matches while searching, you can turn on and off 'hlsearch' with
4541 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004542 augroup vimrc-incsearch-highlight
4543 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004544 autocmd CmdlineEnter /,\? :set hlsearch
4545 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004546 augroup END
4547<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004548 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004549 to the command line. If 'ignorecase' and 'smartcase' are set and the
4550 command line has no uppercase characters, the added character is
4551 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004552 CTRL-R CTRL-W can be used to add the word at the end of the current
4553 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 NOTE: This option is reset when 'compatible' is set.
4555
4556 *'indentexpr'* *'inde'*
4557'indentexpr' 'inde' string (default "")
4558 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 {not available when compiled without the |+cindent|
4560 or |+eval| features}
4561 Expression which is evaluated to obtain the proper indent for a line.
4562 It is used when a new line is created, for the |=| operator and
4563 in Insert mode as specified with the 'indentkeys' option.
4564 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004565 'smartindent' indenting. When 'lisp' is set, this option is
4566 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 When 'paste' is set this option is not used for indenting.
4568 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004569 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004571
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004572 If the expression starts with s: or |<SID>|, then it is replaced with
4573 the script ID (|local-function|). Example: >
4574 set indentexpr=s:MyIndentExpr()
4575 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004576< Otherwise, the expression is evaluated in the context of the script
4577 where the option was set, thus script-local items are available.
4578
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 The expression must return the number of spaces worth of indent. It
4580 can return "-1" to keep the current indent (this means 'autoindent' is
4581 used for the indent).
4582 Functions useful for computing the indent are |indent()|, |cindent()|
4583 and |lispindent()|.
4584 The evaluation of the expression must not have side effects! It must
4585 not change the text, jump to another window, etc. Afterwards the
4586 cursor position is always restored, thus the cursor may be moved.
4587 Normally this option would be set to call a function: >
4588 :set indentexpr=GetMyIndent()
4589< Error messages will be suppressed, unless the 'debug' option contains
4590 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004591 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004592 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593
Bram Moolenaar30b65812012-07-12 22:01:11 +02004594 The expression will be evaluated in the |sandbox| when set from a
4595 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004596 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004597
4598 It is not allowed to change text or jump to another window while
4599 evaluating 'indentexpr' |textlock|.
4600
4601
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004603'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 {not available when compiled without the |+cindent|
4606 feature}
4607 A list of keys that, when typed in Insert mode, cause reindenting of
4608 the current line. Only happens if 'indentexpr' isn't empty.
4609 The format is identical to 'cinkeys', see |indentkeys-format|.
4610 See |C-indenting| and |indent-expression|.
4611
4612 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4613'infercase' 'inf' boolean (default off)
4614 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004616 'ignorecase' is also on, the case of the match is adjusted depending
4617 on the typed text. If the typed text contains a lowercase letter
4618 where the match has an upper case letter, the completed part is made
4619 lowercase. If the typed text has no lowercase letters and the match
4620 has a lowercase letter where the typed text has an uppercase letter,
4621 and there is a letter before it, the completed part is made uppercase.
4622 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623
4624 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4625'insertmode' 'im' boolean (default off)
4626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 Makes Vim work in a way that Insert mode is the default mode. Useful
4628 if you want to use Vim as a modeless editor. Used for |evim|.
4629 These Insert mode commands will be useful:
4630 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004631 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 this is a mapping, it is executed as if 'insertmode' was off.
4633 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004635 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4636 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637
4638 These items change when 'insertmode' is set:
4639 - when starting to edit of a file, Vim goes to Insert mode.
4640 - <Esc> in Insert mode is a no-op and beeps.
4641 - <Esc> in Normal mode makes Vim go to Insert mode.
4642 - CTRL-L in Insert mode is a command, it is not inserted.
4643 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4644 However, when <Esc> is used inside a mapping, it behaves like
4645 'insertmode' was not set. This was done to be able to use the same
4646 mappings with 'insertmode' set or not set.
4647 When executing commands with |:normal| 'insertmode' is not used.
4648
4649 NOTE: This option is reset when 'compatible' is set.
4650
4651 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004652'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4654 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4655 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4656 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4657 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 The characters specified by this option are included in file names and
4660 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004661 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 Multi-byte characters 256 and above are always included, only the
4663 characters up to 255 are specified with this option.
4664 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004665 Think twice before adding white space to this option. Although a
4666 space may appear inside a file name, the effect will be that Vim
4667 doesn't know where a file name starts or ends when doing completion.
4668 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669
4670 Note that on systems using a backslash as path separator, Vim tries to
4671 do its best to make it work as you would expect. That is a bit
4672 tricky, since Vi originally used the backslash to escape special
4673 characters. Vim will not remove a backslash in front of a normal file
4674 name character on these systems, but it will on Unix and alikes. The
4675 '&' and '^' are not included by default, because these are special for
4676 cmd.exe.
4677
4678 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004679 Each part can be a single character number or a range. A range is two
4680 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 decimal number between 0 and 255 or the ASCII character itself (does
4682 not work for digits). Example:
4683 "_,-,128-140,#-43" (include '_' and '-' and the range
4684 128 to 140 and '#' to 43)
4685 If a part starts with '^', the following character number or range
4686 will be excluded from the option. The option is interpreted from left
4687 to right. Put the excluded character after the range where it is
4688 included. To include '^' itself use it as the last character of the
4689 option or the end of a range. Example:
4690 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4691 If the character is '@', all characters where isalpha() returns TRUE
4692 are included. Normally these are the characters a to z and A to Z,
4693 plus accented characters. To include '@' itself use "@-@". Examples:
4694 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004695 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 "a-z,A-Z,@-@" All letters plus the '@' character.
4697 A comma can be included by using it where a character number is
4698 expected. Example:
4699 "48-57,,,_" Digits, comma and underscore.
4700 A comma can be excluded by prepending a '^'. Example:
4701 " -~,^,,9" All characters from space to '~', excluding
4702 comma, plus <Tab>.
4703 See |option-backslash| about including spaces and backslashes.
4704
4705 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004706'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 "@,48-57,_,128-167,224-235"
4708 otherwise: "@,48-57,_,192-255")
4709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 The characters given by this option are included in identifiers.
4711 Identifiers are used in recognizing environment variables and after a
4712 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004713 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004714 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004716 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4718
4719 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004720'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 "@,48-57,_,128-167,224-235"
4722 otherwise: "@,48-57,_,192-255"
4723 Vi default: "@,48-57,_")
4724 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004726 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004727 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004728 characters above 255 check the "word" character class (any character
4729 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004730 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 For a help file it is set to all non-blank printable characters except
4732 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4733 command).
4734 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004735 This option also influences syntax highlighting, unless the syntax
4736 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 NOTE: This option is set to the Vi default value when 'compatible' is
4738 set and to the Vim default value when 'compatible' is reset.
4739
4740 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004741'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 "@,~-255"; otherwise: "@,161-255")
4743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 The characters given by this option are displayed directly on the
4745 screen. It is also used for "\p" in a |pattern|. The characters from
4746 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4747 even when they are not included in 'isprint' or excluded. See
4748 'isfname' for a description of the format of this option.
4749
4750 Non-printable characters are displayed with two characters:
4751 0 - 31 "^@" - "^_"
4752 32 - 126 always single characters
4753 127 "^?"
4754 128 - 159 "~@" - "~_"
4755 160 - 254 "| " - "|~"
4756 255 "~?"
4757 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4758 displayed as <xx>, with the hexadecimal value of the byte.
4759 When 'display' contains "uhex" all unprintable characters are
4760 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004761 The SpecialKey highlighting will be used for unprintable characters.
4762 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763
4764 Multi-byte characters 256 and above are always included, only the
4765 characters up to 255 are specified with this option. When a character
4766 is printable but it is not available in the current font, a
4767 replacement character will be shown.
4768 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4769 There is no option to specify these characters.
4770
4771 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4772'joinspaces' 'js' boolean (default on)
4773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 Insert two spaces after a '.', '?' and '!' with a join command.
4775 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4776 Otherwise only one space is inserted.
4777 NOTE: This option is set when 'compatible' is set.
4778
4779 *'key'*
4780'key' string (default "")
4781 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004782 {only available when compiled with the |+cryptv|
4783 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004785 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 Careful: Do not set the key value by hand, someone might see the typed
4787 key. Use the |:X| command. But you can make 'key' empty: >
4788 :set key=
4789< It is not possible to get the value of this option with ":set key" or
4790 "echo &key". This is to avoid showing it to someone who shouldn't
4791 know. It also means you cannot see it yourself once you have set it,
4792 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004793 You can use "&key" in an expression to detect whether encryption is
4794 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795
4796 *'keymap'* *'kmp'* *E544*
4797'keymap' 'kmp' string (default "")
4798 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 {only available when compiled with the |+keymap|
4800 feature}
4801 Name of a keyboard mapping. See |mbyte-keymap|.
4802 Setting this option to a valid keymap name has the side effect of
4803 setting 'iminsert' to one, so that the keymap becomes effective.
4804 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004805 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806
4807 *'keymodel'* *'km'*
4808'keymodel' 'km' string (default "")
4809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 List of comma separated words, which enable special things that keys
4811 can do. These values can be used:
4812 startsel Using a shifted special key starts selection (either
4813 Select mode or Visual mode, depending on "key" being
4814 present in 'selectmode').
4815 stopsel Using a not-shifted special key stops selection.
4816 Special keys in this context are the cursor keys, <End>, <Home>,
4817 <PageUp> and <PageDown>.
4818 The 'keymodel' option is set by the |:behave| command.
4819
4820 *'keywordprg'* *'kp'*
4821'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004822 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 Program to use for the |K| command. Environment variables are
4825 expanded |:set_env|. ":help" may be used to access the Vim internal
4826 help. (Note that previously setting the global option to the empty
4827 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004828 When the first character is ":", the command is invoked as a Vim
4829 Ex command prefixed with [count].
4830 When "man", "man -s" or an Ex command is used, Vim will automatically
4831 translate a count for the "K" command and pass it as the first
4832 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 See |option-backslash| about including spaces and backslashes.
4834 Example: >
4835 :set keywordprg=man\ -s
4836< This option cannot be set from a |modeline| or in the |sandbox|, for
4837 security reasons.
4838
4839 *'langmap'* *'lmap'* *E357* *E358*
4840'langmap' 'lmap' string (default "")
4841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 {only available when compiled with the |+langmap|
4843 feature}
4844 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004845 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004846 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 care of translating these special characters to the original meaning
4848 of the key. This means you don't have to change the keyboard mode to
4849 be able to execute Normal mode commands.
4850 This is the opposite of the 'keymap' option, where characters are
4851 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004852 Also consider setting 'langremap' to off, to prevent 'langmap' from
4853 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004854 This option cannot be set from a |modeline| or in the |sandbox|, for
4855 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004857 Example (for Greek, in UTF-8): *greek* >
4858 :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 +00004859< Example (exchanges meaning of z and y for commands): >
4860 :set langmap=zy,yz,ZY,YZ
4861<
4862 The 'langmap' option is a list of parts, separated with commas. Each
4863 part can be in one of two forms:
4864 1. A list of pairs. Each pair is a "from" character immediately
4865 followed by the "to" character. Examples: "aA", "aAbBcC".
4866 2. A list of "from" characters, a semi-colon and a list of "to"
4867 characters. Example: "abc;ABC"
4868 Example: "aA,fgh;FGH,cCdDeE"
4869 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004870 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871
4872 This will allow you to activate vim actions without having to switch
4873 back and forth between the languages. Your language characters will
4874 be understood as normal vim English characters (according to the
4875 langmap mappings) in the following cases:
4876 o Normal/Visual mode (commands, buffer/register names, user mappings)
4877 o Insert/Replace Mode: Register names after CTRL-R
4878 o Insert/Replace Mode: Mappings
4879 Characters entered in Command-line mode will NOT be affected by
4880 this option. Note that this option can be changed at any time
4881 allowing to switch between mappings for different languages/encodings.
4882 Use a mapping to avoid having to type it each time!
4883
4884 *'langmenu'* *'lm'*
4885'langmenu' 'lm' string (default "")
4886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 {only available when compiled with the |+menu| and
4888 |+multi_lang| features}
4889 Language to use for menu translation. Tells which file is loaded
4890 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004891 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892< (without the spaces). For example, to always use the Dutch menus, no
4893 matter what $LANG is set to: >
4894 :set langmenu=nl_NL.ISO_8859-1
4895< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004896 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 If your $LANG is set to a non-English language but you do want to use
4898 the English menus: >
4899 :set langmenu=none
4900< This option must be set before loading menus, switching on filetype
4901 detection or syntax highlighting. Once the menus are defined setting
4902 this option has no effect. But you could do this: >
4903 :source $VIMRUNTIME/delmenu.vim
4904 :set langmenu=de_DE.ISO_8859-1
4905 :source $VIMRUNTIME/menu.vim
4906< Warning: This deletes all menus that you defined yourself!
4907
Bram Moolenaard94464e2015-11-02 15:28:18 +01004908 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004909'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004910 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004911 {only available when compiled with the |+langmap|
4912 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004913 This is just like 'langremap' but with the value inverted. It only
4914 exists for backwards compatibility. When setting 'langremap' then
4915 'langnoremap' is set to the inverted value, and the other way around.
4916
4917 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004918'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004919 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004920 {only available when compiled with the |+langmap|
4921 feature}
4922 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004923 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004924 'langmap' disables some of your mappings, try resetting this option.
4925 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004926 that works for you to avoid mappings to break.
4927
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 *'laststatus'* *'ls'*
4929'laststatus' 'ls' number (default 1)
4930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 The value of this option influences when the last window will have a
4932 status line:
4933 0: never
4934 1: only if there are at least two windows
4935 2: always
4936 The screen looks nicer with a status line if you have several
4937 windows, but it takes another screen line. |status-line|
4938
4939 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4940'lazyredraw' 'lz' boolean (default off)
4941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 When this option is set, the screen will not be redrawn while
4943 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004944 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 update use |:redraw|.
4946
4947 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4948'linebreak' 'lbr' boolean (default off)
4949 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004950 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004952 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 than at the last character that fits on the screen. Unlike
4954 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004955 it only affects the way the file is displayed, not its contents.
4956 If 'breakindent' is set, line is visually indented. Then, the value
4957 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004958 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 Note that <Tab> characters after an <EOL> are mostly not displayed
4960 with the right amount of white space.
4961
4962 *'lines'* *E593*
4963'lines' number (default 24 or terminal height)
4964 global
4965 Number of lines of the Vim window.
4966 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004967 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 When Vim is running in the GUI or in a resizable window, setting this
4969 option will cause the window size to be changed. When you only want
4970 to use the size for the GUI, put the command in your |gvimrc| file.
4971 Vim limits the number of lines to what fits on the screen. You can
4972 use this command to get the tallest window possible: >
4973 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004974< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004975 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 When you set this option and Vim is unable to change the physical
4977 number of lines of the display, the display may be messed up.
4978
4979 *'linespace'* *'lsp'*
4980'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 {only in the GUI}
4983 Number of pixel lines inserted between characters. Useful if the font
4984 uses the full character cell height, making lines touch each other.
4985 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004986 With some fonts there can be too much room between lines (to have
4987 space for ascents and descents). Then it makes sense to set
4988 'linespace' to a negative value. This may cause display problems
4989 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990
4991 *'lisp'* *'nolisp'*
4992'lisp' boolean (default off)
4993 local to buffer
4994 {not available when compiled without the |+lispindent|
4995 feature}
4996 Lisp mode: When <Enter> is typed in insert mode set the indent for
4997 the next line to Lisp standards (well, sort of). Also happens with
4998 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4999 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5000 better. Also see 'lispwords'.
5001 The '-' character is included in keyword characters. Redefines the
5002 "=" operator to use this same indentation algorithm rather than
5003 calling an external program if 'equalprg' is empty.
5004 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005
5006 *'lispwords'* *'lw'*
5007'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005008 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 {not available when compiled without the |+lispindent|
5010 feature}
5011 Comma separated list of words that influence the Lisp indenting.
5012 |'lisp'|
5013
5014 *'list'* *'nolist'*
5015'list' boolean (default off)
5016 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005017 List mode: By default show tabs as CTRL-I is displayed, display $
5018 after end of line. Useful to see the difference between tabs and
5019 spaces and for trailing blanks. Further changed by the 'listchars'
5020 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005021
5022 The cursor is displayed at the start of the space a Tab character
5023 occupies, not at the end as usual in Normal mode. To get this cursor
5024 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005025 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005026<
5027 Note that list mode will also affect formatting (set with 'textwidth'
5028 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029 changing the way tabs are displayed.
5030
5031 *'listchars'* *'lcs'*
5032'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005033 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005034 Strings to use in 'list' mode and for the |:list| command. It is a
5035 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005036 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 eol:c Character to show at the end of each line. When
5038 omitted, there is no extra character at the end of the
5039 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005040 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005041 tab:xy[z] Two or three characters to be used to show a tab.
5042 The third character is optional.
5043
5044 tab:xy The 'x' is always used, then 'y' as many times as will
5045 fit. Thus "tab:>-" displays:
5046 >
5047 >-
5048 >--
5049 etc.
5050
5051 tab:xyz The 'z' is always used, then 'x' is prepended, and
5052 then 'y' is used as many times as will fit. Thus
5053 "tab:<->" displays:
5054 >
5055 <>
5056 <->
5057 <-->
5058 etc.
5059
5060 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005061 *lcs-space*
5062 space:c Character to show for a space. When omitted, spaces
5063 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005064 *lcs-multispace*
5065 multispace:c...
5066 One or more characters to use cyclically to show for
5067 multiple consecutive spaces. Overrides the "space"
5068 setting, except for single spaces. When omitted, the
5069 "space" setting is used. For example,
5070 `:set listchars=multispace:---+` shows ten consecutive
5071 spaces as:
5072 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005073 *lcs-lead*
5074 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005075 leading spaces are blank. Overrides the "space" and
5076 "multispace" settings for leading spaces. You can
5077 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005078 :set listchars+=tab:>-,lead:.
5079< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005080 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005081 trailing spaces are blank. Overrides the "space" and
5082 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005083 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 extends:c Character to show in the last column, when 'wrap' is
5085 off and the line continues beyond the right of the
5086 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005087 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005088 precedes:c Character to show in the first visible column of the
5089 physical line, when there is text preceding the
5090 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005091 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005092 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005093 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005094 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005095 nbsp:c Character to show for a non-breakable space character
5096 (0xA0 (160 decimal) and U+202F). Left blank when
5097 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005099 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005101 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005103 Each character can be specified as hex: >
5104 set listchars=eol:\\x24
5105 set listchars=eol:\\u21b5
5106 set listchars=eol:\\U000021b5
5107< Note that a double backslash is used. The number of hex characters
5108 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5109
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 Examples: >
5111 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005112 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 :set lcs=extends:>,precedes:<
5114< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005115 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5116 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005117 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118
5119 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5120'loadplugins' 'lpl' boolean (default on)
5121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 When on the plugin scripts are loaded when starting up |load-plugins|.
5123 This option can be reset in your |vimrc| file to disable the loading
5124 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005125 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5126 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127
Bram Moolenaard94464e2015-11-02 15:28:18 +01005128 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005129'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005130 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005131 {only available when compiled with the |+lua/dyn|
5132 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005133 Specifies the name of the Lua shared library. The default is
5134 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005135 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005136 This option cannot be set from a |modeline| or in the |sandbox|, for
5137 security reasons.
5138
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005139 *'macatsui'* *'nomacatsui'*
5140'macatsui' boolean (default on)
5141 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005142 {not supported}
5143 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005144
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 *'magic'* *'nomagic'*
5146'magic' boolean (default on)
5147 global
5148 Changes the special characters that can be used in search patterns.
5149 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005150 WARNING: Switching this option off most likely breaks plugins! That
5151 is because many patterns assume it's on and will fail when it's off.
5152 Only switch it off when working with old Vi scripts. In any other
5153 situation write patterns that work when 'magic' is on. Include "\M"
5154 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005155 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5156 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157
5158 *'makeef'* *'mef'*
5159'makeef' 'mef' string (default: "")
5160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 {not available when compiled without the |+quickfix|
5162 feature}
5163 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5164 and the |:grep| command.
5165 When it is empty, an internally generated temp file will be used.
5166 When "##" is included, it is replaced by a number to make the name
5167 unique. This makes sure that the ":make" command doesn't overwrite an
5168 existing file.
5169 NOT used for the ":cf" command. See 'errorfile' for that.
5170 Environment variables are expanded |:set_env|.
5171 See |option-backslash| about including spaces and backslashes.
5172 This option cannot be set from a |modeline| or in the |sandbox|, for
5173 security reasons.
5174
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005175 *'makeencoding'* *'menc'*
5176'makeencoding' 'menc' string (default "")
5177 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005178 Encoding used for reading the output of external commands. When empty,
5179 encoding is not converted.
5180 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5181 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5182 and `:laddfile`.
5183
5184 This would be mostly useful when you use MS-Windows and set 'encoding'
5185 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5186 'makeencoding' to "char" has the same effect as setting to the system
5187 locale encoding. Example: >
5188 :set encoding=utf-8
5189 :set makeencoding=char " system locale is used
5190<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 *'makeprg'* *'mp'*
5192'makeprg' 'mp' string (default "make", VMS: "MMS")
5193 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005194 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005195 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5196 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005197 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005198 Environment variables are expanded |:set_env|. See |option-backslash|
5199 about including spaces and backslashes.
5200 Note that a '|' must be escaped twice: once for ":set" and once for
5201 the interpretation of a command. When you use a filter called
5202 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 :set makeprg=gmake\ \\\|\ myfilter
5204< The placeholder "$*" can be given (even multiple times) to specify
5205 where the arguments will be included, for example: >
5206 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5207< This option cannot be set from a |modeline| or in the |sandbox|, for
5208 security reasons.
5209
5210 *'matchpairs'* *'mps'*
5211'matchpairs' 'mps' string (default "(:),{:},[:]")
5212 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005214 other.
5215 Only character pairs are allowed that are different, thus you cannot
5216 jump between two double quotes.
5217 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005218 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005219 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 :set mps+=<:>
5221
5222< A more exotic example, to jump between the '=' and ';' in an
5223 assignment, useful for languages like C and Java: >
5224 :au FileType c,cpp,java set mps+==:;
5225
5226< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005227 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228
5229 *'matchtime'* *'mat'*
5230'matchtime' 'mat' number (default 5)
5231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 Tenths of a second to show the matching paren, when 'showmatch' is
5233 set. Note that this is not in milliseconds, like other options that
5234 set a time. This is to be compatible with Nvi.
5235
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005236 *'maxcombine'* *'mco'*
5237'maxcombine' 'mco' number (default 2)
5238 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005239 The maximum number of combining characters supported for displaying.
5240 Only used when 'encoding' is "utf-8".
5241 The default is OK for most languages. Hebrew may require 4.
5242 Maximum value is 6.
5243 Even when this option is set to 2 you can still edit text with more
5244 combining characters, you just can't see them. Use |g8| or |ga|.
5245 See |mbyte-combining|.
5246
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 *'maxfuncdepth'* *'mfd'*
5248'maxfuncdepth' 'mfd' number (default 100)
5249 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005250 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005251 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 Maximum depth of function calls for user functions. This normally
5253 catches endless recursion. When using a recursive function with
5254 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5255 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005256 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005257 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258 See also |:function|.
5259
5260 *'maxmapdepth'* *'mmd'* *E223*
5261'maxmapdepth' 'mmd' number (default 1000)
5262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 Maximum number of times a mapping is done without resulting in a
5264 character to be used. This normally catches endless mappings, like
5265 ":map x y" with ":map y x". It still does not catch ":map g wg",
5266 because the 'w' is used before the next mapping is done. See also
5267 |key-mapping|.
5268
5269 *'maxmem'* *'mm'*
5270'maxmem' 'mm' number (default between 256 to 5120 (system
5271 dependent) or half the amount of memory
5272 available)
5273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5275 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005276 other memory to be freed.
5277 The maximum usable value is about 2000000. Use this to work without a
5278 limit.
5279 The value is ignored when 'swapfile' is off.
5280 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005282 *'maxmempattern'* *'mmp'*
5283'maxmempattern' 'mmp' number (default 1000)
5284 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005285 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005286 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005287 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005288 When Vim runs into the limit it gives an error message and mostly
5289 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005290 Running into the limit often means that the pattern is very
5291 inefficient or too complex. This may already happen with the pattern
5292 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005293 Might also happen on redraw, when syntax rules try to match a complex
5294 text structure.
5295 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5296 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005297
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 *'maxmemtot'* *'mmt'*
5299'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5300 dependent) or half the amount of memory
5301 available)
5302 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005303 Maximum amount of memory in Kbyte to use for all buffers together.
5304 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005305 without a limit.
5306 On 64 bit machines higher values might work. But hey, do you really
5307 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005308 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005309 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005310 Buffers with 'swapfile' off still count to the total amount of memory
5311 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005312 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313
5314 *'menuitems'* *'mis'*
5315'menuitems' 'mis' number (default 25)
5316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317 {not available when compiled without the |+menu|
5318 feature}
5319 Maximum number of items to use in a menu. Used for menus that are
5320 generated from a list of items, e.g., the Buffers menu. Changing this
5321 option has no direct effect, the menu must be refreshed first.
5322
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005323 *'mkspellmem'* *'msm'*
5324'mkspellmem' 'msm' string (default "460000,2000,500")
5325 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005326 {not available when compiled without the |+syntax|
5327 feature}
5328 Parameters for |:mkspell|. This tunes when to start compressing the
5329 word tree. Compression can be slow when there are many words, but
5330 it's needed to avoid running out of memory. The amount of memory used
5331 per word depends very much on how similar the words are, that's why
5332 this tuning is complicated.
5333
5334 There are three numbers, separated by commas:
5335 {start},{inc},{added}
5336
5337 For most languages the uncompressed word tree fits in memory. {start}
5338 gives the amount of memory in Kbyte that can be used before any
5339 compression is done. It should be a bit smaller than the amount of
5340 memory that is available to Vim.
5341
5342 When going over the {start} limit the {inc} number specifies the
5343 amount of memory in Kbyte that can be allocated before another
5344 compression is done. A low number means compression is done after
5345 less words are added, which is slow. A high number means more memory
5346 will be allocated.
5347
5348 After doing compression, {added} times 1024 words can be added before
5349 the {inc} limit is ignored and compression is done when any extra
5350 amount of memory is needed. A low number means there is a smaller
5351 chance of hitting the {inc} limit, less memory is used but it's
5352 slower.
5353
5354 The languages for which these numbers are important are Italian and
5355 Hungarian. The default works for when you have about 512 Mbyte. If
5356 you have 1 Gbyte you could use: >
5357 :set mkspellmem=900000,3000,800
5358< If you have less than 512 Mbyte |:mkspell| may fail for some
5359 languages, no matter what you set 'mkspellmem' to.
5360
Bram Moolenaar07607392019-05-26 19:20:43 +02005361 This option cannot be set from a |modeline| or in the |sandbox|.
5362
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005364'modeline' 'ml' boolean (Vim default: on (off for root),
5365 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005367 If 'modeline' is on 'modelines' gives the number of lines that is
5368 checked for set commands. If 'modeline' is off or 'modelines' is zero
5369 no lines are checked. See |modeline|.
5370
5371 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5372'modelineexpr' 'mle' boolean (default: off)
5373 global
5374 When on allow some options that are an expression to be set in the
5375 modeline. Check the option for whether it is affected by
5376 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005377 This option cannot be set from a |modeline| or in the |sandbox|, for
5378 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005379
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 *'modelines'* *'mls'*
5381'modelines' 'mls' number (default 5)
5382 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 If 'modeline' is on 'modelines' gives the number of lines that is
5384 checked for set commands. If 'modeline' is off or 'modelines' is zero
5385 no lines are checked. See |modeline|.
5386 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5387 set and to the Vim default value when 'compatible' is reset.
5388
5389 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005390 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391'modifiable' 'ma' boolean (default on)
5392 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393 When off the buffer contents cannot be changed. The 'fileformat' and
5394 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005395 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396
5397 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5398'modified' 'mod' boolean (default off)
5399 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400 When on, the buffer is considered to be modified. This option is set
5401 when:
5402 1. A change was made to the text since it was last written. Using the
5403 |undo| command to go back to the original text will reset the
5404 option. But undoing changes that were made before writing the
5405 buffer will set the option again, since the text is different from
5406 when it was written.
5407 2. 'fileformat' or 'fileencoding' is different from its original
5408 value. The original value is set when the buffer is read or
5409 written. A ":set nomodified" command also resets the original
5410 values to the current values and the 'modified' option will be
5411 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005412 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005413 This option is not set when a change is made to the buffer as the
5414 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5415 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5416 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5418 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005419 Note that the text may actually be the same, e.g. 'modified' is set
5420 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421
5422 *'more'* *'nomore'*
5423'more' boolean (Vim default: on, Vi default: off)
5424 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 When on, listings pause when the whole screen is filled. You will get
5426 the |more-prompt|. When this option is off there are no pauses, the
5427 listing continues until finished.
5428 NOTE: This option is set to the Vi default value when 'compatible' is
5429 set and to the Vim default value when 'compatible' is reset.
5430
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005431 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005432'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005433 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005435 Enable the use of the mouse. Works for most terminals (xterm, Win32
5436 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5437 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5438 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005439 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 v Visual mode
5441 i Insert mode
5442 c Command-line mode
5443 h all previous modes when editing a help file
5444 a all previous modes
5445 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005446 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005448< If your terminal can't overrule the mouse events going to the
5449 application, use: >
5450 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005451< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005452 back to Vim using the mouse events.
5453 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5454 "xterm".
5455
5456 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 modeless selection. This doesn't move the text cursor.
5458
5459 See |mouse-using|. Also see |'clipboard'|.
5460
5461 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005462 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005463 the mouse buttons can still be used by keeping the shift key pressed.
5464 Also see the 'clipboard' option.
5465
5466 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5467'mousefocus' 'mousef' boolean (default off)
5468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 {only works in the GUI}
5470 The window that the mouse pointer is on is automatically activated.
5471 When changing the window layout or window focus in another way, the
5472 mouse pointer is moved to the window with keyboard focus. Off is the
5473 default because it makes using the pull down menus a little goofy, as
5474 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005475 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005476 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477
5478 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5479'mousehide' 'mh' boolean (default on)
5480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 {only works in the GUI}
5482 When on, the mouse pointer is hidden when characters are typed.
5483 The mouse pointer is restored when the mouse is moved.
5484
5485 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005486'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 Sets the model to use for the mouse. The name mostly specifies what
5489 the right mouse button is used for:
5490 extend Right mouse button extends a selection. This works
5491 like in an xterm.
5492 popup Right mouse button pops up a menu. The shifted left
5493 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005494 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 popup_setpos Like "popup", but the cursor will be moved to the
5496 position where the mouse was clicked, and thus the
5497 selected operation will act upon the clicked object.
5498 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005499 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 course, that right clicking outside a selection will
5501 end Visual mode.
5502 Overview of what button does what for each model:
5503 mouse extend popup(_setpos) ~
5504 left click place cursor place cursor
5505 left drag start selection start selection
5506 shift-left search word extend selection
5507 right click extend selection popup menu (place cursor)
5508 right drag extend selection -
5509 middle click paste paste
5510
5511 In the "popup" model the right mouse button produces a pop-up menu.
5512 You need to define this first, see |popup-menu|.
5513
5514 Note that you can further refine the meaning of buttons with mappings.
5515 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5516 selection (because that's handled in the GUI code directly).
5517
5518 The 'mousemodel' option is set by the |:behave| command.
5519
5520 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005521'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5522 vs:leftright,vd:lrsizing,m:no,
5523 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 {only available when compiled with the |+mouseshape|
5526 feature}
5527 This option tells Vim what the mouse pointer should look like in
5528 different modes. The option is a comma separated list of parts, much
5529 like used for 'guicursor'. Each part consist of a mode/location-list
5530 and an argument-list:
5531 mode-list:shape,mode-list:shape,..
5532 The mode-list is a dash separated list of these modes/locations:
5533 In a normal window: ~
5534 n Normal mode
5535 v Visual mode
5536 ve Visual mode with 'selection' "exclusive" (same as 'v',
5537 if not specified)
5538 o Operator-pending mode
5539 i Insert mode
5540 r Replace mode
5541
5542 Others: ~
5543 c appending to the command-line
5544 ci inserting in the command-line
5545 cr replacing in the command-line
5546 m at the 'Hit ENTER' or 'More' prompts
5547 ml idem, but cursor in the last line
5548 e any mode, pointer below last window
5549 s any mode, pointer on a status line
5550 sd any mode, while dragging a status line
5551 vs any mode, pointer on a vertical separator line
5552 vd any mode, while dragging a vertical separator line
5553 a everywhere
5554
5555 The shape is one of the following:
5556 avail name looks like ~
5557 w x arrow Normal mouse pointer
5558 w x blank no pointer at all (use with care!)
5559 w x beam I-beam
5560 w x updown up-down sizing arrows
5561 w x leftright left-right sizing arrows
5562 w x busy The system's usual busy pointer
5563 w x no The system's usual 'no input' pointer
5564 x udsizing indicates up-down resizing
5565 x lrsizing indicates left-right resizing
5566 x crosshair like a big thin +
5567 x hand1 black hand
5568 x hand2 white hand
5569 x pencil what you write with
5570 x question big ?
5571 x rightup-arrow arrow pointing right-up
5572 w x up-arrow arrow pointing up
5573 x <number> any X11 pointer number (see X11/cursorfont.h)
5574
5575 The "avail" column contains a 'w' if the shape is available for Win32,
5576 x for X11.
5577 Any modes not specified or shapes not available use the normal mouse
5578 pointer.
5579
5580 Example: >
5581 :set mouseshape=s:udsizing,m:no
5582< will make the mouse turn to a sizing arrow over the status lines and
5583 indicate no input when the hit-enter prompt is displayed (since
5584 clicking the mouse has no effect in this state.)
5585
5586 *'mousetime'* *'mouset'*
5587'mousetime' 'mouset' number (default 500)
5588 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005589 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 time in msec between two mouse clicks for the second click to be
5591 recognized as a multi click.
5592
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005593 *'mzschemedll'*
5594'mzschemedll' string (default depends on the build)
5595 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005596 {only available when compiled with the |+mzscheme/dyn|
5597 feature}
5598 Specifies the name of the MzScheme shared library. The default is
5599 DYNAMIC_MZSCH_DLL which was specified at compile time.
5600 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005601 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005602 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005603 This option cannot be set from a |modeline| or in the |sandbox|, for
5604 security reasons.
5605
5606 *'mzschemegcdll'*
5607'mzschemegcdll' string (default depends on the build)
5608 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005609 {only available when compiled with the |+mzscheme/dyn|
5610 feature}
5611 Specifies the name of the MzScheme GC shared library. The default is
5612 DYNAMIC_MZGC_DLL which was specified at compile time.
5613 The value can be equal to 'mzschemedll' if it includes the GC code.
5614 Environment variables are expanded |:set_env|.
5615 This option cannot be set from a |modeline| or in the |sandbox|, for
5616 security reasons.
5617
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005618 *'mzquantum'* *'mzq'*
5619'mzquantum' 'mzq' number (default 100)
5620 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005621 {not available when compiled without the |+mzscheme|
5622 feature}
5623 The number of milliseconds between polls for MzScheme threads.
5624 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005625 NOTE: This option is set to the Vim default value when 'compatible'
5626 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005627
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005629'nrformats' 'nf' string (default "bin,octal,hex",
5630 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005632 This defines what bases Vim will consider for numbers when using the
5633 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5634 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005635 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005637 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005638 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005640 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 considered to be hexadecimal. Example: Using CTRL-X on
5642 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005643 bin If included, numbers starting with "0b" or "0B" will be
5644 considered to be binary. Example: Using CTRL-X on
5645 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005646 unsigned If included, numbers are recognized as unsigned. Thus a
5647 leading dash or negative sign won't be considered as part of
5648 the number. Examples:
5649 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5650 (without "unsigned" it would become "9-2021").
5651 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5652 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005653 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5654 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 Numbers which simply begin with a digit in the range 1-9 are always
5656 considered decimal. This also happens for numbers that are not
5657 recognized as octal or hex.
5658
5659 *'number'* *'nu'* *'nonumber'* *'nonu'*
5660'number' 'nu' boolean (default off)
5661 local to window
5662 Print the line number in front of each line. When the 'n' option is
5663 excluded from 'cpoptions' a wrapped line will not use the column of
5664 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005665 The 'numberwidth' option can be used to set the room used for the line
5666 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 When a long, wrapped line doesn't start with the first character, '-'
5668 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005669 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5670 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005671 *number_relativenumber*
5672 The 'relativenumber' option changes the displayed number to be
5673 relative to the cursor. Together with 'number' there are these
5674 four combinations (cursor in line 3):
5675
Bram Moolenaar3848e002016-03-19 18:42:29 +01005676 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005677 'nornu' 'nornu' 'rnu' 'rnu'
5678
5679 |apple | 1 apple | 2 apple | 2 apple
5680 |pear | 2 pear | 1 pear | 1 pear
5681 |nobody | 3 nobody | 0 nobody |3 nobody
5682 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005684 *'numberwidth'* *'nuw'*
5685'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5686 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005687 {only available when compiled with the |+linebreak|
5688 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005689 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005690 when the 'number' or 'relativenumber' option is set or printing lines
5691 with a line number. Since one space is always between the number and
5692 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005693 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005694 fit the highest line number in the buffer respectively the number of
5695 rows in the window, depending on whether 'number' or 'relativenumber'
5696 is set. Thus with the Vim default of 4 there is room for a line number
5697 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005698 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005699 NOTE: This option is set to the Vi default value when 'compatible' is
5700 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005701
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005702 *'omnifunc'* *'ofu'*
5703'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005704 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005705 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005706 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005707 This option specifies a function to be used for Insert mode omni
5708 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005709 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005710 invoked and what it should return. The value can be the name of a
5711 function, a |lambda| or a |Funcref|. See |option-value-function| for
5712 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005713 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005714 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005715 This option cannot be set from a |modeline| or in the |sandbox|, for
5716 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005717
5718
Bram Moolenaar02467872007-05-06 13:22:01 +00005719 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005720'opendevice' 'odev' boolean (default off)
5721 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005722 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005723 Enable reading and writing from devices. This may get Vim stuck on a
5724 device that can be opened but doesn't actually do the I/O. Therefore
5725 it is off by default.
5726 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5727 result in editing a device.
5728
5729
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005730 *'operatorfunc'* *'opfunc'*
5731'operatorfunc' 'opfunc' string (default: empty)
5732 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005733 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005734 See |:map-operator| for more info and an example. The value can be
5735 the name of a function, a |lambda| or a |Funcref|. See
5736 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005737
5738 This option cannot be set from a |modeline| or in the |sandbox|, for
5739 security reasons.
5740
5741
Bram Moolenaar251e1912011-06-19 05:09:16 +02005742 *'osfiletype'* *'oft'*
5743'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005745 This option was supported on RISC OS, which has been removed.
5746
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005748 *'packpath'* *'pp'*
5749'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005750 Directories used to find packages. See |packages|.
5751
5752
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005754'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 global
5756 Specifies the nroff macros that separate paragraphs. These are pairs
5757 of two letters (see |object-motions|).
5758
5759 *'paste'* *'nopaste'*
5760'paste' boolean (default off)
5761 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005762 Put Vim in Paste mode. This is useful if you want to cut or copy
5763 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 unexpected effects.
5765 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005766 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 knows about pasting and will mostly do the right thing without 'paste'
5768 being set. The same is true for a terminal where Vim handles the
5769 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005770 This option is reset when starting the GUI. Thus if you set it in
5771 your .vimrc it will work in a terminal, but not in the GUI. Setting
5772 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5773 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 When the 'paste' option is switched on (also when it was already on):
5775 - mapping in Insert mode and Command-line mode is disabled
5776 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005778 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005779 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 - 'revins' is reset
5781 - 'ruler' is reset
5782 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005783 - 'smarttab' is reset
5784 - 'softtabstop' is set to 0
5785 - 'textwidth' is set to 0
5786 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005787 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005790 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005791 - 'indentexpr'
5792 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005793 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 NOTE: When you start editing another file while the 'paste' option is
5795 on, settings from the modelines or autocommands may change the
5796 settings again, causing trouble when pasting text. You might want to
5797 set the 'paste' option again.
5798 When the 'paste' option is reset the mentioned options are restored to
5799 the value before the moment 'paste' was switched from off to on.
5800 Resetting 'paste' before ever setting it does not have any effect.
5801 Since mapping doesn't work while 'paste' is active, you need to use
5802 the 'pastetoggle' option to toggle the 'paste' option with some key.
5803
5804 *'pastetoggle'* *'pt'*
5805'pastetoggle' 'pt' string (default "")
5806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 When non-empty, specifies the key sequence that toggles the 'paste'
5808 option. This is like specifying a mapping: >
5809 :map {keys} :set invpaste<CR>
5810< Where {keys} is the value of 'pastetoggle'.
5811 The difference is that it will work even when 'paste' is set.
5812 'pastetoggle' works in Insert mode and Normal mode, but not in
5813 Command-line mode.
5814 Mappings are checked first, thus overrule 'pastetoggle'. However,
5815 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5816 this: >
5817 :map <F10> :set paste<CR>
5818 :map <F11> :set nopaste<CR>
5819 :imap <F10> <C-O>:set paste<CR>
5820 :imap <F11> <nop>
5821 :set pastetoggle=<F11>
5822< This will make <F10> start paste mode and <F11> stop paste mode.
5823 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5824 mode everything is inserted literally, except the 'pastetoggle' key
5825 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005826 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827
5828 *'pex'* *'patchexpr'*
5829'patchexpr' 'pex' string (default "")
5830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 {not available when compiled without the |+diff|
5832 feature}
5833 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005834 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835
Bram Moolenaardbc28022014-07-26 13:40:44 +02005836 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837'patchmode' 'pm' string (default "")
5838 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 When non-empty the oldest version of a file is kept. This can be used
5840 to keep the original version of a file if you are changing files in a
5841 source distribution. Only the first time that a file is written a
5842 copy of the original file will be kept. The name of the copy is the
5843 name of the original file with the string in the 'patchmode' option
5844 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005845 ".orig" or ".org". 'backupdir' must not be empty for this to work
5846 (Detail: The backup file is renamed to the patchmode file after the
5847 new file has been successfully written, that's why it must be possible
5848 to write a backup file). If there was no file to be backed up, an
5849 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 When the 'backupskip' pattern matches, a patchmode file is not made.
5851 Using 'patchmode' for compressed files appends the extension at the
5852 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5853 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005854 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005856 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005858 other systems: ".,,")
5859 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005860 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005861 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5862 provided that the file being searched for has a relative path (not
5863 starting with "/", "./" or "../"). The directories in the 'path'
5864 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 - Use commas to separate directory names: >
5866 :set path=.,/usr/local/include,/usr/include
5867< - Spaces can also be used to separate directory names (for backwards
5868 compatibility with version 3.0). To have a space in a directory
5869 name, precede it with an extra backslash, and escape the space: >
5870 :set path=.,/dir/with\\\ space
5871< - To include a comma in a directory name precede it with an extra
5872 backslash: >
5873 :set path=.,/dir/with\\,comma
5874< - To search relative to the directory of the current file, use: >
5875 :set path=.
5876< - To search in the current directory use an empty string between two
5877 commas: >
5878 :set path=,,
5879< - A directory name may end in a ':' or '/'.
5880 - Environment variables are expanded |:set_env|.
5881 - When using |netrw.vim| URLs can be used. For example, adding
5882 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005883 - Search upwards and downwards in a directory tree using "*", "**" and
5884 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 {not available when compiled without the |+path_extra| feature}
5886 - Careful with '\' characters, type two to get one in the option: >
5887 :set path=.,c:\\include
5888< Or just use '/' instead: >
5889 :set path=.,c:/include
5890< Don't forget "." or files won't even be found in the same directory as
5891 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005892 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 it is something like 256 or 1024 characters.
5894 You can check if all the include files are found, using the value of
5895 'path', see |:checkpath|.
5896 The use of |:set+=| and |:set-=| is preferred when adding or removing
5897 directories from the list. This avoids problems when a future version
5898 uses another default. To remove the current directory use: >
5899 :set path-=
5900< To add the current directory use: >
5901 :set path+=
5902< To use an environment variable, you probably need to replace the
5903 separator. Here is an example to append $INCL, in which directory
5904 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005905 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906< Replace the ';' with a ':' or whatever separator is used. Note that
5907 this doesn't work when $INCL contains a comma or white space.
5908
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005909 *'perldll'*
5910'perldll' string (default depends on the build)
5911 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005912 {only available when compiled with the |+perl/dyn|
5913 feature}
5914 Specifies the name of the Perl shared library. The default is
5915 DYNAMIC_PERL_DLL, which was specified at compile time.
5916 Environment variables are expanded |:set_env|.
5917 This option cannot be set from a |modeline| or in the |sandbox|, for
5918 security reasons.
5919
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5921'preserveindent' 'pi' boolean (default off)
5922 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923 When changing the indent of the current line, preserve as much of the
5924 indent structure as possible. Normally the indent is replaced by a
5925 series of tabs followed by spaces as required (unless |'expandtab'| is
5926 enabled, in which case only spaces are used). Enabling this option
5927 means the indent will preserve as many existing characters as possible
5928 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005929 'expandtab' does not apply to the preserved white space, a Tab remains
5930 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 NOTE: When using ">>" multiple times the resulting indent is a mix of
5932 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005933 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 Also see 'copyindent'.
5935 Use |:retab| to clean up white space.
5936
5937 *'previewheight'* *'pvh'*
5938'previewheight' 'pvh' number (default 12)
5939 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005940 {not available when compiled without the |+quickfix|
5941 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005943 commands. Used for |CTRL-W_}| when no count is given. Not used when
5944 'previewpopup' is set.
5945
5946 *'previewpopup'* *'pvp'*
5947'previewpopup' 'pvp' string (default empty)
5948 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005949 {not available when compiled without the |+textprop|
5950 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005951 When not empty a popup window is used for commands that would open a
5952 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005953 Not used for the insert completion info, add "popup" to
5954 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955
5956 *'previewwindow'* *'nopreviewwindow'*
5957 *'pvw'* *'nopvw'* *E590*
5958'previewwindow' 'pvw' boolean (default off)
5959 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005960 {not available when compiled without the |+quickfix|
5961 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005962 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 set. It's normally not set directly, but by using one of the commands
5964 |:ptag|, |:pedit|, etc.
5965
5966 *'printdevice'* *'pdev'*
5967'printdevice' 'pdev' string (default empty)
5968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 {only available when compiled with the |+printer|
5970 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005971 The name of the printer to be used for |:hardcopy|.
5972 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005973 This option cannot be set from a |modeline| or in the |sandbox|, for
5974 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975
Bram Moolenaar8299df92004-07-10 09:47:34 +00005976 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005977'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979 {only available when compiled with the |+printer|
5980 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005981 Sets the character encoding used when printing.
5982 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983
5984 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005985'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 {only available when compiled with the |+printer|
5988 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005989 Expression used to print the PostScript produced with |:hardcopy|.
5990 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005991 This option cannot be set from a |modeline| or in the |sandbox|, for
5992 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993
Bram Moolenaar8299df92004-07-10 09:47:34 +00005994 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995'printfont' 'pfn' string (default "courier")
5996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 {only available when compiled with the |+printer|
5998 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005999 The name of the font that will be used for |:hardcopy|.
6000 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001
6002 *'printheader'* *'pheader'*
6003'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 {only available when compiled with the |+printer|
6006 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006007 The format of the header produced in |:hardcopy| output.
6008 See |pheader-option|.
6009
6010 *'printmbcharset'* *'pmbcs'*
6011'printmbcharset' 'pmbcs' string (default "")
6012 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006013 {only available when compiled with the |+printer|
6014 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006015 The CJK character set to be used for CJK output from |:hardcopy|.
6016 See |pmbcs-option|.
6017
6018 *'printmbfont'* *'pmbfn'*
6019'printmbfont' 'pmbfn' string (default "")
6020 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006021 {only available when compiled with the |+printer|
6022 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006023 List of font names to be used for CJK output from |:hardcopy|.
6024 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025
6026 *'printoptions'* *'popt'*
6027'printoptions' 'popt' string (default "")
6028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006030 List of items that control the format of the output of |:hardcopy|.
6031 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006033 *'prompt'* *'noprompt'*
6034'prompt' boolean (default on)
6035 global
6036 When on a ":" prompt is used in Ex mode.
6037
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006038 *'pumheight'* *'ph'*
6039'pumheight' 'ph' number (default 0)
6040 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006041 Determines the maximum number of items to show in the popup menu for
6042 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006043 |ins-completion-menu|.
6044
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006045 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006046'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006047 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006048 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006049 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006050
Bram Moolenaard94464e2015-11-02 15:28:18 +01006051 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006052'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006053 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006054 {only available when compiled with the |+python/dyn|
6055 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006056 Specifies the name of the Python 2.x shared library. The default is
6057 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006058 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006059 This option cannot be set from a |modeline| or in the |sandbox|, for
6060 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006061
Bram Moolenaar94073162018-01-31 21:49:05 +01006062 *'pythonhome'*
6063'pythonhome' string (default "")
6064 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006065 {only available when compiled with the |+python/dyn|
6066 feature}
6067 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6068 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6069 which was specified at compile time, will be used for the Python 2.x
6070 home directory.
6071 Environment variables are expanded |:set_env|.
6072 This option cannot be set from a |modeline| or in the |sandbox|, for
6073 security reasons.
6074
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006075 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006076'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006077 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006078 {only available when compiled with the |+python3/dyn|
6079 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006080 Specifies the name of the Python 3 shared library. The default is
6081 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006082 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006083 This option cannot be set from a |modeline| or in the |sandbox|, for
6084 security reasons.
6085
Bram Moolenaar94073162018-01-31 21:49:05 +01006086 *'pythonthreehome'*
6087'pythonthreehome' string (default "")
6088 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006089 {only available when compiled with the |+python3/dyn|
6090 feature}
6091 Specifies the name of the Python 3 home directory. When
6092 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6093 PYTHON3_HOME, which was specified at compile time, will be used for
6094 the Python 3 home directory.
6095 Environment variables are expanded |:set_env|.
6096 This option cannot be set from a |modeline| or in the |sandbox|, for
6097 security reasons.
6098
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006099 *'pyxversion'* *'pyx'*
6100'pyxversion' 'pyx' number (default depends on the build)
6101 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006102 {only available when compiled with the |+python| or
6103 the |+python3| feature}
6104 Specifies the python version used for pyx* functions and commands
6105 |python_x|. The default value is as follows:
6106
6107 Compiled with Default ~
6108 |+python| and |+python3| 0
6109 only |+python| 2
6110 only |+python3| 3
6111
6112 Available values are 0, 2 and 3.
6113 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6114 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6115 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6116 to 2 if Python 2 is available.
6117 See also: |has-pythonx|
6118
6119 If Vim is compiled with only |+python| or |+python3| setting
6120 'pyxversion' has no effect. The pyx* functions and commands are
6121 always the same as the compiled version.
6122
6123 This option cannot be set from a |modeline| or in the |sandbox|, for
6124 security reasons.
6125
Bram Moolenaar858ba062020-05-31 23:11:59 +02006126 *'quickfixtextfunc'* *'qftf'*
6127'quickfixtextfunc' 'qftf' string (default "")
6128 global
6129 {only available when compiled with the |+quickfix|
6130 feature}
6131 This option specifies a function to be used to get the text to display
6132 in the quickfix and location list windows. This can be used to
6133 customize the information displayed in the quickfix or location window
6134 for each entry in the corresponding quickfix or location list. See
6135 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006136 function and an example. The value can be the name of a function, a
6137 |lambda| or a |Funcref|. See |option-value-function| for more
6138 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006139
6140 This option cannot be set from a |modeline| or in the |sandbox|, for
6141 security reasons.
6142
Bram Moolenaar677ee682005-01-27 14:41:15 +00006143 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006144'quoteescape' 'qe' string (default "\")
6145 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006146 The characters that are used to escape quotes in a string. Used for
6147 objects like a', a" and a` |a'|.
6148 When one of the characters in this option is found inside a string,
6149 the following character will be skipped. The default value makes the
6150 text "foo\"bar\\" considered to be one string.
6151
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6153'readonly' 'ro' boolean (default off)
6154 local to buffer
6155 If on, writes fail unless you use a '!'. Protects you from
6156 accidentally overwriting a file. Default on when Vim is started
6157 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006158 When using ":w!" the 'readonly' option is reset for the current
6159 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006160 When using the ":view" command the 'readonly' option is set for the
6161 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006162 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006164 *'redrawtime'* *'rdt'*
6165'redrawtime' 'rdt' number (default 2000)
6166 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006167 {only available when compiled with the |+reltime|
6168 feature}
6169 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006170 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006171 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006172 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006173 matches will be highlighted.
6174 For syntax highlighting the time applies per window. When over the
6175 limit syntax highlighting is disabled until |CTRL-L| is used.
6176 This is used to avoid that Vim hangs when using a very complicated
6177 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006178
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006179 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006180'regexpengine' 're' number (default 0)
6181 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006182 This selects the default regexp engine. |two-engines|
6183 The possible values are:
6184 0 automatic selection
6185 1 old engine
6186 2 NFA engine
6187 Note that when using the NFA engine and the pattern contains something
6188 that is not supported the pattern will not match. This is only useful
6189 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006190 Using automatic selection enables Vim to switch the engine, if the
6191 default engine becomes too costly. E.g., when the NFA engine uses too
6192 many states. This should prevent Vim from hanging on a combination of
6193 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006194
Bram Moolenaar64486672010-05-16 15:46:46 +02006195 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6196'relativenumber' 'rnu' boolean (default off)
6197 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006198 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006199 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006200 precede some vertical motion commands (e.g. j k + -) with, without
6201 having to calculate it yourself. Especially useful in combination with
6202 other commands (e.g. y d c < > gq gw =).
6203 When the 'n' option is excluded from 'cpoptions' a wrapped
6204 line will not use the column of line numbers (this is the default when
6205 'compatible' isn't set).
6206 The 'numberwidth' option can be used to set the room used for the line
6207 number.
6208 When a long, wrapped line doesn't start with the first character, '-'
6209 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006210 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6211 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006212
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006213 The number in front of the cursor line also depends on the value of
6214 'number', see |number_relativenumber| for all combinations of the two
6215 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006216
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 *'remap'* *'noremap'*
6218'remap' boolean (default on)
6219 global
6220 Allows for mappings to work recursively. If you do not want this for
6221 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006222 NOTE: To avoid portability problems with Vim scripts, always keep
6223 this option at the default "on". Only switch it off when working with
6224 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006226 *'renderoptions'* *'rop'*
6227'renderoptions' 'rop' string (default: empty)
6228 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006229 {only available when compiled with GUI and DIRECTX on
6230 MS-Windows}
6231 Select a text renderer and set its options. The options depend on the
6232 renderer.
6233
6234 Syntax: >
6235 set rop=type:{renderer}(,{name}:{value})*
6236<
6237 Currently, only one optional renderer is available.
6238
6239 render behavior ~
6240 directx Vim will draw text using DirectX (DirectWrite). It makes
6241 drawn glyphs more beautiful than default GDI.
6242 It requires 'encoding' is "utf-8", and only works on
6243 MS-Windows Vista or newer version.
6244
6245 Options:
6246 name meaning type value ~
6247 gamma gamma float 1.0 - 2.2 (maybe)
6248 contrast enhancedContrast float (unknown)
6249 level clearTypeLevel float (unknown)
6250 geom pixelGeometry int 0 - 2 (see below)
6251 renmode renderingMode int 0 - 6 (see below)
6252 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006253 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006254
Bram Moolenaar92467d32017-12-05 13:22:16 +01006255 See this URL for detail (except for scrlines):
6256 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006257
6258 For geom: structure of a device pixel.
6259 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6260 1 - DWRITE_PIXEL_GEOMETRY_RGB
6261 2 - DWRITE_PIXEL_GEOMETRY_BGR
6262
6263 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006264 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006265
6266 For renmode: method of rendering glyphs.
6267 0 - DWRITE_RENDERING_MODE_DEFAULT
6268 1 - DWRITE_RENDERING_MODE_ALIASED
6269 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6270 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6271 4 - DWRITE_RENDERING_MODE_NATURAL
6272 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6273 6 - DWRITE_RENDERING_MODE_OUTLINE
6274
6275 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006276 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006277
6278 For taamode: antialiasing mode used for drawing text.
6279 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6280 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6281 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6282 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6283
6284 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006285 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6286
Bram Moolenaara338adc2018-01-31 20:51:47 +01006287 For scrlines:
6288 This was used for optimizing scrolling behavior, however this
6289 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006290
6291 Example: >
6292 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006293 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006294 set rop=type:directx
6295<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006296 If select a raster font (Courier, Terminal or FixedSys which
6297 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006298 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006299
6300 NOTE: It is known that some fonts and options combination
6301 causes trouble on drawing glyphs.
6302
Bram Moolenaar92467d32017-12-05 13:22:16 +01006303 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006304 special made fonts (True-Type fonts which includes only
6305 bitmap glyphs).
6306 - 'taamode:3' will not work with some vector fonts.
6307
6308 NOTE: With this option, you can display colored emoji
6309 (emoticon) in Windows 8.1 or later. To display colored emoji,
6310 there are some conditions which you should notice.
6311
6312 - If your font includes non-colored emoji already, it will
6313 be used.
6314 - If your font doesn't have emoji, the system chooses an
6315 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6316 will be used.
6317 - When this alternative font didn't have fixed width glyph,
6318 emoji might be rendered beyond the bounding box of drawing
6319 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006320
6321 Other render types are currently not supported.
6322
Bram Moolenaar071d4272004-06-13 20:20:40 +00006323 *'report'*
6324'report' number (default 2)
6325 global
6326 Threshold for reporting number of lines changed. When the number of
6327 changed lines is more than 'report' a message will be given for most
6328 ":" commands. If you want it always, set 'report' to 0.
6329 For the ":substitute" command the number of substitutions is used
6330 instead of the number of lines.
6331
6332 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6333'restorescreen' 'rs' boolean (default on)
6334 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006335 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 When set, the screen contents is restored when exiting Vim. This also
6337 happens when executing external commands.
6338
6339 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6340 options in your .vimrc. To disable restoring:
6341 set t_ti= t_te=
6342 To enable restoring (for an xterm):
6343 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6344 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6345
6346 *'revins'* *'ri'* *'norevins'* *'nori'*
6347'revins' 'ri' boolean (default off)
6348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 {only available when compiled with the |+rightleft|
6350 feature}
6351 Inserting characters in Insert mode will work backwards. See "typing
6352 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6353 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006354 NOTE: This option is reset when 'compatible' is set.
6355 This option is reset when 'paste' is set and restored when 'paste' is
6356 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357
6358 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6359'rightleft' 'rl' boolean (default off)
6360 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 {only available when compiled with the |+rightleft|
6362 feature}
6363 When on, display orientation becomes right-to-left, i.e., characters
6364 that are stored in the file appear from the right to the left.
6365 Using this option, it is possible to edit files for languages that
6366 are written from the right to the left such as Hebrew and Arabic.
6367 This option is per window, so it is possible to edit mixed files
6368 simultaneously, or to view the same file in both ways (this is
6369 useful whenever you have a mixed text file with both right-to-left
6370 and left-to-right strings so that both sets are displayed properly
6371 in different windows). Also see |rileft.txt|.
6372
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006373 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374'rightleftcmd' 'rlc' string (default "search")
6375 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 {only available when compiled with the |+rightleft|
6377 feature}
6378 Each word in this option enables the command line editing to work in
6379 right-to-left mode for a group of commands:
6380
6381 search "/" and "?" commands
6382
6383 This is useful for languages such as Hebrew, Arabic and Farsi.
6384 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6385
Bram Moolenaard94464e2015-11-02 15:28:18 +01006386 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006387'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006388 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006389 {only available when compiled with the |+ruby/dyn|
6390 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006391 Specifies the name of the Ruby shared library. The default is
6392 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006393 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006394 This option cannot be set from a |modeline| or in the |sandbox|, for
6395 security reasons.
6396
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006398'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400 {not available when compiled without the
6401 |+cmdline_info| feature}
6402 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006403 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 text in the file is shown on the far right:
6405 Top first line is visible
6406 Bot last line is visible
6407 All first and last line are visible
6408 45% relative position in the file
6409 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006410 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006412 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 this option takes precedence over 'ruler' and 'rulerformat'
6414 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006415 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 the text column (byte number) and the screen column are shown,
6417 separated with a dash.
6418 For an empty line "0-1" is shown.
6419 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006420 This option is reset when 'paste' is set and restored when 'paste' is
6421 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 If you don't want to see the ruler all the time but want to know where
6423 you are, use "g CTRL-G" |g_CTRL-G|.
6424 NOTE: This option is reset when 'compatible' is set.
6425
6426 *'rulerformat'* *'ruf'*
6427'rulerformat' 'ruf' string (default empty)
6428 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 {not available when compiled without the |+statusline|
6430 feature}
6431 When this option is not empty, it determines the content of the ruler
6432 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006433 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006434 This option cannot be set in a modeline when 'modelineexpr' is off.
6435
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 The default ruler width is 17 characters. To make the ruler 15
6437 characters wide, put "%15(" at the start and "%)" at the end.
6438 Example: >
6439 :set rulerformat=%15(%c%V\ %p%%%)
6440<
6441 *'runtimepath'* *'rtp'* *vimfiles*
6442'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006443 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 $VIM/vimfiles,
6445 $VIMRUNTIME,
6446 $VIM/vimfiles/after,
6447 $HOME/.vim/after"
6448 Amiga: "home:vimfiles,
6449 $VIM/vimfiles,
6450 $VIMRUNTIME,
6451 $VIM/vimfiles/after,
6452 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006453 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 $VIM/vimfiles,
6455 $VIMRUNTIME,
6456 $VIM/vimfiles/after,
6457 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006458 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 $VIMRUNTIME,
6460 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006461 Haiku: "$BE_USER_SETTINGS/vim,
6462 $VIM/vimfiles,
6463 $VIMRUNTIME,
6464 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006465 $BE_USER_SETTINGS/vim/after"
6466 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 $VIM/vimfiles,
6468 $VIMRUNTIME,
6469 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006470 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 This is a list of directories which will be searched for runtime
6473 files:
6474 filetype.vim filetypes by file name |new-filetype|
6475 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006476 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 colors/ color scheme files |:colorscheme|
6478 compiler/ compiler files |:compiler|
6479 doc/ documentation |write-local-help|
6480 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006481 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 indent/ indent scripts |indent-expression|
6483 keymap/ key mapping files |mbyte-keymap|
6484 lang/ menu translations |:menutrans|
6485 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006486 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 plugin/ plugin scripts |write-plugin|
6488 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006489 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 syntax/ syntax files |mysyntaxfile|
6491 tutor/ files for vimtutor |tutor|
6492
6493 And any other file searched for with the |:runtime| command.
6494
6495 The defaults for most systems are setup to search five locations:
6496 1. In your home directory, for your personal preferences.
6497 2. In a system-wide Vim directory, for preferences from the system
6498 administrator.
6499 3. In $VIMRUNTIME, for files distributed with Vim.
6500 *after-directory*
6501 4. In the "after" directory in the system-wide Vim directory. This is
6502 for the system administrator to overrule or add to the distributed
6503 defaults (rarely needed)
6504 5. In the "after" directory in your home directory. This is for
6505 personal preferences to overrule or add to the distributed defaults
6506 or system-wide settings (rarely needed).
6507
Bram Moolenaard0796902016-09-16 20:02:31 +02006508 More entries are added when using |packages|. If it gets very long
6509 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6510 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006511
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6513 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006514 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 wildcards.
6516 See |:runtime|.
6517 Example: >
6518 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6519< This will use the directory "~/vimruntime" first (containing your
6520 personal Vim runtime files), then "/mygroup/vim" (shared between a
6521 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6522 files).
6523 You probably should always include $VIMRUNTIME somewhere, to use the
6524 distributed runtime files. You can put a directory before $VIMRUNTIME
6525 to find files which replace a distributed runtime files. You can put
6526 a directory after $VIMRUNTIME to find files which add to distributed
6527 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006528 When Vim is started with |--clean| the home directory entries are not
6529 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 This option cannot be set from a |modeline| or in the |sandbox|, for
6531 security reasons.
6532
6533 *'scroll'* *'scr'*
6534'scroll' 'scr' number (default: half the window height)
6535 local to window
6536 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6537 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006538 changes. This may happen when enabling the |status-line| or
6539 'tabline' option after setting the 'scroll' option.
6540 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006541 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006542 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543
6544 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6545'scrollbind' 'scb' boolean (default off)
6546 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 See also |scroll-binding|. When this option is set, the current
6548 window scrolls as other scrollbind windows (windows that also have
6549 this option set) scroll. This option is useful for viewing the
6550 differences between two versions of a file, see 'diff'.
6551 See |'scrollopt'| for options that determine how this option should be
6552 interpreted.
6553 This option is mostly reset when splitting a window to edit another
6554 file. This means that ":split | edit file" results in two windows
6555 with scroll-binding, but ":split file" does not.
6556
Bram Moolenaarae20f342019-11-05 21:09:23 +01006557 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6558'scrollfocus' 'scf' boolean (default off)
6559 global
6560 {only for MS-Windows GUI}
6561 When using the scroll wheel and this option is set, the window under
6562 the mouse pointer is scrolled. With this option off the current
6563 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006564 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006565
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 *'scrolljump'* *'sj'*
6567'scrolljump' 'sj' number (default 1)
6568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 Minimal number of lines to scroll when the cursor gets off the
6570 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6571 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006572 When set to a negative number from -1 to -100 this is used as the
6573 percentage of the window height. Thus -50 scrolls half the window
6574 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 NOTE: This option is set to 1 when 'compatible' is set.
6576
6577 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006578'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006579 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 Minimal number of screen lines to keep above and below the cursor.
6581 This will make some context visible around where you are working. If
6582 you set it to a very large value (999) the cursor line will always be
6583 in the middle of the window (except at the start or end of the file or
6584 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006585 After using the local value, go back the global value with one of
6586 these two: >
6587 setlocal scrolloff<
6588 setlocal scrolloff=-1
6589< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 NOTE: This option is set to 0 when 'compatible' is set.
6591
6592 *'scrollopt'* *'sbo'*
6593'scrollopt' 'sbo' string (default "ver,jump")
6594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006596 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6597 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 The following words are available:
6599 ver Bind vertical scrolling for 'scrollbind' windows
6600 hor Bind horizontal scrolling for 'scrollbind' windows
6601 jump Applies to the offset between two windows for vertical
6602 scrolling. This offset is the difference in the first
6603 displayed line of the bound windows. When moving
6604 around in a window, another 'scrollbind' window may
6605 reach a position before the start or after the end of
6606 the buffer. The offset is not changed though, when
6607 moving back the 'scrollbind' window will try to scroll
6608 to the desired position when possible.
6609 When now making that window the current one, two
6610 things can be done with the relative offset:
6611 1. When "jump" is not included, the relative offset is
6612 adjusted for the scroll position in the new current
6613 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006614 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 2. When "jump" is included, the other windows are
6616 scrolled to keep the same relative offset. When
6617 going back to the other window, it still uses the
6618 same relative offset.
6619 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006620 When 'diff' mode is active there always is vertical scroll binding,
6621 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622
6623 *'sections'* *'sect'*
6624'sections' 'sect' string (default "SHNHH HUnhsh")
6625 global
6626 Specifies the nroff macros that separate sections. These are pairs of
6627 two letters (See |object-motions|). The default makes a section start
6628 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6629
6630 *'secure'* *'nosecure'* *E523*
6631'secure' boolean (default off)
6632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 When on, ":autocmd", shell and write commands are not allowed in
6634 ".vimrc" and ".exrc" in the current directory and map commands are
6635 displayed. Switch it off only if you know that you will not run into
6636 problems, or when the 'exrc' option is off. On Unix this option is
6637 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006638 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 'secure' at the end of your ~/.vimrc then.
6640 This option cannot be set from a |modeline| or in the |sandbox|, for
6641 security reasons.
6642
6643 *'selection'* *'sel'*
6644'selection' 'sel' string (default "inclusive")
6645 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 This option defines the behavior of the selection. It is only used
6647 in Visual and Select mode.
6648 Possible values:
6649 value past line inclusive ~
6650 old no yes
6651 inclusive yes yes
6652 exclusive yes no
6653 "past line" means that the cursor is allowed to be positioned one
6654 character past the line.
6655 "inclusive" means that the last character of the selection is included
6656 in an operation. For example, when "x" is used to delete the
6657 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006658 When "old" is used and 'virtualedit' allows the cursor to move past
6659 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 Note that when "exclusive" is used and selecting from the end
6661 backwards, you cannot include the last character of a line, when
6662 starting in Normal mode and 'virtualedit' empty.
6663
6664 The 'selection' option is set by the |:behave| command.
6665
6666 *'selectmode'* *'slm'*
6667'selectmode' 'slm' string (default "")
6668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 This is a comma separated list of words, which specifies when to start
6670 Select mode instead of Visual mode, when a selection is started.
6671 Possible values:
6672 mouse when using the mouse
6673 key when using shifted special keys
6674 cmd when using "v", "V" or CTRL-V
6675 See |Select-mode|.
6676 The 'selectmode' option is set by the |:behave| command.
6677
6678 *'sessionoptions'* *'ssop'*
6679'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006680 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006682 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 feature}
6684 Changes the effect of the |:mksession| command. It is a comma
6685 separated list of words. Each word enables saving and restoring
6686 something:
6687 word save and restore ~
6688 blank empty windows
6689 buffers hidden and unloaded buffers, not just those in windows
6690 curdir the current directory
6691 folds manually created folds, opened/closed folds and local
6692 fold options
6693 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006694 and contain at least one lowercase letter. Only
6695 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 help the help window
6697 localoptions options and mappings local to a window or buffer (not
6698 global values for local options)
6699 options all options and mappings (also global values for local
6700 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006701 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 resize size of the Vim window: 'lines' and 'columns'
6703 sesdir the directory in which the session file is located
6704 will become the current directory (useful with
6705 projects accessed over a network from different
6706 systems)
6707 slash backslashes in file names replaced with forward
6708 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006709 tabpages all tab pages; without this only the current tab page
6710 is restored, so that you can make a session for each
6711 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006712 terminal include terminal windows where the command can be
6713 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 unix with Unix end-of-line format (single <NL>), even when
6715 on Windows or DOS
6716 winpos position of the whole Vim window
6717 winsize window sizes
6718
6719 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006720 When neither "curdir" nor "sesdir" is included, file names are stored
6721 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006722 If you leave out "options" many things won't work well after restoring
6723 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 "slash" and "unix" are useful on Windows when sharing session files
6725 with Unix. The Unix version of Vim cannot source dos format scripts,
6726 but the Windows version of Vim can source unix format scripts.
6727
6728 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006729'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 global
6731 Name of the shell to use for ! and :! commands. When changing the
6732 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6733 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006734 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 See |option-backslash| about including spaces and backslashes.
6736 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006737
Bram Moolenaara2baa732022-02-04 16:09:54 +00006738 In |restricted-mode| shell commands will not be possible. This mode
6739 is used if the value of $SHELL ends in "false" or "nologin".
6740
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006741 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006742 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6744< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006745 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006747 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006749 Example with escaped space (Vim will do this when initializing the
6750 option from $SHELL): >
6751 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006752< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006753 backslashes are consumed by `:set`.
6754
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 Under MS-Windows, when the executable ends in ".com" it must be
6756 included. Thus setting the shell to "command.com" or "4dos.com"
6757 works, but "command" and "4dos" do not work for all commands (e.g.,
6758 filtering).
6759 For unknown reasons, when using "4dos.com" the current directory is
6760 changed to "C:\". To avoid this set 'shell' like this: >
6761 :set shell=command.com\ /c\ 4dos
6762< This option cannot be set from a |modeline| or in the |sandbox|, for
6763 security reasons.
6764
6765 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006766'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006767 Win32, when 'shell' contains "powershell":
6768 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006769 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006772 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6773 For MS-Windows, the default is set according to the value of 'shell',
6774 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006775 On Unix it can have more than one flag. Each white space separated
6776 part is passed as an argument to the shell command.
6777 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006778 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 This option cannot be set from a |modeline| or in the |sandbox|, for
6780 security reasons.
6781
6782 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006783'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6784 "2>&1| tee", or
6785 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 {not available when compiled without the |+quickfix|
6788 feature}
6789 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006790 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 including spaces and backslashes.
6792 The name of the temporary file can be represented by "%s" if necessary
6793 (the file name is appended automatically if no %s appears in the value
6794 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006795 For the Amiga the default is ">". For MS-Windows using powershell the
6796 default is "2>&1 | Out-File -Encoding default", otherwise the default
6797 is ">%s 2>&1". The output is directly saved in a file and not echoed
6798 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006799 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 in a file and echoed to the screen. If the 'shell' option is "csh" or
6801 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006802 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006803 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6804 means that stderr is also included. Before using the 'shell' option a
6805 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006806 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6807 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 The initialization of this option is done after reading the ".vimrc"
6809 and the other initializations, so that when the 'shell' option is set
6810 there, the 'shellpipe' option changes automatically, unless it was
6811 explicitly set before.
6812 When 'shellpipe' is set to an empty string, no redirection of the
6813 ":make" output will be done. This is useful if you use a 'makeprg'
6814 that writes to 'makeef' by itself. If you want no piping, but do
6815 want to include the 'makeef', set 'shellpipe' to a single space.
6816 Don't forget to precede the space with a backslash: ":set sp=\ ".
6817 In the future pipes may be used for filtering and this option will
6818 become obsolete (at least for Unix).
6819 This option cannot be set from a |modeline| or in the |sandbox|, for
6820 security reasons.
6821
6822 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006823'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 Quoting character(s), put around the command passed to the shell, for
6826 the "!" and ":!" commands. The redirection is kept outside of the
6827 quoting. See 'shellxquote' to include the redirection. It's
6828 probably not useful to set both options.
6829 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006830 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006831 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 This option cannot be set from a |modeline| or in the |sandbox|, for
6833 security reasons.
6834
6835 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006836'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6837 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 String to be used to put the output of a filter command in a temporary
6840 file. See also |:!|. See |option-backslash| about including spaces
6841 and backslashes.
6842 The name of the temporary file can be represented by "%s" if necessary
6843 (the file name is appended automatically if no %s appears in the value
6844 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006845 The default is ">". For Unix, if the 'shell' option is "csh" or
6846 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006847 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006848 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6849 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006850 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6851 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006852 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6853 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 The initialization of this option is done after reading the ".vimrc"
6855 and the other initializations, so that when the 'shell' option is set
6856 there, the 'shellredir' option changes automatically unless it was
6857 explicitly set before.
6858 In the future pipes may be used for filtering and this option will
6859 become obsolete (at least for Unix).
6860 This option cannot be set from a |modeline| or in the |sandbox|, for
6861 security reasons.
6862
6863 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6864'shellslash' 'ssl' boolean (default off)
6865 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006866 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006868 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006869 powershell.exe. Backward slashes can still be typed, but they are
6870 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 Note that setting or resetting this option has no effect for some
6872 existing file names, thus this option needs to be set before opening
6873 any file for best results. This might change in the future.
6874 'shellslash' only works when a backslash can be used as a path
6875 separator. To test if this is so use: >
6876 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006877< Also see 'completeslash'.
6878
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006879 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6880'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6881 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006882 When on, use temp files for shell commands. When off use a pipe.
6883 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006884 Currently a pipe is only supported on Unix and MS-Windows 2K and
6885 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006886 :if has("filterpipe")
6887< The advantage of using a pipe is that nobody can read the temp file
6888 and the 'shell' command does not need to support redirection.
6889 The advantage of using a temp file is that the file type and encoding
6890 can be detected.
6891 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6892 |FilterWritePost| autocommands event are not triggered when
6893 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006894 The `system()` function does not respect this option and always uses
6895 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006896 NOTE: This option is set to the Vim default value when 'compatible'
6897 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006898
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 *'shelltype'* *'st'*
6900'shelltype' 'st' number (default 0)
6901 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006902 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 On the Amiga this option influences the way how the commands work
6904 which use a shell.
6905 0 and 1: always use the shell
6906 2 and 3: use the shell only to filter lines
6907 4 and 5: use shell only for ':sh' command
6908 When not using the shell, the command is executed directly.
6909
6910 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6911 1 and 3: use "shell cmd" to start external commands
6912
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006913 *'shellxescape'* *'sxe'*
6914'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006915 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006916 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006917 When 'shellxquote' is set to "(" then the characters listed in this
6918 option will be escaped with a '^' character. This makes it possible
6919 to execute most external commands with cmd.exe.
6920
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 *'shellxquote'* *'sxq'*
6922'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006923 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006924 for Win32, when 'shell' is
6925 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006926 for Win32, when 'shell' contains "sh"
6927 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 for Unix, when using system(): "\"")
6929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 Quoting character(s), put around the command passed to the shell, for
6931 the "!" and ":!" commands. Includes the redirection. See
6932 'shellquote' to exclude the redirection. It's probably not useful
6933 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006934 When the value is '(' then ')' is appended. When the value is '"('
6935 then ')"' is appended.
6936 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006937 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006938 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6939 pwsh.exe which automatically strips off the first and last quote on a
6940 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6941 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006942 'shell', to reduce the need to set this option by the user. See
6943 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 This option cannot be set from a |modeline| or in the |sandbox|, for
6945 security reasons.
6946
6947 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6948'shiftround' 'sr' boolean (default off)
6949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 Round indent to multiple of 'shiftwidth'. Applies to > and <
6951 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6952 a multiple of 'shiftwidth' (this is Vi compatible).
6953 NOTE: This option is reset when 'compatible' is set.
6954
6955 *'shiftwidth'* *'sw'*
6956'shiftwidth' 'sw' number (default 8)
6957 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006958 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006960 When zero the 'ts' value will be used. Use the |shiftwidth()|
6961 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962
6963 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006964'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6965 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 This option helps to avoid all the |hit-enter| prompts caused by file
6968 messages, for example with CTRL-G, and to avoid some other messages.
6969 It is a list of flags:
6970 flag meaning when present ~
6971 f use "(3 of 5)" instead of "(file 3 of 5)"
6972 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006973 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 m use "[+]" instead of "[Modified]"
6975 n use "[New]" instead of "[New File]"
6976 r use "[RO]" instead of "[readonly]"
6977 w use "[w]" instead of "written" for file write message
6978 and "[a]" instead of "appended" for ':w >> file' command
6979 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6980 "[unix format]" and "[mac]" instead of "[mac format]".
6981 a all of the above abbreviations
6982
6983 o overwrite message for writing a file with subsequent message
6984 for reading a file (useful for ":wn" or when 'autowrite' on)
6985 O message for reading a file overwrites any previous message.
6986 Also for quickfix message (e.g., ":cn").
6987 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006988 hit TOP, continuing at BOTTOM" messages; when using the search
6989 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 t truncate file message at the start if it is too long to fit
6991 on the command-line, "<" will appear in the left most column.
6992 Ignored in Ex mode.
6993 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006994 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 Ignored in Ex mode.
6996 W don't give "written" or "[w]" when writing a file
6997 A don't give the "ATTENTION" message when an existing swap file
6998 is found.
6999 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007000 c don't give |ins-completion-menu| messages. For example,
7001 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7002 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007003 q use "recording" instead of "recording @a"
7004 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007005 was used for the command; note that this also affects messages
7006 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007007 S do not show search count message when searching, e.g.
7008 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009
7010 This gives you the opportunity to avoid that a change between buffers
7011 requires you to hit <Enter>, but still gives as useful a message as
7012 possible for the space available. To get the whole message that you
7013 would have got with 'shm' empty, use ":file!"
7014 Useful values:
7015 shm= No abbreviation of message.
7016 shm=a Abbreviation, but no loss of information.
7017 shm=at Abbreviation, and truncate message when necessary.
7018
7019 NOTE: This option is set to the Vi default value when 'compatible' is
7020 set and to the Vim default value when 'compatible' is reset.
7021
7022 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7023'shortname' 'sn' boolean (default off)
7024 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 Filenames are assumed to be 8 characters plus one extension of 3
7026 characters. Multiple dots in file names are not allowed. When this
7027 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007028 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007030 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031
7032 *'showbreak'* *'sbr'* *E595*
7033'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007034 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007035 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 feature}
7037 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007038 values are "> " or "+++ ": >
7039 :set showbreak=>\
7040< Note the backslash to escape the trailing space. It's easier like
7041 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007042 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007043< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 comma (in a future version the comma might be used to separate the
7045 part that is shown at the end and at the start of a line).
7046 The characters are highlighted according to the '@' flag in
7047 'highlight'.
7048 Note that tabs after the showbreak will be displayed differently.
7049 If you want the 'showbreak' to appear in between line numbers, add the
7050 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007051 A window-local value overrules a global value. If the global value is
7052 set and you want no value in the current window use NONE: >
7053 :setlocal showbreak=NONE
7054<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007056'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7057 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 {not available when compiled without the
7060 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007061 Show (partial) command in the last line of the screen. Set this
7062 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 In Visual mode the size of the selected area is shown:
7064 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007065 If the number of bytes is different it is also displayed: "2-6"
7066 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007068 - When selecting a block, the size in screen characters:
7069 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 NOTE: This option is set to the Vi default value when 'compatible' is
7071 set and to the Vim default value when 'compatible' is reset.
7072
7073 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7074'showfulltag' 'sft' boolean (default off)
7075 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 When completing a word in insert mode (see |ins-completion|) from the
7077 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007078 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 matched a C function, you can see a template for what arguments are
7080 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007081 Note that this doesn't work well together with having "longest" in
7082 'completeopt', because the completion from the search pattern may not
7083 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084
7085 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7086'showmatch' 'sm' boolean (default off)
7087 global
7088 When a bracket is inserted, briefly jump to the matching one. The
7089 jump is only done if the match can be seen on the screen. The time to
7090 show the match can be set with 'matchtime'.
7091 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007092 seen or not).
7093 This option is reset when 'paste' is set and restored when 'paste' is
7094 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 When the 'm' flag is not included in 'cpoptions', typing a character
7096 will immediately move the cursor back to where it belongs.
7097 See the "sm" field in 'guicursor' for setting the cursor shape and
7098 blinking when showing the match.
7099 The 'matchpairs' option can be used to specify the characters to show
7100 matches for. 'rightleft' and 'revins' are used to look for opposite
7101 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007102 Also see the matchparen plugin for highlighting the match when moving
7103 around |pi_paren.txt|.
7104 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105
7106 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7107'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7108 global
7109 If in Insert, Replace or Visual mode put a message on the last line.
7110 Use the 'M' flag in 'highlight' to set the type of highlighting for
7111 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007112 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 doesn't mean XIM is really active, especially when 'imactivatekey' is
7114 not set.
7115 NOTE: This option is set to the Vi default value when 'compatible' is
7116 set and to the Vim default value when 'compatible' is reset.
7117
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007118 *'showtabline'* *'stal'*
7119'showtabline' 'stal' number (default 1)
7120 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007121 The value of this option specifies when the line with tab page labels
7122 will be displayed:
7123 0: never
7124 1: only if there are at least two tab pages
7125 2: always
7126 This is both for the GUI and non-GUI implementation of the tab pages
7127 line.
7128 See |tab-page| for more information about tab pages.
7129
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 *'sidescroll'* *'ss'*
7131'sidescroll' 'ss' number (default 0)
7132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 The minimal number of columns to scroll horizontally. Used only when
7134 the 'wrap' option is off and the cursor is moved off of the screen.
7135 When it is zero the cursor will be put in the middle of the screen.
7136 When using a slow terminal set it to a large number or 0. When using
7137 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7138 commands.
7139
7140 *'sidescrolloff'* *'siso'*
7141'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007142 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007144 right of the cursor if 'nowrap' is set. Setting this option to a
7145 value greater than 0 while having |'sidescroll'| also at a non-zero
7146 value makes some context visible in the line you are scrolling in
7147 horizontally (except at beginning of the line). Setting this option
7148 to a large value (like 999) has the effect of keeping the cursor
7149 horizontally centered in the window, as long as one does not come too
7150 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007151 After using the local value, go back the global value with one of
7152 these two: >
7153 setlocal sidescrolloff<
7154 setlocal sidescrolloff=-1
7155< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156
7157 Example: Try this together with 'sidescroll' and 'listchars' as
7158 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007159 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160
7161 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7162 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007163<
7164 *'signcolumn'* *'scl'*
7165'signcolumn' 'scl' string (default "auto")
7166 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007167 {not available when compiled without the |+signs|
7168 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007169 Whether or not to draw the signcolumn. Valid values are:
7170 "auto" only when there is a sign to display
7171 "no" never
7172 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007173 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007174 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175
7176
7177 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7178'smartcase' 'scs' boolean (default off)
7179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 Override the 'ignorecase' option if the search pattern contains upper
7181 case characters. Only used when the search pattern is typed and
7182 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007183 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7185 recalling the search pattern from history and hitting <Enter>.
7186 NOTE: This option is reset when 'compatible' is set.
7187
7188 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7189'smartindent' 'si' boolean (default off)
7190 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 {not available when compiled without the
7192 |+smartindent| feature}
7193 Do smart autoindenting when starting a new line. Works for C-like
7194 programs, but can also be used for other languages. 'cindent' does
7195 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007196 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007197 setting 'si' has no effect. 'indentexpr' is a more advanced
7198 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 Normally 'autoindent' should also be on when using 'smartindent'.
7200 An indent is automatically inserted:
7201 - After a line ending in '{'.
7202 - After a line starting with a keyword from 'cinwords'.
7203 - Before a line starting with '}' (only with the "O" command).
7204 When typing '}' as the first character in a new line, that line is
7205 given the same indent as the matching '{'.
7206 When typing '#' as the first character in a new line, the indent for
7207 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007208 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7210 When using the ">>" command, lines starting with '#' are not shifted
7211 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007212 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007213 This option is reset when 'paste' is set and restored when 'paste' is
7214 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215
7216 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7217'smarttab' 'sta' boolean (default off)
7218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007220 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7221 <BS> will delete a 'shiftwidth' worth of space at the start of the
7222 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007223 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007224 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7225 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007226 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007228 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007229 This option is reset when 'paste' is set and restored when 'paste' is
7230 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 NOTE: This option is reset when 'compatible' is set.
7232
7233 *'softtabstop'* *'sts'*
7234'softtabstop' 'sts' number (default 0)
7235 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 Number of spaces that a <Tab> counts for while performing editing
7237 operations, like inserting a <Tab> or using <BS>. It "feels" like
7238 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7239 used. This is useful to keep the 'ts' setting at its standard value
7240 of 8, while being able to edit like it is set to 'sts'. However,
7241 commands like "x" still work on the actual characters.
7242 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007243 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007244 'softtabstop' is set to 0 when the 'paste' option is set and restored
7245 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7247 spaces is minimized by using <Tab>s.
7248 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7249 set.
7250 NOTE: This option is set to 0 when 'compatible' is set.
7251
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007252 If Vim is compiled with the |+vartabs| feature then the value of
7253 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7254 anything other than an empty string.
7255
Bram Moolenaar217ad922005-03-20 22:37:15 +00007256 *'spell'* *'nospell'*
7257'spell' boolean (default off)
7258 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007259 {not available when compiled without the |+syntax|
7260 feature}
7261 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007262 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007263
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007264 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007265'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007266 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007267 {not available when compiled without the |+syntax|
7268 feature}
7269 Pattern to locate the end of a sentence. The following word will be
7270 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007271 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007272 When this check is not wanted make this option empty.
7273 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007274 Be careful with special characters, see |option-backslash| about
7275 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007276 To set this option automatically depending on the language, see
7277 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007278
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007279 *'spellfile'* *'spf'*
7280'spellfile' 'spf' string (default empty)
7281 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007282 {not available when compiled without the |+syntax|
7283 feature}
7284 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007285 commands. It must end in ".{encoding}.add". You need to include the
7286 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007287 *E765*
7288 It may also be a comma separated list of names. A count before the
7289 |zg| and |zw| commands can be used to access each. This allows using
7290 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007291 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007292 you: Using the first directory in 'runtimepath' that is writable. If
7293 there is no "spell" directory yet it will be created. For the file
7294 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007295 ignoring the region.
7296 The resulting ".spl" file will be used for spell checking, it does not
7297 have to appear in 'spelllang'.
7298 Normally one file is used for all regions, but you can add the region
7299 name if you want to. However, it will then only be used when
7300 'spellfile' is set to it, for entries in 'spelllang' only files
7301 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007302 This option cannot be set from a |modeline| or in the |sandbox|, for
7303 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007304
Bram Moolenaar217ad922005-03-20 22:37:15 +00007305 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007306'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007307 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007308 {not available when compiled without the |+syntax|
7309 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007310 A comma separated list of word list names. When the 'spell' option is
7311 on spellchecking will be done for these languages. Example: >
7312 set spelllang=en_us,nl,medical
7313< This means US English, Dutch and medical words are recognized. Words
7314 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007315 The word list name must consist of alphanumeric characters, a dash or
7316 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007317 recommended to separate the two letter language name from a
7318 specification. Thus "en-rare" is used for rare English words.
7319 A region name must come last and have the form "_xx", where "xx" is
7320 the two-letter, lower case region name. You can use more than one
7321 region by listing them: "en_us,en_ca" supports both US and Canadian
7322 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007323 Britain. (Note: currently en_au and en_nz dictionaries are older than
7324 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007325 If the name "cjk" is included East Asian characters are excluded from
7326 spell checking. This is useful when editing text that also has Asian
7327 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007328 Note that the "medical" dictionary does not exist, it is just an
7329 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007330 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007331 As a special case the name of a .spl file can be given as-is. The
7332 first "_xx" in the name is removed and used as the region name
7333 (_xx is an underscore, two letters and followed by a non-letter).
7334 This is mainly for testing purposes. You must make sure the correct
7335 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007336 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007337 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7338 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007339 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007340
Bram Moolenaar98692072006-02-04 00:57:42 +00007341 If the |spellfile.vim| plugin is active and you use a language name
7342 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7343 will ask you if you want to download the file.
7344
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007345 After this option has been set successfully, Vim will source the files
7346 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007347 up to the first character that is not an ASCII letter or number and
7348 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007349
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007350 *'spelloptions'* *'spo'*
7351'spelloptions' 'spo' string (default "")
7352 local to buffer
7353 {not available when compiled without the |+syntax|
7354 feature}
7355 A comma separated list of options for spell checking:
7356 camel When a word is CamelCased, assume "Cased" is a
7357 separate word: every upper-case character in a word
7358 that comes after a lower case character indicates the
7359 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007360
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007361 *'spellsuggest'* *'sps'*
7362'spellsuggest' 'sps' string (default "best")
7363 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007364 {not available when compiled without the |+syntax|
7365 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007366 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007367 the |spellsuggest()| function. This is a comma-separated list of
7368 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007369
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007370 best Internal method that works best for English. Finds
7371 changes like "fast" and uses a bit of sound-a-like
7372 scoring to improve the ordering.
7373
7374 double Internal method that uses two methods and mixes the
7375 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007376 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007377 word. That only works when the language specifies
7378 sound folding. Can be slow and doesn't always give
7379 better results.
7380
7381 fast Internal method that only checks for simple changes:
7382 character inserts/deletes/swaps. Works well for
7383 simple typing mistakes.
7384
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007385 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007386 Not used for |spellsuggest()|. The number of
7387 suggestions is never more than the value of 'lines'
7388 minus two.
7389
Bram Moolenaar585ee072022-01-29 11:22:17 +00007390 timeout:{millisec} Limit the time searching for suggestions to
7391 {millisec} milli seconds. Applies to the following
7392 methods. When omitted the limit is 5000. When
7393 negative there is no limit. {only works when built
7394 with the +reltime feature}
7395
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007396 file:{filename} Read file {filename}, which must have two columns,
7397 separated by a slash. The first column contains the
7398 bad word, the second column the suggested good word.
7399 Example:
7400 theribal/terrible ~
7401 Use this for common mistakes that do not appear at the
7402 top of the suggestion list with the internal methods.
7403 Lines without a slash are ignored, use this for
7404 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007405 The word in the second column must be correct,
7406 otherwise it will not be used. Add the word to an
7407 ".add" file if it is currently flagged as a spelling
7408 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007409 The file is used for all languages.
7410
7411 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7412 trouble with spaces. |v:val| holds the badly spelled
7413 word. The expression must evaluate to a List of
7414 Lists, each with a suggestion and a score.
7415 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007416 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007417 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007418 internal methods use. A lower score is better.
7419 This may invoke |spellsuggest()| if you temporarily
7420 set 'spellsuggest' to exclude the "expr:" part.
7421 Errors are silently ignored, unless you set the
7422 'verbose' option to a non-zero value.
7423
7424 Only one of "best", "double" or "fast" may be used. The others may
7425 appear several times in any order. Example: >
7426 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7427<
7428 This option cannot be set from a |modeline| or in the |sandbox|, for
7429 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007430
7431
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7433'splitbelow' 'sb' boolean (default off)
7434 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 When on, splitting a window will put the new window below the current
7436 one. |:split|
7437
7438 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7439'splitright' 'spr' boolean (default off)
7440 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 When on, splitting a window will put the new window right of the
7442 current one. |:vsplit|
7443
7444 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7445'startofline' 'sol' boolean (default on)
7446 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007448 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007449 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007450 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 with a linewise operator, with "%" with a count and to buffer changing
7452 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7453 only has a line number, e.g., ":25" or ":+".
7454 In case of buffer changing commands the cursor is placed at the column
7455 where it was the last time the buffer was edited.
7456 NOTE: This option is set when 'compatible' is set.
7457
Bram Moolenaar00654022011-02-25 14:42:19 +01007458 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007460 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 {not available when compiled without the |+statusline|
7462 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007463 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 Also see |status-line|.
7465
7466 The option consists of printf style '%' items interspersed with
7467 normal text. Each status line item is of the form:
7468 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007469 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007470 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471
Bram Moolenaar238a5642006-02-21 22:12:05 +00007472 When the option starts with "%!" then it is used as an expression,
7473 evaluated and the result is used as the option value. Example: >
7474 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007475< The *g:statusline_winid* variable will be set to the |window-ID| of the
7476 window that the status line belongs to.
7477 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007478 Note that the "%!" expression is evaluated in the context of the
7479 current window and buffer, while %{} items are evaluated in the
7480 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007481
7482 When there is error while evaluating the option then it will be made
7483 empty to avoid further errors. Otherwise screen updating would loop.
7484
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 Note that the only effect of 'ruler' when this option is set (and
7486 'laststatus' is 2) is controlling the output of |CTRL-G|.
7487
7488 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007489 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007491 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 minwid Minimum width of the item, padding as set by '-' & '0'.
7493 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007494 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 on the left for text items. Numeric items will be
7496 shifted down to maxwid-2 digits followed by '>'number
7497 where number is the amount of missing digits, much like
7498 an exponential notation.
7499 item A one letter code as described below.
7500
7501 Following is a description of the possible statusline items. The
7502 second character in "item" is the type:
7503 N for number
7504 S for string
7505 F for flags as described below
7506 - not applicable
7507
7508 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007509 f S Path to the file in the buffer, as typed or relative to current
7510 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 F S Full path to the file in the buffer.
7512 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007513 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007515 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007517 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007519 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007521 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007523 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7525 being used: "<keymap>"
7526 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007527 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 B N As above, in hexadecimal.
7529 o N Byte number in file of byte under cursor, first byte is 1.
7530 Mnemonic: Offset from start of file (with one added)
7531 {not available when compiled without |+byte_offset| feature}
7532 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007533 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 l N Line number.
7535 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007536 c N Column number (byte index).
7537 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007538 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 p N Percentage through file in lines as in |CTRL-G|.
7540 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007541 percentage described for 'ruler'. Always 3 in length, unless
7542 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007543 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007545 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007546 Note that there is no '%' before the closing '}'. The
7547 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007548 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007549 {% - This is almost same as { except the result of the expression is
7550 re-evaluated as a statusline format string. Thus if the
7551 return value of expr contains % items they will get expanded.
7552 The expression can contain the } character, the end of
7553 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007554 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007555 func! Stl_filename() abort
7556 return "%t"
7557 endfunc
7558< `stl=%{Stl_filename()}` results in `"%t"`
7559 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007560 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561 ( - Start of item group. Can be used for setting the width and
7562 alignment of a section. Must be followed by %) somewhere.
7563 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007564 T N For 'tabline': start of tab page N label. Use %T after the last
7565 label. This information is used for mouse clicks.
7566 X N For 'tabline': start of close tab N label. Use %X after the
7567 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7568 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 < - Where to truncate line if too long. Default is at the start.
7570 No width fields allowed.
7571 = - Separation point between left and right aligned items.
7572 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007573 # - Set highlight group. The name must follow and then a # again.
7574 Thus use %#HLname# for highlight group HLname. The same
7575 highlighting is used, also for the statusline of non-current
7576 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007578 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 The difference between User{N} and StatusLine will be applied
7580 to StatusLineNC for the statusline of non-current windows.
7581 The number N must be between 1 and 9. See |hl-User1..9|
7582
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007583 When displaying a flag, Vim removes the leading comma, if any, when
7584 that flag comes right after plaintext. This will make a nice display
7585 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586
Bram Moolenaar582fd852005-03-28 20:58:01 +00007587 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 not set) and a minwid is not set for the group, the whole group will
7589 become empty. This will make a group like the following disappear
7590 completely from the statusline when none of the flags are set. >
7591 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007592< Beware that an expression is evaluated each and every time the status
7593 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007594 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007595 While evaluating %{} the current buffer and current window will be set
7596 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007597 currently being drawn. The expression will evaluate in this context.
7598 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7599 real current buffer and "g:actual_curwin" to the |window-ID| of the
7600 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007601
Bram Moolenaar30b65812012-07-12 22:01:11 +02007602 The 'statusline' option will be evaluated in the |sandbox| if set from
7603 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007604 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007605
7606 It is not allowed to change text or jump to another window while
7607 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608
7609 If the statusline is not updated when you want it (e.g., after setting
7610 a variable that's used in an expression), you can force an update by
7611 setting an option without changing its value. Example: >
7612 :let &ro = &ro
7613
7614< A result of all digits is regarded a number for display purposes.
7615 Otherwise the result is taken as flag text and applied to the rules
7616 described above.
7617
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007618 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007620 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621
7622 Examples:
7623 Emulate standard status line with 'ruler' set >
7624 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7625< Similar, but add ASCII value of char under the cursor (like "ga") >
7626 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7627< Display byte count and byte value, modified flag in red. >
7628 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7629 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7630< Display a ,GZ flag if a compressed file is loaded >
7631 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7632< In the |:autocmd|'s: >
7633 :let b:gzflag = 1
7634< And: >
7635 :unlet b:gzflag
7636< And define this function: >
7637 :function VarExists(var, val)
7638 : if exists(a:var) | return a:val | else | return '' | endif
7639 :endfunction
7640<
7641 *'suffixes'* *'su'*
7642'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 Files with these suffixes get a lower priority when multiple files
7645 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007646 suffixes. Spaces after the comma are ignored. A dot is also seen as
7647 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 separator, precede it with a backslash (see |option-backslash| about
7649 including spaces and backslashes).
7650 See 'wildignore' for completely ignoring files.
7651 The use of |:set+=| and |:set-=| is preferred when adding or removing
7652 suffixes from the list. This avoids problems when a future version
7653 uses another default.
7654
7655 *'suffixesadd'* *'sua'*
7656'suffixesadd' 'sua' string (default "")
7657 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658 {not available when compiled without the
7659 |+file_in_path| feature}
7660 Comma separated list of suffixes, which are used when searching for a
7661 file for the "gf", "[I", etc. commands. Example: >
7662 :set suffixesadd=.java
7663<
7664 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7665'swapfile' 'swf' boolean (default on)
7666 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007667 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 swapfile is not wanted for a specific buffer. For example, with
7669 confidential information that even root must not be able to access.
7670 Careful: All text will be in memory:
7671 - Don't use this for big files.
7672 - Recovery will be impossible!
7673 A swapfile will only be present when |'updatecount'| is non-zero and
7674 'swapfile' is set.
7675 When 'swapfile' is reset, the swap file for the current buffer is
7676 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7677 non-zero, a swap file is immediately created.
7678 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007679 If you want to open a new buffer without creating a swap file for it,
7680 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007681 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682
7683 This option is used together with 'bufhidden' and 'buftype' to
7684 specify special kinds of buffers. See |special-buffers|.
7685
7686 *'swapsync'* *'sws'*
7687'swapsync' 'sws' string (default "fsync")
7688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007690 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691 When this option is empty parts of the swap file may be in memory and
7692 not written to disk. When the system crashes you may lose more work.
7693 On Unix the system does a sync now and then without Vim asking for it,
7694 so the disadvantage of setting this option off is small. On some
7695 systems the swap file will not be written at all. For a unix system
7696 setting it to "sync" will use the sync() call instead of the default
7697 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007698 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699
7700 *'switchbuf'* *'swb'*
7701'switchbuf' 'swb' string (default "")
7702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007704 Mostly for |quickfix| commands some values are also used for other
7705 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 Possible values (comma separated list):
7707 useopen If included, jump to the first open window that
7708 contains the specified buffer (if there is one).
7709 Otherwise: Do not examine other windows.
7710 This setting is checked with |quickfix| commands, when
7711 jumping to errors (":cc", ":cn", "cp", etc.). It is
7712 also used in all buffer related split commands, for
7713 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007714 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007715 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007717 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007718 Otherwise: do not split, use current window (when used
7719 in the quickfix window: the previously used window or
7720 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007721 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007722 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007723 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007724 uselast If included, jump to the previously used window when
7725 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007727 *'synmaxcol'* *'smc'*
7728'synmaxcol' 'smc' number (default 3000)
7729 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007730 {not available when compiled without the |+syntax|
7731 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007732 Maximum column in which to search for syntax items. In long lines the
7733 text after this column is not highlighted and following lines may not
7734 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007735 This helps to avoid very slow redrawing for an XML file that is one
7736 long line.
7737 Set to zero to remove the limit.
7738
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 *'syntax'* *'syn'*
7740'syntax' 'syn' string (default empty)
7741 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 {not available when compiled without the |+syntax|
7743 feature}
7744 When this option is set, the syntax with this name is loaded, unless
7745 syntax highlighting has been switched off with ":syntax off".
7746 Otherwise this option does not always reflect the current syntax (the
7747 b:current_syntax variable does).
7748 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007749 not automatically recognized. Example, in an IDL file:
7750 /* vim: set syntax=idl : */ ~
7751 When a dot appears in the value then this separates two filetype
7752 names. Example:
7753 /* vim: set syntax=c.doxygen : */ ~
7754 This will use the "c" syntax first, then the "doxygen" syntax.
7755 Note that the second one must be prepared to be loaded as an addition,
7756 otherwise it will be skipped. More than one dot may appear.
7757 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 :set syntax=OFF
7759< To switch syntax highlighting on according to the current value of the
7760 'filetype' option: >
7761 :set syntax=ON
7762< What actually happens when setting the 'syntax' option is that the
7763 Syntax autocommand event is triggered with the value as argument.
7764 This option is not copied to another buffer, independent of the 's' or
7765 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007766 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007768 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007769'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007770 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007771 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007772 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007773 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007774
7775 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007776 option and only when there is no GUI tab line. When 'e' is in
7777 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007778 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007779
7780 The value is evaluated like with 'statusline'. You can use
7781 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007782 the text to be displayed. Use "%1T" for the first label, "%2T" for
7783 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007784
Bram Moolenaare12bab32019-01-08 22:02:56 +01007785 When changing something that is used in 'tabline' that does not
7786 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007787 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007788
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007789 Keep in mind that only one of the tab pages is the current one, others
7790 are invisible and you can't jump to their windows.
7791
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007792
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007793 *'tabpagemax'* *'tpm'*
7794'tabpagemax' 'tpm' number (default 10)
7795 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007796 Maximum number of tab pages to be opened by the |-p| command line
7797 argument or the ":tab all" command. |tabpage|
7798
7799
7800 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801'tabstop' 'ts' number (default 8)
7802 local to buffer
7803 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007804 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805
7806 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007807 appear wrong in many places, e.g., when printing it.
7808 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809
7810 There are four main ways to use tabs in Vim:
7811 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7812 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007813 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007814 behave like a tab appears every 4 (or 3) characters.
7815 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7816 'expandtab'. This way you will always insert spaces. The
7817 formatting will never be messed up when 'tabstop' is changed.
7818 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007819 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 works when using Vim to edit the file.
7821 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7822 'noexpandtab'. This should then work (for initial indents only)
7823 for any tabstop setting that people use. It might be nice to have
7824 tabs after the first non-blank inserted as spaces if you do this
7825 though. Otherwise aligned comments will be wrong when 'tabstop' is
7826 changed.
7827
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007828 If Vim is compiled with the |+vartabs| feature then the value of
7829 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7830 than an empty string.
7831
Bram Moolenaar071d4272004-06-13 20:20:40 +00007832 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7833'tagbsearch' 'tbs' boolean (default on)
7834 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007836 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 searching makes searching for a tag a LOT faster, but a linear search
7838 will find more tags if the tags file wasn't properly sorted.
7839 Vim normally assumes that your tags files are sorted, or indicate that
7840 they are not sorted. Only when this is not the case does the
7841 'tagbsearch' option need to be switched off.
7842
7843 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007844 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 certain files, or retry all files with a linear search. When
7846 'tagbsearch' is off, only a linear search is done.
7847
7848 Linear searching is done anyway, for one file, when Vim finds a line
7849 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007850 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851< [The whitespace before and after the '0' must be a single <Tab>]
7852
7853 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007854 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 instead of a normal tag name, a retry is done with a linear search.
7856 Tags in unsorted tags files, and matches with different case will only
7857 be found in the retry.
7858
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007859 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007860 linear search can be avoided when case is ignored. Use a value of '2'
7861 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7862 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007863 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7864 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7865 used for this as well. Note that case must be folded to uppercase for
7866 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007867
7868 By default, tag searches are case-sensitive. Case is ignored when
7869 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7870 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007871 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7872 'tagcase' is "smart", and the pattern contains only lowercase
7873 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874
7875 When 'tagbsearch' is off, tags searching is slower when a full match
7876 exists, but faster when no full match exists. Tags in unsorted tags
7877 files may only be found with 'tagbsearch' off.
7878 When the tags file is not sorted, or sorted in a wrong way (not on
7879 ASCII byte value), 'tagbsearch' should be off, or the line given above
7880 must be included in the tags file.
7881 This option doesn't affect commands that find all matching tags (e.g.,
7882 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007884 *'tagcase'* *'tc'*
7885'tagcase' 'tc' string (default "followic")
7886 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007887 This option specifies how case is handled when searching the tags
7888 file:
7889 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007890 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007891 ignore Ignore case
7892 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007893 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007894 NOTE: This option is set to the Vi default value when 'compatible' is
7895 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007896
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007897 *'tagfunc'* *'tfu'*
7898'tagfunc' 'tfu' string (default: empty)
7899 local to buffer
7900 {not available when compiled without the |+eval|
7901 feature}
7902 This option specifies a function to be used to perform tag searches.
7903 The function gets the tag pattern and should return a List of matching
7904 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007905 function and an example. The value can be the name of a function, a
7906 |lambda| or a |Funcref|. See |option-value-function| for more
7907 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007908
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 *'taglength'* *'tl'*
7910'taglength' 'tl' number (default 0)
7911 global
7912 If non-zero, tags are significant up to this number of characters.
7913
7914 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7915'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7916 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007917 If on and using a tags file in another directory, file names in that
7918 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 NOTE: This option is set to the Vi default value when 'compatible' is
7920 set and to the Vim default value when 'compatible' is reset.
7921
7922 *'tags'* *'tag'* *E433*
7923'tags' 'tag' string (default "./tags,tags", when compiled with
7924 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7925 global or local to buffer |global-local|
7926 Filenames for the tag command, separated by spaces or commas. To
7927 include a space or comma in a file name, precede it with a backslash
7928 (see |option-backslash| about including spaces and backslashes).
7929 When a file name starts with "./", the '.' is replaced with the path
7930 of the current file. But only when the 'd' flag is not included in
7931 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7932 |tags-option|.
7933 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007934 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7935 find all files named "tags" below "/lib". The filename itself cannot
7936 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7937 files called "tags?". {not available when compiled without the
7938 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007939 The |tagfiles()| function can be used to get a list of the file names
7940 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007941 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7942 files are also supported. They are automatically recognized. The
7943 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7944 differences are ignored (MS-Windows). |emacs-tags|
7945 The use of |:set+=| and |:set-=| is preferred when adding or removing
7946 file names from the list. This avoids problems when a future version
7947 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948
7949 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7950'tagstack' 'tgst' boolean (default on)
7951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 When on, the |tagstack| is used normally. When off, a ":tag" or
7953 ":tselect" command with an argument will not push the tag onto the
7954 tagstack. A following ":tag" without an argument, a ":pop" command or
7955 any other command that uses the tagstack will use the unmodified
7956 tagstack, but does change the pointer to the active entry.
7957 Resetting this option is useful when using a ":tag" command in a
7958 mapping which should not change the tagstack.
7959
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007960 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007961'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007962 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007963 {only available when compiled with the |+tcl/dyn|
7964 feature}
7965 Specifies the name of the Tcl shared library. The default is
7966 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007967 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007968 This option cannot be set from a |modeline| or in the |sandbox|, for
7969 security reasons.
7970
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 *'term'* *E529* *E530* *E531*
7972'term' string (default is $TERM, if that fails:
7973 in the GUI: "builtin_gui"
7974 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007975 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977 on Unix: "ansi"
7978 on VMS: "ansi"
7979 on Win 32: "win32")
7980 global
7981 Name of the terminal. Used for choosing the terminal control
7982 characters. Environment variables are expanded |:set_env|.
7983 For example: >
7984 :set term=$TERM
7985< See |termcap|.
7986
7987 *'termbidi'* *'tbidi'*
7988 *'notermbidi'* *'notbidi'*
7989'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 {only available when compiled with the |+arabic|
7992 feature}
7993 The terminal is in charge of Bi-directionality of text (as specified
7994 by Unicode). The terminal is also expected to do the required shaping
7995 that some languages (such as Arabic) require.
7996 Setting this option implies that 'rightleft' will not be set when
7997 'arabic' is set and the value of 'arabicshape' will be ignored.
7998 Note that setting 'termbidi' has the immediate effect that
7999 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8000 This option is reset when the GUI is started.
8001 For further details see |arabic.txt|.
8002
8003 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008004'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 Encoding used for the terminal. This specifies what character
8007 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008008 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008009 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008010 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008011 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8013 Any attempts to set a different value will be rejected, and an error
8014 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008015 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 because the Win32 system always passes Unicode characters.
8017 When empty, the same encoding is used as for the 'encoding' option.
8018 This is the normal value.
8019 Not all combinations for 'termencoding' and 'encoding' are valid. See
8020 |encoding-table|.
8021 The value for this option must be supported by internal conversions or
8022 iconv(). When this is not possible no conversion will be done and you
8023 will probably experience problems with non-ASCII characters.
8024 Example: You are working with the locale set to euc-jp (Japanese) and
8025 want to edit a UTF-8 file: >
8026 :let &termencoding = &encoding
8027 :set encoding=utf-8
8028< You need to do this when your system has no locale support for UTF-8.
8029
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008030 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008031'termguicolors' 'tgc' boolean (default off)
8032 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008033 {not available when compiled without the
8034 |+termguicolors| feature}
8035 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008036 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008037
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008038 Requires a ISO-8613-3 compatible terminal. If setting this option
8039 does not work (produces a colorless UI) reading |xterm-true-color|
8040 might help.
8041
8042 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8043 is required. Use this check to find out: >
8044 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008045< This requires Vim to be built with the |+vtp| feature.
8046
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008047 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008048 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008049
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008050 *'termwinkey'* *'twk'*
8051'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008052 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008053 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008054 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008055 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008056 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008057< The string must be one key stroke but can be multiple bytes.
8058 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008059 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008060 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008061
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008062 *'termwinscroll'* *'twsl'*
8063'termwinscroll' 'twsl' number (default 10000)
8064 local to buffer
8065 {not available when compiled without the
8066 |+terminal| feature}
8067 Number of scrollback lines to keep. When going over this limit the
8068 first 10% of the scrollback lines are deleted. This is just to reduce
8069 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008070 Also used as a limit for text sent to the terminal in one write,
8071 multiplied by the number of columns times 3 (average number of bytes
8072 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008073
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008074 *'termwinsize'* *'tws'*
8075'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008076 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008077 Size used when opening the |terminal| window. Format:
8078 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008079 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008080 - When set with a "x" (e.g., "24x80") the terminal size is not
8081 adjusted to the window size. If the window is smaller only the
8082 top-left part is displayed.
8083 - When set with a "*" (e.g., "10*50") the terminal size follows the
8084 window size, but will not be smaller than the specified rows and/or
8085 columns.
8086 - When rows is zero then use the height of the window.
8087 - When columns is zero then use the width of the window.
8088 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008089 - Can be overruled in the |term_start()| options with "term_rows" and
8090 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008091
8092 Examples:
8093 "30x0" uses 30 rows and the current window width.
8094 "20*0" uses at least 20 rows and the current window width.
8095 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008096 Note that the command running in the terminal window may still change
8097 the size of the terminal. In that case the Vim window will be
8098 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008099
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008100 *'termwintype'* *'twt'*
8101'termwintype' 'twt' string (default "")
8102 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008103 {only available when compiled with the |terminal|
8104 feature on MS-Windows}
8105 Specify the virtual console (pty) used when opening the terminal
8106 window.
8107
8108 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008109 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008110 "winpty" use winpty, fail if not supported
8111 "conpty" use |ConPTY|, fail if not supported
8112
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008113 |ConPTY| support depends on the platform. Windows 10 October 2018
8114 Update is the first version that supports ConPTY, however it is still
8115 considered unstable. ConPTY might become stable in the next release
8116 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008117 supported then you cannot open a terminal window.
8118
Bram Moolenaar071d4272004-06-13 20:20:40 +00008119 *'terse'* *'noterse'*
8120'terse' boolean (default off)
8121 global
8122 When set: Add 's' flag to 'shortmess' option (this makes the message
8123 for a search that hits the start or end of the file not being
8124 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8125 shortens a lot of messages}
8126
8127 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8128'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008130 This option is obsolete. Use 'fileformats'.
8131 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8132 set to the default value for the current system. When 'textauto' is
8133 reset, 'fileformats' is made empty.
8134 NOTE: This option is set to the Vi default value when 'compatible' is
8135 set and to the Vim default value when 'compatible' is reset.
8136
8137 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008138'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139 others: default off)
8140 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 This option is obsolete. Use 'fileformat'.
8142 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8143 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8144 "unix".
8145
8146 *'textwidth'* *'tw'*
8147'textwidth' 'tw' number (default 0)
8148 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149 Maximum width of text that is being inserted. A longer line will be
8150 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008151 this.
8152 'textwidth' is set to 0 when the 'paste' option is set and restored
8153 when 'paste' is reset.
8154 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008156 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 NOTE: This option is set to 0 when 'compatible' is set.
8158
8159 *'thesaurus'* *'tsr'*
8160'thesaurus' 'tsr' string (default "")
8161 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008163 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8164 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008165
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008166 This option is not used if 'thesaurusfunc' is set, either for the
8167 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008168
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008169 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008171 name. See |option-backslash| about using backslashes. The use of
8172 |:set+=| and |:set-=| is preferred when adding or removing directories
8173 from the list. This avoids problems when a future version uses
8174 another default. Backticks cannot be used in this option for security
8175 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008177 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008178'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008179 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008180 {not available when compiled without the |+eval|
8181 feature}
8182 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008183 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008184 The value can be the name of a function, a |lambda| or a |Funcref|.
8185 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008186
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008187 This option cannot be set from a |modeline| or in the |sandbox|, for
8188 security reasons.
8189
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8191'tildeop' 'top' boolean (default off)
8192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 When on: The tilde command "~" behaves like an operator.
8194 NOTE: This option is reset when 'compatible' is set.
8195
8196 *'timeout'* *'to'* *'notimeout'* *'noto'*
8197'timeout' 'to' boolean (default on)
8198 global
8199 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008200'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 These two options together determine the behavior when part of a
8203 mapped key sequence or keyboard code has been received:
8204
8205 'timeout' 'ttimeout' action ~
8206 off off do not time out
8207 on on or off time out on :mappings and key codes
8208 off on time out on key codes
8209
8210 If both options are off, Vim will wait until either the complete
8211 mapping or key sequence has been received, or it is clear that there
8212 is no mapping or key sequence for the received characters. For
8213 example: if you have mapped "vl" and Vim has received 'v', the next
8214 character is needed to see if the 'v' is followed by an 'l'.
8215 When one of the options is on, Vim will wait for about 1 second for
8216 the next character to arrive. After that the already received
8217 characters are interpreted as single characters. The waiting time can
8218 be changed with the 'timeoutlen' option.
8219 On slow terminals or very busy systems timing out may cause
8220 malfunctioning cursor keys. If both options are off, Vim waits
8221 forever after an entered <Esc> if there are key codes that start
8222 with <Esc>. You will have to type <Esc> twice. If you do not have
8223 problems with key codes, but would like to have :mapped key
8224 sequences not timing out in 1 second, set the 'ttimeout' option and
8225 reset the 'timeout' option.
8226
8227 NOTE: 'ttimeout' is reset when 'compatible' is set.
8228
8229 *'timeoutlen'* *'tm'*
8230'timeoutlen' 'tm' number (default 1000)
8231 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008232
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008234'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 The time in milliseconds that is waited for a key code or mapped key
8237 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8238 when part of a command has been typed.
8239 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8240 different timeout value for key codes is desired set 'ttimeoutlen' to
8241 a non-negative number.
8242
8243 ttimeoutlen mapping delay key code delay ~
8244 < 0 'timeoutlen' 'timeoutlen'
8245 >= 0 'timeoutlen' 'ttimeoutlen'
8246
8247 The timeout only happens when the 'timeout' and 'ttimeout' options
8248 tell so. A useful setting would be >
8249 :set timeout timeoutlen=3000 ttimeoutlen=100
8250< (time out on mapping after three seconds, time out on key codes after
8251 a tenth of a second).
8252
8253 *'title'* *'notitle'*
8254'title' boolean (default off, on when title can be restored)
8255 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 When on, the title of the window will be set to the value of
8257 'titlestring' (if it is not empty), or to:
8258 filename [+=-] (path) - VIM
8259 Where:
8260 filename the name of the file being edited
8261 - indicates the file cannot be modified, 'ma' off
8262 + indicates the file was modified
8263 = indicates the file is read-only
8264 =+ indicates the file is read-only and modified
8265 (path) is the path of the file being edited
8266 - VIM the server name |v:servername| or "VIM"
8267 Only works if the terminal supports setting window titles
8268 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008269 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8271 *X11*
8272 When Vim was compiled with HAVE_X11 defined, the original title will
8273 be restored if possible. The output of ":version" will include "+X11"
8274 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8275 works for the icon name |'icon'|.
8276 But: When Vim was started with the |-X| argument, restoring the title
8277 will not work (except in the GUI).
8278 If the title cannot be restored, it is set to the value of 'titleold'.
8279 You might want to restore the title outside of Vim then.
8280 When using an xterm from a remote machine you can use this command:
8281 rsh machine_name xterm -display $DISPLAY &
8282 then the WINDOWID environment variable should be inherited and the
8283 title of the window should change back to what it should be after
8284 exiting Vim.
8285
8286 *'titlelen'*
8287'titlelen' number (default 85)
8288 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008290 title. When the title is longer, only the end of the path name is
8291 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 Using a percentage makes this adapt to the width of the window. But
8293 it won't work perfectly, because the actual number of characters
8294 available also depends on the font used and other things in the title
8295 bar. When 'titlelen' is zero the full path is used. Otherwise,
8296 values from 1 to 30000 percent can be used.
8297 'titlelen' is also used for the 'titlestring' option.
8298
8299 *'titleold'*
8300'titleold' string (default "Thanks for flying Vim")
8301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 This option will be used for the window title when exiting Vim if the
8303 original title cannot be restored. Only happens if 'title' is on or
8304 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008305 This option cannot be set from a |modeline| or in the |sandbox|, for
8306 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 *'titlestring'*
8308'titlestring' string (default "")
8309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 When this option is not empty, it will be used for the title of the
8311 window. This happens only when the 'title' option is on.
8312 Only works if the terminal supports setting window titles (currently
8313 Amiga console, Win32 console, all GUI versions and terminals with a
8314 non-empty 't_ts' option).
8315 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008316 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008317
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 When this option contains printf-style '%' items, they will be
8319 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008320 This option cannot be set in a modeline when 'modelineexpr' is off.
8321
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008323 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8325< The value of 'titlelen' is used to align items in the middle or right
8326 of the available space.
8327 Some people prefer to have the file name first: >
8328 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8329< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008330 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 separating space only when needed.
8332 NOTE: Use of special characters in 'titlestring' may cause the display
8333 to be garbled (e.g., when it contains a CR or NL character).
8334 {not available when compiled without the |+statusline| feature}
8335
8336 *'toolbar'* *'tb'*
8337'toolbar' 'tb' string (default "icons,tooltips")
8338 global
8339 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8340 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008341 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 possible values are:
8343 icons Toolbar buttons are shown with icons.
8344 text Toolbar buttons shown with text.
8345 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008346 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 tooltips Tooltips are active for toolbar buttons.
8348 Tooltips refer to the popup help text which appears after the mouse
8349 cursor is placed over a toolbar button for a brief moment.
8350
8351 If you want the toolbar to be shown with icons as well as text, do the
8352 following: >
8353 :set tb=icons,text
8354< Motif and Athena cannot display icons and text at the same time. They
8355 will show icons if both are requested.
8356
8357 If none of the strings specified in 'toolbar' are valid or if
8358 'toolbar' is empty, this option is ignored. If you want to disable
8359 the toolbar, you need to set the 'guioptions' option. For example: >
8360 :set guioptions-=T
8361< Also see |gui-toolbar|.
8362
8363 *'toolbariconsize'* *'tbis'*
8364'toolbariconsize' 'tbis' string (default "small")
8365 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008366 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008368 tiny Use tiny icons.
8369 small Use small icons (default).
8370 medium Use medium-sized icons.
8371 large Use large icons.
8372 huge Use even larger icons.
8373 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008375 the current theme. Common dimensions are giant=48x48, huge=32x32,
8376 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377
8378 If 'toolbariconsize' is empty, the global default size as determined
8379 by user preferences or the current theme is used.
8380
8381 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8382'ttybuiltin' 'tbi' boolean (default on)
8383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 When on, the builtin termcaps are searched before the external ones.
8385 When off the builtin termcaps are searched after the external ones.
8386 When this option is changed, you should set the 'term' option next for
8387 the change to take effect, for example: >
8388 :set notbi term=$TERM
8389< See also |termcap|.
8390 Rationale: The default for this option is "on", because the builtin
8391 termcap entries are generally better (many systems contain faulty
8392 xterm entries...).
8393
8394 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8395'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8396 sun-cmd, screen, rxvt, dtterm or
8397 iris-ansi; also on when running Vim in
8398 a DOS console)
8399 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 Indicates a fast terminal connection. More characters will be sent to
8401 the screen for redrawing, instead of using insert/delete line
8402 commands. Improves smoothness of redrawing when there are multiple
8403 windows and the terminal does not support a scrolling region.
8404 Also enables the extra writing of characters at the end of each screen
8405 line for lines that wrap. This helps when using copy/paste with the
8406 mouse in an xterm and other terminals.
8407
8408 *'ttymouse'* *'ttym'*
8409'ttymouse' 'ttym' string (default depends on 'term')
8410 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 {only in Unix and VMS, doesn't work in the GUI; not
8412 available when compiled without |+mouse|}
8413 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008414 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 *xterm-mouse*
8416 xterm xterm-like mouse handling. The mouse generates
8417 "<Esc>[Mscr", where "scr" is three bytes:
8418 "s" = button state
8419 "c" = column plus 33
8420 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008421 This only works up to 223 columns! See "dec",
8422 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 xterm2 Works like "xterm", but with the xterm reporting the
8424 mouse position while the mouse is dragged. This works
8425 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008426 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427 work. See below for how Vim detects this
8428 automatically.
8429 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008430 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008432 for the row and column. No other mouse events are
8433 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 *dec-mouse*
8435 dec DEC terminal mouse handling. The mouse generates a
8436 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008437 This is also available for an Xterm, if it was
8438 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008439 *jsbterm-mouse*
8440 jsbterm JSB term mouse handling.
8441 *pterm-mouse*
8442 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008443 *urxvt-mouse*
8444 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008445 The mouse works only if the terminal supports this
8446 encoding style, but it does not have 223 columns limit
8447 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008448 *sgr-mouse*
8449 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008450 mouse reporting. The mouse works even in columns
8451 beyond 223. This option is backward compatible with
8452 "xterm2" because it can also decode "xterm2" style
8453 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454
8455 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008456 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8457 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8459 recognized, if enabled at compile time. DEC terminal mouse codes
8460 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008461 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8462 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008464 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8465 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8466 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008467 Additionally, if vim is compiled with the |+termresponse| feature and
8468 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008469 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008470 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008471 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8472 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8473 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008474 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8475 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 :set t_RV=
8477<
8478 *'ttyscroll'* *'tsl'*
8479'ttyscroll' 'tsl' number (default 999)
8480 global
8481 Maximum number of lines to scroll the screen. If there are more lines
8482 to scroll the window is redrawn. For terminals where scrolling is
8483 very slow and redrawing is not slow this can be set to a small number,
8484 e.g., 3, to speed up displaying.
8485
8486 *'ttytype'* *'tty'*
8487'ttytype' 'tty' string (default from $TERM)
8488 global
8489 Alias for 'term', see above.
8490
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008491 *'undodir'* *'udir'*
8492'undodir' 'udir' string (default ".")
8493 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008494 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008495 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008496 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008497 "." means using the directory of the file. The undo file name for
8498 "file.txt" is ".file.txt.un~".
8499 For other directories the file name is the full path of the edited
8500 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008501 When writing: The first directory that exists is used. "." always
8502 works, no directories after "." will be used for writing.
8503 When reading all entries are tried to find an undo file. The first
8504 undo file that exists is used. When it cannot be read an error is
8505 given, no further entry is used.
8506 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008507 This option cannot be set from a |modeline| or in the |sandbox|, for
8508 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008509
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008510 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008511'undofile' 'udf' boolean (default off)
8512 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008513 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008514 When on, Vim automatically saves undo history to an undo file when
8515 writing a buffer to a file, and restores undo history from the same
8516 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008517 The directory where the undo file is stored is specified by 'undodir'.
8518 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008519 The undo file is not read when 'undoreload' causes the buffer from
8520 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008521 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008522 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008523
Bram Moolenaar071d4272004-06-13 20:20:40 +00008524 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008525'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008526 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008528 is kept in memory, higher numbers will cause more memory to be used.
8529 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8531 itself: >
8532 set ul=0
8533< But you can also get Vi compatibility by including the 'u' flag in
8534 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008535 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008536 Set to -1 for no undo at all. You might want to do this only for the
8537 current buffer: >
8538 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008540
8541 The local value is set to -123456 when the global value is to be used.
8542
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008543 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008545 *'undoreload'* *'ur'*
8546'undoreload' 'ur' number (default 10000)
8547 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008548 Save the whole buffer for undo when reloading it. This applies to the
8549 ":e!" command and reloading for when the buffer changed outside of
8550 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008551 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008552 of lines is smaller than the value of this option.
8553 Set this option to zero to disable undo for a reload.
8554
8555 When saving undo for a reload, any undo file is not read.
8556
8557 Note that this causes the whole buffer to be stored in memory. Set
8558 this option to a lower value if you run out of memory.
8559
Bram Moolenaar071d4272004-06-13 20:20:40 +00008560 *'updatecount'* *'uc'*
8561'updatecount' 'uc' number (default: 200)
8562 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 After typing this many characters the swap file will be written to
8564 disk. When zero, no swap file will be created at all (see chapter on
8565 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8566 Vim with the "-n" option, see |startup|. When editing in readonly
8567 mode this option will be initialized to 10000.
8568 The swapfile can be disabled per buffer with |'swapfile'|.
8569 When 'updatecount' is set from zero to non-zero, swap files are
8570 created for all buffers that have 'swapfile' set. When 'updatecount'
8571 is set to zero, existing swap files are not deleted.
8572 Also see |'swapsync'|.
8573 This option has no meaning in buffers where |'buftype'| is "nofile"
8574 or "nowrite".
8575
8576 *'updatetime'* *'ut'*
8577'updatetime' 'ut' number (default 4000)
8578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 If this many milliseconds nothing is typed the swap file will be
8580 written to disk (see |crash-recovery|). Also used for the
8581 |CursorHold| autocommand event.
8582
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008583 *'varsofttabstop'* *'vsts'*
8584'varsofttabstop' 'vsts' string (default "")
8585 local to buffer
8586 {only available when compiled with the |+vartabs|
8587 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008588 A list of the number of spaces that a <Tab> counts for while editing,
8589 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8590 width <Tab>s are being inserted, while in fact a mixture of spaces
8591 and <Tab>s is used. Tab widths are separated with commas, with the
8592 final value applying to all subsequent tabs.
8593
8594 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008595 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008596 to use the following: >
8597 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008598< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8599 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008600
8601 Note that the value of |'softtabstop'| will be ignored while
8602 'varsofttabstop' is set.
8603
8604 *'vartabstop'* *'vts'*
8605'vartabstop' 'vts' string (default "")
8606 local to buffer
8607 {only available when compiled with the |+vartabs|
8608 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008609 A list of the number of spaces that a <Tab> in the file counts for,
8610 separated by commas. Each value corresponds to one tab, with the
8611 final value applying to all subsequent tabs. For example: >
8612 :set vartabstop=4,20,10,8
8613< This will make the first tab 4 spaces wide, the second 20 spaces,
8614 the third 10 spaces, and all following tabs 8 spaces.
8615
8616 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8617 is set.
8618
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 *'verbose'* *'vbs'*
8620'verbose' 'vbs' number (default 0)
8621 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 When bigger than zero, Vim will give messages about what it is doing.
8623 Currently, these messages are given:
8624 >= 1 When the viminfo file is read or written.
8625 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008626 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008627 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 >= 8 Files for which a group of autocommands is executed.
8629 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008630 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 >= 12 Every executed function.
8632 >= 13 When an exception is thrown, caught, finished, or discarded.
8633 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008634 >= 15 Every executed Ex command from a script (truncated at 200
8635 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008636 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637
8638 This option can also be set with the "-V" argument. See |-V|.
8639 This option is also set by the |:verbose| command.
8640
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008641 When the 'verbosefile' option is set then the verbose messages are not
8642 displayed.
8643
8644 *'verbosefile'* *'vfile'*
8645'verbosefile' 'vfile' string (default empty)
8646 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008647 When not empty all messages are written in a file with this name.
8648 When the file exists messages are appended.
8649 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008650 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008651 Setting 'verbosefile' to a new value is like making it empty first.
8652 The difference with |:redir| is that verbose messages are not
8653 displayed when 'verbosefile' is set.
8654
Bram Moolenaar071d4272004-06-13 20:20:40 +00008655 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008656'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 "$VIM/vimfiles/view",
8658 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008659 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008660 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008662 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 feature}
8664 Name of the directory where to store files for |:mkview|.
8665 This option cannot be set from a |modeline| or in the |sandbox|, for
8666 security reasons.
8667
8668 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008669'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008671 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 feature}
8673 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008674 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675 word save and restore ~
8676 cursor cursor position in file and in window
8677 folds manually created folds, opened/closed folds and local
8678 fold options
8679 options options and mappings local to a window or buffer (not
8680 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008681 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 slash backslashes in file names replaced with forward
8683 slashes
8684 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008685 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008686 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008687
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008688 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008690 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691
8692 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008693'viminfo' 'vi' string (Vi default: "", Vim default for
8694 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008695 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8696 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008698 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 feature}
8700 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008701 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8702 "NONE".
8703 The string should be a comma separated list of parameters, each
8704 consisting of a single character identifying the particular parameter,
8705 followed by a number or string which specifies the value of that
8706 parameter. If a particular character is left out, then the default
8707 value is used for that parameter. The following is a list of the
8708 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008710 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008711 ! When included, save and restore global variables that start
8712 with an uppercase letter, and don't contain a lowercase
8713 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008714 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008715 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008716 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 " Maximum number of lines saved for each register. Old name of
8718 the '<' item, with the disadvantage that you need to put a
8719 backslash before the ", otherwise it will be recognized as the
8720 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008721 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 % When included, save and restore the buffer list. If Vim is
8723 started with a file name argument, the buffer list is not
8724 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008725 buffer list is restored from the viminfo file. Quickfix
8726 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8727 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008728 When followed by a number, the number specifies the maximum
8729 number of buffers that are stored. Without a number all
8730 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008731 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 ' Maximum number of previously edited files for which the marks
8733 are remembered. This parameter must always be included when
8734 'viminfo' is non-empty.
8735 Including this item also means that the |jumplist| and the
8736 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008737 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008739 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 patterns are also saved. When not included, the value of
8741 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008742 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008744 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008745 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 < Maximum number of lines saved for each register. If zero then
8747 registers are not saved. When not included, all lines are
8748 saved. '"' is the old name for this item.
8749 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008750 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008752 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008753 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 c When included, convert the text in the viminfo file from the
8755 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008756 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008757 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 f Whether file marks need to be stored. If zero, file marks ('0
8759 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008760 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008762 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 h Disable the effect of 'hlsearch' when loading the viminfo
8764 file. When not included, it depends on whether ":nohlsearch"
8765 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008766 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008768 the 'n'. Must be at the end of the option! If the
8769 'viminfofile' option is set, that file name overrides the one
8770 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008771 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008772 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 r Removable media. The argument is a string (up to the next
8774 ','). This parameter can be given several times. Each
8775 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008776 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8778 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8779 ignored. Maximum length of each 'r' argument is 50
8780 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008781 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 s Maximum size of an item in Kbyte. If zero then registers are
8783 not saved. Currently only applies to registers. The default
8784 "s10" will exclude registers with more than 10 Kbyte of text.
8785 Also see the '<' item above: line count limit.
8786
8787 Example: >
8788 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8789<
8790 '50 Marks will be remembered for the last 50 files you
8791 edited.
8792 <1000 Contents of registers (up to 1000 lines each) will be
8793 remembered.
8794 s100 Registers with more than 100 Kbyte text are skipped.
8795 :0 Command-line history will not be saved.
8796 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8797 no / Since '/' is not specified, the default will be used,
8798 that is, save all of the search history, and also the
8799 previous search and substitute patterns.
8800 no % The buffer list will not be saved nor read back.
8801 no h 'hlsearch' highlighting will be restored.
8802
8803 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8804 load the contents of the file, this is not done automatically.
8805
8806 This option cannot be set from a |modeline| or in the |sandbox|, for
8807 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008808 NOTE: This option is set to the Vim default value when 'compatible'
8809 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008811 *'viminfofile'* *'vif'*
8812'viminfofile' 'vif' string (default: "")
8813 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008814 {not available when compiled without the |+viminfo|
8815 feature}
8816 When non-empty, overrides the file name used for viminfo.
8817 When equal to "NONE" no viminfo file will be read or written.
8818 This option can be set with the |-i| command line flag. The |--clean|
8819 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008820 This option cannot be set from a |modeline| or in the |sandbox|, for
8821 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008822
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 *'virtualedit'* *'ve'*
8824'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008825 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 A comma separated list of these words:
8827 block Allow virtual editing in Visual block mode.
8828 insert Allow virtual editing in Insert mode.
8829 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008830 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008831 none When used as the local value, do not allow virtual
8832 editing even when the global value is set. When used
8833 as the global value, "none" is the same as "".
8834 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008835
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008837 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 of the line. Useful for selecting a rectangle in Visual mode and
8839 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008840 "onemore" is not the same, it will only allow moving the cursor just
8841 after the last character of the line. This makes some commands more
8842 consistent. Previously the cursor was always past the end of the line
8843 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008844 break some plugins or Vim scripts. For example because |l| can move
8845 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008846 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008847 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008848 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008849 It doesn't make sense to combine "all" with "onemore", but you will
8850 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008851 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008852 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853
8854 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8855'visualbell' 'vb' boolean (default off)
8856 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008857 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008859 use: >
8860 :set vb t_vb=
8861< If you want a short flash, you can use this on many terminals: >
8862 :set vb t_vb=[?5h$<100>[?5l
8863< Here $<100> specifies the time, you can use a smaller or bigger value
8864 to get a shorter or longer flash.
8865
8866 Note: Vim will limit the bell to once per half a second. This avoids
8867 having to wait for the flashing to finish when there are lots of
8868 bells, e.g. on key repeat. This also happens without 'visualbell'
8869 set.
8870
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8872 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8873 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008874
8875 Note: When the GUI starts, 't_vb' is reset to its default value. You
8876 might want to set it again in your |gvimrc|.
8877
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 Does not work on the Amiga, you always get a screen flash.
8879 Also see 'errorbells'.
8880
8881 *'warn'* *'nowarn'*
8882'warn' boolean (default on)
8883 global
8884 Give a warning message when a shell command is used while the buffer
8885 has been changed.
8886
8887 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8888'weirdinvert' 'wiv' boolean (default off)
8889 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008890 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 It is provided for backwards compatibility with version 4.x.
8892 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8893 vice versa. Has no effect when the GUI is running.
8894
8895 *'whichwrap'* *'ww'*
8896'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 Allow specified keys that move the cursor left/right to move to the
8899 previous/next line when the cursor is on the first/last character in
8900 the line. Concatenate characters to allow this for these keys:
8901 char key mode ~
8902 b <BS> Normal and Visual
8903 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008904 h "h" Normal and Visual (not recommended)
8905 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 < <Left> Normal and Visual
8907 > <Right> Normal and Visual
8908 ~ "~" Normal
8909 [ <Left> Insert and Replace
8910 ] <Right> Insert and Replace
8911 For example: >
8912 :set ww=<,>,[,]
8913< allows wrap only when cursor keys are used.
8914 When the movement keys are used in combination with a delete or change
8915 operator, the <EOL> also counts for a character. This makes "3h"
8916 different from "3dh" when the cursor crosses the end of a line. This
8917 is also true for "x" and "X", because they do the same as "dl" and
8918 "dh". If you use this, you may also want to use the mapping
8919 ":map <BS> X" to make backspace delete the character in front of the
8920 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008921 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008922 line (not an empty line) then it will not move to the next line. This
8923 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 NOTE: This option is set to the Vi default value when 'compatible' is
8925 set and to the Vim default value when 'compatible' is reset.
8926
8927 *'wildchar'* *'wc'*
8928'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 Character you have to type to start wildcard expansion in the
8931 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008932 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 The character is not recognized when used inside a macro. See
8934 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008935 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008936 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008937 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938< NOTE: This option is set to the Vi default value when 'compatible' is
8939 set and to the Vim default value when 'compatible' is reset.
8940
8941 *'wildcharm'* *'wcm'*
8942'wildcharm' 'wcm' number (default: none (0))
8943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008945 recognized when used inside a macro. You can find "spare" command-line
8946 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008947 you'll never actually type 'wildcharm', just use it in mappings that
8948 automatically invoke completion mode, e.g.: >
8949 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008950 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008951< Then after typing :ss you can use CTRL-P & CTRL-N.
8952
8953 *'wildignore'* *'wig'*
8954'wildignore' 'wig' string (default "")
8955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956 {not available when compiled without the |+wildignore|
8957 feature}
8958 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008959 patterns is ignored when expanding |wildcards|, completing file or
8960 directory names, and influences the result of |expand()|, |glob()| and
8961 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008962 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8963 Also see 'suffixes'.
8964 Example: >
8965 :set wildignore=*.o,*.obj
8966< The use of |:set+=| and |:set-=| is preferred when adding or removing
8967 a pattern from the list. This avoids problems when a future version
8968 uses another default.
8969
Bram Moolenaar94950a92010-12-02 16:01:29 +01008970
Bram Moolenaar81af9252010-12-10 20:35:50 +01008971 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008972'wildignorecase' 'wic' boolean (default off)
8973 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008974 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008975 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008976 Does not apply when the shell is used to expand wildcards, which
8977 happens when there are special characters.
8978
8979
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008981'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008982 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 {not available if compiled without the |+wildmenu|
8984 feature}
8985 When 'wildmenu' is on, command-line completion operates in an enhanced
8986 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8987 the possible matches are shown just above the command line, with the
8988 first match highlighted (overwriting the status line, if there is
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00008989 one). This is the behavior without "pum" in 'wildoptions.
8990 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8992 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8993 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008994 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 If there are more matches than can fit in the line, a ">" is shown on
8996 the right and/or a "<" is shown on the left. The status line scrolls
8997 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00008998 When 'wildoptions' contains "pum", then the completion matches are
8999 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009000 The "wildmenu" mode is abandoned when a key is hit that is not used
9001 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009002 While the "wildmenu" is active, not using the popup menu, the
9003 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004
9005 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9006 <Down> - in filename/menu name completion: move into a
9007 subdirectory or submenu.
9008 <CR> - in menu completion, when the cursor is just after a
9009 dot: move into a submenu.
9010 <Up> - in filename/menu name completion: move up into
9011 parent directory or parent menu.
9012
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009013 When using the popup menu for command line completion, the following
9014 keys have special meanings:
9015 <Down> - select next match (like CTRL-N)
9016 <Left> - in filename/menu name completion: move up into
9017 parent directory or parent menu.
9018 <Right> - in filename/menu name completion: move into a
9019 subdirectory or submenu.
9020 <Up> - select previous match (like CTRL-P)
9021 CTRL-E - end completion, go back to what was there before
9022 selecting a match.
9023 CTRL-N - go to the next entry
9024 CTRL-P - go to the previous entry
9025 CTRL-Y - accept the currently selected match and stop
9026 completion.
9027
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 This makes the menus accessible from the console |console-menus|.
9029
9030 If you prefer the <Left> and <Right> keys to move the cursor instead
9031 of selecting a different match, use this: >
9032 :cnoremap <Left> <Space><BS><Left>
9033 :cnoremap <Right> <Space><BS><Right>
9034<
9035 The "WildMenu" highlighting is used for displaying the current match
9036 |hl-WildMenu|.
9037
9038 *'wildmode'* *'wim'*
9039'wildmode' 'wim' string (Vim default: "full")
9040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009041 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009042 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009043 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009044 first part specifies the behavior for the first use of 'wildchar',
9045 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009046
9047 Each part consists of a colon separated list consisting of the
9048 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009049 "" Complete only the first match.
9050 "full" Complete the next full match. After the last match,
9051 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009052 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 "longest" Complete till longest common string. If this doesn't
9054 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009055 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009056 "lastused" When completing buffer names and more than one buffer
9057 matches, sort buffers by time last used (other than
9058 the current buffer).
9059 When there is only a single match, it is fully completed in all cases.
9060
9061 Examples of useful colon-separated values:
9062 "longest:full" Like "longest", but also start 'wildmenu' if it is
9063 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 "list:full" When more than one match, list all matches and
9065 complete first match.
9066 "list:longest" When more than one match, list all matches and
9067 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009068 "list:lastused" When more than one buffer matches, list all matches
9069 and sort buffers by time last used (other than the
9070 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009071
9072 Examples: >
9073 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009074< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 :set wildmode=longest,full
9076< Complete longest common string, then each full match >
9077 :set wildmode=list:full
9078< List all matches and complete each full match >
9079 :set wildmode=list,full
9080< List all matches without completing, then each full match >
9081 :set wildmode=longest,list
9082< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009083 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009084
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009085 *'wildoptions'* *'wop'*
9086'wildoptions' 'wop' string (default "")
9087 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009088 {not available when compiled without the |+wildignore|
9089 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009090 A list of words that change how |cmdline-completion| is done.
9091 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009092 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009093 this value is specified, wildcard expansion will not
9094 be used for completion. The matches will be sorted by
9095 the "best match" rather than alphabetically sorted.
9096 This will find more matches than the wildcard
9097 expansion. Currently fuzzy matching based completion
9098 is not supported for file and directory names and
9099 instead wildcard expansion is used.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009100 pum Display the completion matches using the popupmenu
9101 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009102 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009103 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009104 is displayed per line. Often used tag kinds are:
9105 d #define
9106 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009107
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 *'winaltkeys'* *'wak'*
9109'winaltkeys' 'wak' string (default "menu")
9110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009111 {only used in Win32, Motif, GTK and Photon GUI}
9112 Some GUI versions allow the access to menu entries by using the ALT
9113 key in combination with a character that appears underlined in the
9114 menu. This conflicts with the use of the ALT key for mappings and
9115 entering special characters. This option tells what to do:
9116 no Don't use ALT keys for menus. ALT key combinations can be
9117 mapped, but there is no automatic handling. This can then be
9118 done with the |:simalt| command.
9119 yes ALT key handling is done by the windowing system. ALT key
9120 combinations cannot be mapped.
9121 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009122 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123 keys can be mapped.
9124 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9125 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009126 This option is not used for <F10>; on Win32 and with GTK <F10> will
9127 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009128
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009129 *'wincolor'* *'wcr'*
9130'wincolor' 'wcr' string (default empty)
9131 local to window
9132 Highlight group name to use for this window instead of the Normal
9133 color |hl-Normal|.
9134
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009135 *'window'* *'wi'*
9136'window' 'wi' number (default screen height - 1)
9137 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009138 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9139 window and the value is smaller than 'lines' minus one. The screen
9140 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009141 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9142 in a much smarter way, taking care of wrapping lines.
9143 When resizing the Vim window, the value is smaller than 1 or more than
9144 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009145 Note: Do not confuse this with the height of the Vim window, use
9146 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009147
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148 *'winheight'* *'wh'* *E591*
9149'winheight' 'wh' number (default 1)
9150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009151 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009152 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009153 focus goes to a window that is smaller, its size is increased, at the
9154 cost of the height of other windows.
9155 Set 'winheight' to a small number for normal editing.
9156 Set it to 999 to make the current window fill most of the screen.
9157 Other windows will be only 'winminheight' high. This has the drawback
9158 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9159 to create only two windows, set the option after startup is done,
9160 using the |VimEnter| event: >
9161 au VimEnter * set winheight=999
9162< Minimum value is 1.
9163 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009164 height of the current window.
9165 'winheight' applies to the current window. Use 'winminheight' to set
9166 the minimal height for other windows.
9167
9168 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9169'winfixheight' 'wfh' boolean (default off)
9170 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009171 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009172 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9173 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009174 The height may be changed anyway when running out of room.
9175
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009176 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9177'winfixwidth' 'wfw' boolean (default off)
9178 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009179 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009180 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009181 The width may be changed anyway when running out of room.
9182
Bram Moolenaar071d4272004-06-13 20:20:40 +00009183 *'winminheight'* *'wmh'*
9184'winminheight' 'wmh' number (default 1)
9185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009186 The minimal height of a window, when it's not the current window.
9187 This is a hard minimum, windows will never become smaller.
9188 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9189 status bar) if necessary. They will return to at least one line when
9190 they become active (since the cursor has to have somewhere to go.)
9191 Use 'winheight' to set the minimal height of the current window.
9192 This option is only checked when making a window smaller. Don't use a
9193 large number, it will cause errors when opening more than a few
9194 windows. A value of 0 to 3 is reasonable.
9195
9196 *'winminwidth'* *'wmw'*
9197'winminwidth' 'wmw' number (default 1)
9198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009199 The minimal width of a window, when it's not the current window.
9200 This is a hard minimum, windows will never become smaller.
9201 When set to zero, windows may be "squashed" to zero columns (i.e. just
9202 a vertical separator) if necessary. They will return to at least one
9203 line when they become active (since the cursor has to have somewhere
9204 to go.)
9205 Use 'winwidth' to set the minimal width of the current window.
9206 This option is only checked when making a window smaller. Don't use a
9207 large number, it will cause errors when opening more than a few
9208 windows. A value of 0 to 12 is reasonable.
9209
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009210 *'winptydll'*
9211'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9212 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009213 {only available when compiled with the |terminal|
9214 feature on MS-Windows}
9215 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009216 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009217 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009218 a fallback.
9219 Environment variables are expanded |:set_env|.
9220 This option cannot be set from a |modeline| or in the |sandbox|, for
9221 security reasons.
9222
Bram Moolenaar071d4272004-06-13 20:20:40 +00009223 *'winwidth'* *'wiw'* *E592*
9224'winwidth' 'wiw' number (default 20)
9225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009226 Minimal number of columns for the current window. This is not a hard
9227 minimum, Vim will use fewer columns if there is not enough room. If
9228 the current window is smaller, its size is increased, at the cost of
9229 the width of other windows. Set it to 999 to make the current window
9230 always fill the screen. Set it to a small number for normal editing.
9231 The width is not adjusted after one of the commands to change the
9232 width of the current window.
9233 'winwidth' applies to the current window. Use 'winminwidth' to set
9234 the minimal width for other windows.
9235
9236 *'wrap'* *'nowrap'*
9237'wrap' boolean (default on)
9238 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239 This option changes how text is displayed. It doesn't change the text
9240 in the buffer, see 'textwidth' for that.
9241 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009242 displaying continues on the next line. When off lines will not wrap
9243 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009244 moved to a part that is not shown, the screen will scroll
9245 horizontally.
9246 The line will be broken in the middle of a word if necessary. See
9247 'linebreak' to get the break at a word boundary.
9248 To make scrolling horizontally a bit more useful, try this: >
9249 :set sidescroll=5
9250 :set listchars+=precedes:<,extends:>
9251< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009252 This option can't be set from a |modeline| when the 'diff' option is
9253 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009254
9255 *'wrapmargin'* *'wm'*
9256'wrapmargin' 'wm' number (default 0)
9257 local to buffer
9258 Number of characters from the right window border where wrapping
9259 starts. When typing text beyond this limit, an <EOL> will be inserted
9260 and inserting continues on the next line.
9261 Options that add a margin, such as 'number' and 'foldcolumn', cause
9262 the text width to be further reduced. This is Vi compatible.
9263 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009264 This option is set to 0 when 'paste' is set and restored when 'paste'
9265 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009266 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009267
9268 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9269'wrapscan' 'ws' boolean (default on) *E384* *E385*
9270 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009271 Searches wrap around the end of the file. Also applies to |]s| and
9272 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009273
9274 *'write'* *'nowrite'*
9275'write' boolean (default on)
9276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009277 Allows writing files. When not set, writing a file is not allowed.
9278 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009279 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 argument. Filtering text is still possible, even though this requires
9281 writing a temporary file.
9282
9283 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9284'writeany' 'wa' boolean (default off)
9285 global
9286 Allows writing to any file with no need for "!" override.
9287
9288 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9289'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9290 otherwise)
9291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009292 Make a backup before overwriting a file. The backup is removed after
9293 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009294 also on.
9295 WARNING: Switching this option off means that when Vim fails to write
9296 your buffer correctly and then, for whatever reason, Vim exits, you
9297 lose both the original file and what you were writing. Only reset
9298 this option if your file system is almost full and it makes the write
9299 fail (and make sure not to exit Vim until the write was successful).
9300 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009301 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009302 Depending on 'backupcopy' the backup is a new file or the original
9303 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009304 NOTE: This option is set to the default value when 'compatible' is
9305 set.
9306
9307 *'writedelay'* *'wd'*
9308'writedelay' 'wd' number (default 0)
9309 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009310 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009311 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009312 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009314 *'xtermcodes'* *'noxtermcodes'*
9315'xtermcodes' boolean (default on)
9316 global
9317 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009318 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009319 key codes and number of colors from the terminal. This takes care of
9320 various configuration options of the terminal that cannot be obtained
9321 from the termlib/terminfo entry, see |xterm-codes|.
9322 A side effect may be that t_Co changes and Vim will redraw the
9323 display.
9324
9325
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009326 vim:tw=78:ts=8:noet:ft=help:norl: