blob: ddd5af08edf6d7de8a6467446877c7e3933b539e [file] [log] [blame]
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001*options.txt* For Vim version 8.2. Last change: 2022 Apr 07
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
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010090 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 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
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100100 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101 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
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001022 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
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
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001046 The "auto" value is the middle way: When Vim sees that renaming the
1047 file is possible without side effects (the attributes can be passed on
1048 and the file is not a link) that is used. When problems are expected,
1049 a 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
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001068 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
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001074 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 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 Moolenaarcbaff5e2022-04-08 17:45:08 +01001141 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 Moolenaarcbaff5e2022-04-08 17:45:08 +01001405 {only for Motif, 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
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001419 hide hide the buffer (don't unload it), even if 'hidden' is
1420 not set
1421 unload unload the buffer, even if 'hidden' is set; the
1422 |:hide| command will also unlod the buffer
1423 delete delete the buffer from the buffer list, even if
1424 'hidden' is set; the |:hide| command will also delete
1425 the buffer, making it behave like |:bdelete|
1426 wipe wipe the buffer from the buffer list, even if
1427 'hidden' is set; the |:hide| command will also wipe
1428 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429
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
Tom Praschan3506cf32022-04-07 12:39:08 +01001664 *'cinscopedecls'* *'cinsd'*
1665'cinscopedecls' 'cinsd' string (default "public,protected,private")
1666 local to buffer
1667 {not available when compiled without the |+cindent|
1668 feature}
1669 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1670 Useful e.g. for working with the Qt framework that defines additional
1671 scope declarations "signals", "public slots" and "private slots": >
1672 set cinscopedecls+=signals,public\ slots,private\ slots
1673
1674< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1676 for X-windows, "" otherwise)
1677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 {only in GUI versions or when the |+xterm_clipboard|
1679 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001680 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001681 Note: if one of the items is "exclude:", then you can't add an item
1682 after that. Therefore do append an item with += but use ^= to
1683 prepend, e.g.: >
1684 set clipboard^=unnamed
1685< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001687 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 unnamed When included, Vim will use the clipboard register '*'
1689 for all yank, delete, change and put operations which
1690 would normally go to the unnamed register. When a
1691 register is explicitly specified, it will always be
1692 used regardless of whether "unnamed" is in 'clipboard'
1693 or not. The clipboard register can always be
1694 explicitly accessed using the "* notation. Also see
1695 |gui-clipboard|.
1696
Bram Moolenaar30b65812012-07-12 22:01:11 +02001697 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001698 unnamedplus A variant of the "unnamed" flag which uses the
1699 clipboard register '+' (|quoteplus|) instead of
1700 register '*' for all yank, delete, change and put
1701 operations which would normally go to the unnamed
1702 register. When "unnamed" is also included to the
1703 option, yank operations (but not delete, change or
1704 put) will additionally copy the text into register
1705 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001706 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001707 Availability can be checked with: >
1708 if has('unnamedplus')
1709<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001710 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 autoselect Works like the 'a' flag in 'guioptions': If present,
1712 then whenever Visual mode is started, or the Visual
1713 area extended, Vim tries to become the owner of the
1714 windowing system's global selection or put the
1715 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001716 register "*. See |'go-a'| and |quotestar| for details.
1717 When the GUI is active, the 'a' flag in 'guioptions'
1718 is used, when the GUI is not active, this "autoselect"
1719 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 Also applies to the modeless selection.
1721
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001722 *clipboard-autoselectplus*
1723 autoselectplus Like "autoselect" but using the + register instead of
1724 the * register. Compare to the 'P' flag in
1725 'guioptions'.
1726
1727 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 autoselectml Like "autoselect", but for the modeless selection
1729 only. Compare to the 'A' flag in 'guioptions'.
1730
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001731 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001732 html When the clipboard contains HTML, use this when
1733 pasting. When putting text on the clipboard, mark it
1734 as HTML. This works to copy rendered HTML from
1735 Firefox, paste it as raw HTML in Vim, select the HTML
1736 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001737 You probably want to add this only temporarily,
1738 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001739 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001740
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001741 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 exclude:{pattern}
1743 Defines a pattern that is matched against the name of
1744 the terminal 'term'. If there is a match, no
1745 connection will be made to the X server. This is
1746 useful in this situation:
1747 - Running Vim in a console.
1748 - $DISPLAY is set to start applications on another
1749 display.
1750 - You do not want to connect to the X server in the
1751 console, but do want this in a terminal emulator.
1752 To never connect to the X server use: >
1753 exclude:.*
1754< This has the same effect as using the |-X| argument.
1755 Note that when there is no connection to the X server
1756 the window title won't be restored and the clipboard
1757 cannot be accessed.
1758 The value of 'magic' is ignored, {pattern} is
1759 interpreted as if 'magic' was on.
1760 The rest of the option value will be used for
1761 {pattern}, this must be the last entry.
1762
1763 *'cmdheight'* *'ch'*
1764'cmdheight' 'ch' number (default 1)
1765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 Number of screen lines to use for the command-line. Helps avoiding
1767 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001768 The value of this option is stored with the tab page, so that each tab
1769 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770
1771 *'cmdwinheight'* *'cwh'*
1772'cmdwinheight' 'cwh' number (default 7)
1773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 Number of screen lines to use for the command-line window. |cmdwin|
1775
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001776 *'colorcolumn'* *'cc'*
1777'colorcolumn' 'cc' string (default "")
1778 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001779 {not available when compiled without the |+syntax|
1780 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001781 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001782 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1783 text. Will make screen redrawing slower.
1784 The screen column can be an absolute number, or a number preceded with
1785 '+' or '-', which is added to or subtracted from 'textwidth'. >
1786
1787 :set cc=+1 " highlight column after 'textwidth'
1788 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1789 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1790<
1791 When 'textwidth' is zero then the items with '-' and '+' are not used.
1792 A maximum of 256 columns are highlighted.
1793
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 *'columns'* *'co'* *E594*
1795'columns' 'co' number (default 80 or terminal width)
1796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001798 initialization and does not have to be set by hand. Also see
1799 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 When Vim is running in the GUI or in a resizable window, setting this
1801 option will cause the window size to be changed. When you only want
1802 to use the size for the GUI, put the command in your |gvimrc| file.
1803 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001804 number of columns of the display, the display may be messed up. For
1805 the GUI it is always possible and Vim limits the number of columns to
1806 what fits on the screen. You can use this command to get the widest
1807 window possible: >
1808 :set columns=9999
1809< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810
1811 *'comments'* *'com'* *E524* *E525*
1812'comments' 'com' string (default
1813 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1814 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001815 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816 |format-comments|. See |option-backslash| about using backslashes to
1817 insert a space.
1818
1819 *'commentstring'* *'cms'* *E537*
1820'commentstring' 'cms' string (default "/*%s*/")
1821 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 {not available when compiled without the |+folding|
1823 feature}
1824 A template for a comment. The "%s" in the value is replaced with the
1825 comment text. Currently only used to add markers for folding, see
1826 |fold-marker|.
1827
1828 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001829'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001830 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 This option has the effect of making Vim either more Vi-compatible, or
1833 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001834
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001836 other options are also changed as a side effect.
1837 NOTE: Setting or resetting this option can have a lot of unexpected
1838 effects: Mappings are interpreted in another way, undo behaves
1839 differently, etc. If you set this option in your vimrc file, you
1840 should probably put it at the very start.
1841
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 By default this option is on and the Vi defaults are used for the
1843 options. This default was chosen for those people who want to use Vim
1844 just like Vi, and don't even (want to) know about the 'compatible'
1845 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001846 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001847 this option is switched off, and all options that have not been
1848 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001849 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001850 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001851 happen for the system-wide vimrc or gvimrc file, nor for a file given
1852 with the |-u| argument). Also see |compatible-default| and
1853 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 You can also set this option with the "-C" argument, and reset it with
1855 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001856 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857
Bram Moolenaar214641f2017-03-05 17:04:09 +01001858 When this option is set, numerous other options are set to make Vim as
1859 Vi-compatible as possible. When this option is unset, various options
1860 are set to make Vim more useful. The table below lists all the
1861 options affected.
1862 The {?} column indicates when the options are affected:
1863 + Means that the option is set to the value given in {set value} when
1864 'compatible' is set.
1865 & Means that the option is set to the value given in {set value} when
1866 'compatible' is set AND is set to its Vim default value when
1867 'compatible' is unset.
1868 - Means the option is NOT changed when setting 'compatible' but IS
1869 set to its Vim default when 'compatible' is unset.
1870 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871
Bram Moolenaar036986f2017-03-16 17:41:02 +01001872 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001873
1874 'allowrevins' + off no CTRL-_ command
1875 'antialias' + off don't use antialiased fonts
1876 'arabic' + off reset arabic-related options
1877 'arabicshape' + on correct character shapes
1878 'backspace' + "" normal backspace
1879 'backup' + off no backup file
1880 'backupcopy' & Unix: "yes" backup file is a copy
1881 else: "auto" copy or rename backup file
1882 'balloonexpr' + "" text to show in evaluation balloon
1883 'breakindent' + off don't indent when wrapping lines
1884 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001885 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001886 'cindent' + off no C code indentation
1887 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1888 'copyindent' + off don't copy indent structure
1889 'cpoptions' & (all flags) Vi-compatible flags
1890 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001891 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001892 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001893 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001894 'cscopeverbose' + off see |cscopeverbose|
1895 'delcombine' + off unicode: delete whole char combination
1896 'digraph' + off no digraphs
1897 'esckeys' & off no <Esc>-keys in Insert mode
1898 'expandtab' + off tabs not expanded to spaces
1899 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001900 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001901 'formatexpr' + "" use 'formatprg' for auto-formatting
1902 'formatoptions' & "vt" Vi compatible formatting
1903 'gdefault' + off no default 'g' flag for ":s"
1904 'history' & 0 no commandline history
1905 'hkmap' + off no Hebrew keyboard mapping
1906 'hkmapp' + off no phonetic Hebrew keyboard mapping
1907 'hlsearch' + off no highlighting of search matches
1908 'incsearch' + off no incremental searching
1909 'indentexpr' + "" no indenting by expression
1910 'insertmode' + off do not start in Insert mode
1911 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001913 'joinspaces' + on insert 2 spaces after period
1914 'modeline' & off no modelines
1915 'more' & off no pauses in listings
1916 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1917 'numberwidth' & 8 min number of columns for line number
1918 'preserveindent'+ off don't preserve current indent structure
1919 when changing it
1920 'revins' + off no reverse insert
1921 'ruler' + off no ruler
1922 'scrolljump' + 1 no jump scroll
1923 'scrolloff' + 0 no scroll offset
1924 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1925 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001926 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001927 'showcmd' & off command characters not shown
1928 'showmode' & off current mode not shown
1929 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1930 'smartcase' + off no automatic ignore case switch
1931 'smartindent' + off no smart indentation
1932 'smarttab' + off no smart tab size
1933 'softtabstop' + 0 tabs are always 'tabstop' positions
1934 'startofline' + on goto startofline with some commands
1935 'tagcase' & "followic" 'ignorecase' when searching tags file
1936 'tagrelative' & off tag file names are not relative
1937 'termguicolors' + off don't use highlight-(guifg|guibg)
1938 'textauto' & off no automatic textmode detection
1939 'textwidth' + 0 no automatic line wrap
1940 'tildeop' + off tilde is not an operator
1941 'ttimeout' + off no terminal timeout
1942 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001943 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001944 'virtualedit' + "" cursor can only be placed on characters
1945 'whichwrap' & "" left-right movements don't wrap
1946 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001948 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949
1950 *'complete'* *'cpt'* *E535*
1951'complete' 'cpt' string (default: ".,w,b,u,t,i")
1952 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 This option specifies how keyword completion |ins-completion| works
1954 when CTRL-P or CTRL-N are used. It is also used for whole-line
1955 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001956 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001957 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958 w scan buffers from other windows
1959 b scan other loaded buffers that are in the buffer list
1960 u scan the unloaded buffers that are in the buffer list
1961 U scan the buffers that are not in the buffer list
1962 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001963 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 k{dict} scan the file {dict}. Several "k" flags can be given,
1965 patterns are valid too. For example: >
1966 :set cpt=k/usr/dict/*,k~/spanish
1967< s scan the files given with the 'thesaurus' option
1968 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1969 are valid too.
1970 i scan current and included files
1971 d scan current and included files for defined name or macro
1972 |i_CTRL-X_CTRL-D|
1973 ] tag completion
1974 t same as "]"
1975
1976 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1977 not executed, this may lead to unexpected completions from some files
1978 (gzipped files for example). Unloaded buffers are not scanned for
1979 whole-line completion.
1980
1981 The default is ".,w,b,u,t,i", which means to scan:
1982 1. the current buffer
1983 2. buffers in other windows
1984 3. other loaded buffers
1985 4. unloaded buffers
1986 5. tags
1987 6. included files
1988
1989 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001990 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1991 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001993 *'completefunc'* *'cfu'*
1994'completefunc' 'cfu' string (default: empty)
1995 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001996 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001997 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001998 This option specifies a function to be used for Insert mode completion
1999 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002000 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002001 invoked and what it should return. The value can be the name of a
2002 function, a |lambda| or a |Funcref|. See |option-value-function| for
2003 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002004 This option cannot be set from a |modeline| or in the |sandbox|, for
2005 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002006
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002007 *'completeslash'* *'csl'*
2008'completeslash' 'csl' string (default: "")
2009 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002010 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002011 When this option is set it overrules 'shellslash' for completion:
2012 - When this option is set to "slash", a forward slash is used for path
2013 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002014 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002015 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002016 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002017 - When this option is empty, same character is used as for
2018 'shellslash'.
2019 For Insert mode completion the buffer-local value is used. For
2020 command line completion the global value is used.
2021
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002022 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002023'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002024 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002025 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002026 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002027
2028 menu Use a popup menu to show the possible completions. The
2029 menu is only shown when there is more than one match and
2030 sufficient colors are available. |ins-completion-menu|
2031
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002032 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002033 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002034 match, e.g., what file it comes from.
2035
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002036 longest Only insert the longest common text of the matches. If
2037 the menu is displayed you can use CTRL-L to add more
2038 characters. Whether case is ignored depends on the kind
2039 of completion. For buffer text the 'ignorecase' option is
2040 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002041
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002042 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002043 completion in the preview window. Only works in
2044 combination with "menu" or "menuone".
2045
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002046 popup Show extra information about the currently selected
2047 completion in a popup window. Only works in combination
2048 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002049 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002050 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002051
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002052 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002053 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002054 |CompleteChanged| autocommand to fetch the info and call
2055 |popup_show()| once the popup has been filled.
2056 See the example at |complete-popuphidden|.
2057 {only works when compiled with the |+textprop| feature}
2058
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002059 noinsert Do not insert any text for a match until the user selects
2060 a match from the menu. Only works in combination with
2061 "menu" or "menuone". No effect if "longest" is present.
2062
2063 noselect Do not select a match in the menu, force the user to
2064 select one from the menu. Only works in combination with
2065 "menu" or "menuone".
2066
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002067
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002068 *'completepopup'* *'cpp'*
2069'completepopup' 'cpp' string (default empty)
2070 global
2071 {not available when compiled without the |+textprop|
2072 or |+quickfix| feature}
2073 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002074 properties of the info popup when it is created. If an info popup
2075 window already exists it is closed, so that the option value is
2076 applied when it is created again.
2077 You can also use |popup_findinfo()| and then set properties for an
2078 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002079
2080
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002081 *'concealcursor'* *'cocu'*
2082'concealcursor' 'cocu' string (default: "")
2083 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002084 {not available when compiled without the |+conceal|
2085 feature}
2086 Sets the modes in which text in the cursor line can also be concealed.
2087 When the current mode is listed then concealing happens just like in
2088 other lines.
2089 n Normal mode
2090 v Visual mode
2091 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002092 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002093
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002094 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002095 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002096 are moving around text is concealed, but when starting to insert text
2097 or selecting a Visual area the concealed text is displayed, so that
2098 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002099 Keep in mind that the cursor position is not always where it's
2100 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002101
2102
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002103 *'conceallevel'* *'cole'*
2104'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002105 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002106 {not available when compiled without the |+conceal|
2107 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002108 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2109 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002110
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002111 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002112 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002113 1 Each block of concealed text is replaced with one
2114 character. If the syntax item does not have a custom
2115 replacement character defined (see |:syn-cchar|) the
2116 character defined in 'listchars' is used (default is a
2117 space).
2118 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002119 2 Concealed text is completely hidden unless it has a
2120 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002121 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002122 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002123
Bram Moolenaara7781e02010-07-19 20:13:22 +02002124 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002125 edit and copy the text. This can be changed with the 'concealcursor'
2126 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002127
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2129'confirm' 'cf' boolean (default off)
2130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 When 'confirm' is on, certain operations that would normally
2132 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2133 instead raise a |dialog| asking if you wish to save the current
2134 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2135 If 'confirm' is off you can still activate confirmation for one
2136 command only (this is most useful in mappings) with the |:confirm|
2137 command.
2138 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2139
2140 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2141'conskey' 'consk' boolean (default off)
2142 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002143 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144
2145 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2146'copyindent' 'ci' boolean (default off)
2147 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 Copy the structure of the existing lines indent when autoindenting a
2149 new line. Normally the new indent is reconstructed by a series of
2150 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2151 in which case only spaces are used). Enabling this option makes the
2152 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002153 existing line. 'expandtab' has no effect on these characters, a Tab
2154 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002156 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 Also see 'preserveindent'.
2158
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002159 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160'cpoptions' 'cpo' string (Vim default: "aABceFs",
2161 Vi default: all flags)
2162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002164 this indicates Vi-compatible behavior. This is used for things where
2165 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 'cpoptions' stands for "compatible-options".
2167 Commas can be added for readability.
2168 To avoid problems with flags that are added in the future, use the
2169 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002170
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 NOTE: This option is set to the Vi default value when 'compatible' is
2172 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002173
2174 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2175 is saved, 'cpoptions' is set to the Vim default, and the saved value
2176 is restored at the end of the script. Changes to the value of
2177 'cpoptions' will be applied to the saved value, but keep in mind that
2178 removing a flag that is not present when 'cpoptions' is changed has no
2179 effect. In the |.vimrc| file the value is not restored, thus using
2180 `vim9script` in the |.vimrc| file results in using the Vim default.
2181
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002182 NOTE: This option is set to the POSIX default value at startup when
2183 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002184 variable exists |posix|. This means Vim tries to behave like the
2185 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186
2187 contains behavior ~
2188 *cpo-a*
2189 a When included, a ":read" command with a file name
2190 argument will set the alternate file name for the
2191 current window.
2192 *cpo-A*
2193 A When included, a ":write" command with a file name
2194 argument will set the alternate file name for the
2195 current window.
2196 *cpo-b*
2197 b "\|" in a ":map" command is recognized as the end of
2198 the map command. The '\' is included in the mapping,
2199 the text after the '|' is interpreted as the next
2200 command. Use a CTRL-V instead of a backslash to
2201 include the '|' in the mapping. Applies to all
2202 mapping, abbreviation, menu and autocmd commands.
2203 See also |map_bar|.
2204 *cpo-B*
2205 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002206 abbreviations, user commands and the "to" part of the
2207 menu commands. Remove this flag to be able to use a
2208 backslash like a CTRL-V. For example, the command
2209 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 'B' included: "\^[" (^[ is a real <Esc>)
2211 'B' excluded: "<Esc>" (5 characters)
2212 ('<' excluded in both cases)
2213 *cpo-c*
2214 c Searching continues at the end of any match at the
2215 cursor position, but not further than the start of the
2216 next line. When not present searching continues
2217 one character from the cursor position. With 'c'
2218 "abababababab" only gets three matches when repeating
2219 "/abab", without 'c' there are five matches.
2220 *cpo-C*
2221 C Do not concatenate sourced lines that start with a
2222 backslash. See |line-continuation|.
2223 *cpo-d*
2224 d Using "./" in the 'tags' option doesn't mean to use
2225 the tags file relative to the current file, but the
2226 tags file in the current directory.
2227 *cpo-D*
2228 D Can't use CTRL-K to enter a digraph after Normal mode
2229 commands with a character argument, like |r|, |f| and
2230 |t|.
2231 *cpo-e*
2232 e When executing a register with ":@r", always add a
2233 <CR> to the last line, also when the register is not
2234 linewise. If this flag is not present, the register
2235 is not linewise and the last line does not end in a
2236 <CR>, then the last line is put on the command-line
2237 and can be edited before hitting <CR>.
2238 *cpo-E*
2239 E It is an error when using "y", "d", "c", "g~", "gu" or
2240 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002241 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 This makes "y0" fail in the first column.
2243 *cpo-f*
2244 f When included, a ":read" command with a file name
2245 argument will set the file name for the current buffer,
2246 if the current buffer doesn't have a file name yet.
2247 *cpo-F*
2248 F When included, a ":write" command with a file name
2249 argument will set the file name for the current
2250 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002251 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 *cpo-g*
2253 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002254 *cpo-H*
2255 H When using "I" on a line with only blanks, insert
2256 before the last blank. Without this flag insert after
2257 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 *cpo-i*
2259 i When included, interrupting the reading of a file will
2260 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002261 *cpo-I*
2262 I When moving the cursor up or down just after inserting
2263 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 *cpo-j*
2265 j When joining lines, only add two spaces after a '.',
2266 not after '!' or '?'. Also see 'joinspaces'.
2267 *cpo-J*
2268 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002269 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 white space.
2271 *cpo-k*
2272 k Disable the recognition of raw key codes in
2273 mappings, abbreviations, and the "to" part of menu
2274 commands. For example, if <Key> sends ^[OA (where ^[
2275 is <Esc>), the command ":map X ^[OA" results in X
2276 being mapped to:
2277 'k' included: "^[OA" (3 characters)
2278 'k' excluded: "<Key>" (one key code)
2279 Also see the '<' flag below.
2280 *cpo-K*
2281 K Don't wait for a key code to complete when it is
2282 halfway a mapping. This breaks mapping <F1><F1> when
2283 only part of the second <F1> has been read. It
2284 enables cancelling the mapping by typing <F1><Esc>.
2285 *cpo-l*
2286 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002287 literally, only "\]", "\^", "\-" and "\\" are special.
2288 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2290 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002291 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 *cpo-L*
2293 L When the 'list' option is set, 'wrapmargin',
2294 'textwidth', 'softtabstop' and Virtual Replace mode
2295 (see |gR|) count a <Tab> as two characters, instead of
2296 the normal behavior of a <Tab>.
2297 *cpo-m*
2298 m When included, a showmatch will always wait half a
2299 second. When not included, a showmatch will wait half
2300 a second or until a character is typed. |'showmatch'|
2301 *cpo-M*
2302 M When excluded, "%" matching will take backslashes into
2303 account. Thus in "( \( )" and "\( ( \)" the outer
2304 parenthesis match. When included "%" ignores
2305 backslashes, which is Vi compatible.
2306 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002307 n When included, the column used for 'number' and
2308 'relativenumber' will also be used for text of wrapped
2309 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 *cpo-o*
2311 o Line offset to search command is not remembered for
2312 next search.
2313 *cpo-O*
2314 O Don't complain if a file is being overwritten, even
2315 when it didn't exist when editing it. This is a
2316 protection against a file unexpectedly created by
2317 someone else. Vi didn't complain about this.
2318 *cpo-p*
2319 p Vi compatible Lisp indenting. When not present, a
2320 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002321 *cpo-P*
2322 P When included, a ":write" command that appends to a
2323 file will set the file name for the current buffer, if
2324 the current buffer doesn't have a file name yet and
2325 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002326 *cpo-q*
2327 q When joining multiple lines leave the cursor at the
2328 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 *cpo-r*
2330 r Redo ("." command) uses "/" to repeat a search
2331 command, instead of the actually used search string.
2332 *cpo-R*
2333 R Remove marks from filtered lines. Without this flag
2334 marks are kept like |:keepmarks| was used.
2335 *cpo-s*
2336 s Set buffer options when entering the buffer for the
2337 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002338 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 set when the buffer is created.
2340 *cpo-S*
2341 S Set buffer options always when entering a buffer
2342 (except 'readonly', 'fileformat', 'filetype' and
2343 'syntax'). This is the (most) Vi compatible setting.
2344 The options are set to the values in the current
2345 buffer. When you change an option and go to another
2346 buffer, the value is copied. Effectively makes the
2347 buffer options global to all buffers.
2348
2349 's' 'S' copy buffer options
2350 no no when buffer created
2351 yes no when buffer first entered (default)
2352 X yes each time when buffer entered (vi comp.)
2353 *cpo-t*
2354 t Search pattern for the tag command is remembered for
2355 "n" command. Otherwise Vim only puts the pattern in
2356 the history for search pattern, but doesn't change the
2357 last used search pattern.
2358 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002359 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 *cpo-v*
2361 v Backspaced characters remain visible on the screen in
2362 Insert mode. Without this flag the characters are
2363 erased from the screen right away. With this flag the
2364 screen newly typed text overwrites backspaced
2365 characters.
2366 *cpo-w*
2367 w When using "cw" on a blank character, only change one
2368 character and not all blanks until the start of the
2369 next word.
2370 *cpo-W*
2371 W Don't overwrite a readonly file. When omitted, ":w!"
2372 overwrites a readonly file, if possible.
2373 *cpo-x*
2374 x <Esc> on the command-line executes the command-line.
2375 The default in Vim is to abandon the command-line,
2376 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002377 *cpo-X*
2378 X When using a count with "R" the replaced text is
2379 deleted only once. Also when repeating "R" with "."
2380 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002382 y A yank command can be redone with ".". Think twice if
2383 you really want to use this, it may break some
2384 plugins, since most people expect "." to only repeat a
2385 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002386 *cpo-Z*
2387 Z When using "w!" while the 'readonly' option is set,
2388 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 *cpo-!*
2390 ! When redoing a filter command, use the last used
2391 external command, whatever it was. Otherwise the last
2392 used -filter- command is used.
2393 *cpo-$*
2394 $ When making a change to one line, don't redisplay the
2395 line, but put a '$' at the end of the changed text.
2396 The changed text will be overwritten when you type the
2397 new text. The line is redisplayed if you type any
2398 command that moves the cursor from the insertion
2399 point.
2400 *cpo-%*
2401 % Vi-compatible matching is done for the "%" command.
2402 Does not recognize "#if", "#endif", etc.
2403 Does not recognize "/*" and "*/".
2404 Parens inside single and double quotes are also
2405 counted, causing a string that contains a paren to
2406 disturb the matching. For example, in a line like
2407 "if (strcmp("foo(", s))" the first paren does not
2408 match the last one. When this flag is not included,
2409 parens inside single and double quotes are treated
2410 specially. When matching a paren outside of quotes,
2411 everything inside quotes is ignored. When matching a
2412 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002413 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002414 This flag is also used for other features, such as
2415 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002416 *cpo--*
2417 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002418 it would go above the first line or below the last
2419 line. Without it the cursor moves to the first or
2420 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002421 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002422 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002423 *cpo-+*
2424 + When included, a ":write file" command will reset the
2425 'modified' flag of the buffer, even though the buffer
2426 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002427 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 * Use ":*" in the same way as ":@". When not included,
2429 ":*" is an alias for ":'<,'>", select the Visual area.
2430 *cpo-<*
2431 < Disable the recognition of special key codes in |<>|
2432 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002433 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434 ":map X <Tab>" results in X being mapped to:
2435 '<' included: "<Tab>" (5 characters)
2436 '<' excluded: "^I" (^I is a real <Tab>)
2437 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002438 *cpo->*
2439 > When appending to a register, put a line break before
2440 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002441 *cpo-;*
2442 ; When using |,| or |;| to repeat the last |t| search
2443 and the cursor is right in front of the searched
2444 character, the cursor won't move. When not included,
2445 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002446 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002447
2448 POSIX flags. These are not included in the Vi default value, except
2449 when $VIM_POSIX was set on startup. |posix|
2450
2451 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002452 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002453 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002454 *cpo-&*
2455 & When ":preserve" was used keep the swap file when
2456 exiting normally while this buffer is still loaded.
2457 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002458 *cpo-\*
2459 \ Backslash in a [] range in a search pattern is taken
2460 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002461 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2462 '\' excluded: "/[ \-]" finds <Space> and '-'
2463 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002464 *cpo-/*
2465 / When "%" is used as the replacement string in a |:s|
2466 command, use the previous replacement string. |:s%|
2467 *cpo-{*
2468 { The |{| and |}| commands also stop at a "{" character
2469 at the start of a line.
2470 *cpo-.*
2471 . The ":chdir" and ":cd" commands fail if the current
2472 buffer is modified, unless ! is used. Vim doesn't
2473 need this, since it remembers the full path of an
2474 opened file.
2475 *cpo-bar*
2476 | The value of the $LINES and $COLUMNS environment
2477 variables overrule the terminal size values obtained
2478 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002479
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002481 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002482'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002483 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002484 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002485 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002486 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002487 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002488 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002489 blowfish Blowfish method. Medium strong encryption but it has
2490 an implementation flaw. Requires Vim 7.3 or later,
2491 files can NOT be read by Vim 7.2 and older. This adds
2492 a "seed" to the file, every time you write the file
2493 the encrypted bytes will be different.
2494 *blowfish2*
2495 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002496 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002497 and older. This adds a "seed" to the file, every time
2498 you write the file the encrypted bytes will be
2499 different. The whole undo file is encrypted, not just
2500 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002501 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002502 *E1197* *E1198* *E1199* *E1200* *E1201*
2503 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2504 Code. Medium strong till strong encryption.
2505 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002506 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002507 It adds a seed and a message authentication code (MAC)
2508 to the file. This needs at least a Vim 8.2.3022 to
2509 read the encrypted file.
2510 Encryption of swap files is not supported, therefore
2511 no swap file will be used when xchacha20 encryption is
2512 enabled.
2513 Encryption of undo files is not yet supported,
2514 therefore no undo file will currently be written.
2515 CURRENTLY EXPERIMENTAL: Files written with this method
2516 might have to be read back with the same version of
2517 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002518
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002519 You should use "blowfish2", also to re-encrypt older files.
2520
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002521 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002522 to the detected method of the file being read. Thus if you write it
2523 without changing 'cryptmethod' the same method will be used.
2524 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002525 explicitly write it, you don't get a warning unless there are other
2526 modifications. Also see |:X|.
2527
2528 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002529 the value "blowfish2". When setting the local value to an empty
2530 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002531
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002532 When a new encryption method is added in a later version of Vim, and
2533 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002534 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002535
2536
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 *'cscopepathcomp'* *'cspc'*
2538'cscopepathcomp' 'cspc' number (default 0)
2539 global
2540 {not available when compiled without the |+cscope|
2541 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 Determines how many components of the path to show in a list of tags.
2543 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002544 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545
2546 *'cscopeprg'* *'csprg'*
2547'cscopeprg' 'csprg' string (default "cscope")
2548 global
2549 {not available when compiled without the |+cscope|
2550 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 Specifies the command to execute cscope. See |cscopeprg|.
2552 This option cannot be set from a |modeline| or in the |sandbox|, for
2553 security reasons.
2554
2555 *'cscopequickfix'* *'csqf'*
2556'cscopequickfix' 'csqf' string (default "")
2557 global
2558 {not available when compiled without the |+cscope|
2559 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 Specifies whether to use quickfix window to show cscope results.
2561 See |cscopequickfix|.
2562
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002563 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002564'cscoperelative' 'csre' boolean (default off)
2565 global
2566 {not available when compiled without the |+cscope|
2567 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002568 In the absence of a prefix (-P) for cscope. setting this option enables
2569 to use the basename of cscope.out path as the prefix.
2570 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002571 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002572
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2574'cscopetag' 'cst' boolean (default off)
2575 global
2576 {not available when compiled without the |+cscope|
2577 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 Use cscope for tag commands. See |cscope-options|.
2579 NOTE: This option is reset when 'compatible' is set.
2580
2581 *'cscopetagorder'* *'csto'*
2582'cscopetagorder' 'csto' number (default 0)
2583 global
2584 {not available when compiled without the |+cscope|
2585 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 Determines the order in which ":cstag" performs a search. See
2587 |cscopetagorder|.
2588 NOTE: This option is set to 0 when 'compatible' is set.
2589
2590 *'cscopeverbose'* *'csverb'*
2591 *'nocscopeverbose'* *'nocsverb'*
2592'cscopeverbose' 'csverb' boolean (default off)
2593 global
2594 {not available when compiled without the |+cscope|
2595 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 Give messages when adding a cscope database. See |cscopeverbose|.
2597 NOTE: This option is reset when 'compatible' is set.
2598
Bram Moolenaar860cae12010-06-05 23:22:07 +02002599 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2600'cursorbind' 'crb' boolean (default off)
2601 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002602 When this option is set, as the cursor in the current
2603 window moves other cursorbound windows (windows that also have
2604 this option set) move their cursors to the corresponding line and
2605 column. This option is useful for viewing the
2606 differences between two versions of a file (see 'diff'); in diff mode,
2607 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002608 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002609
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002610
2611 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2612'cursorcolumn' 'cuc' boolean (default off)
2613 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002614 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002615 feature}
2616 Highlight the screen column of the cursor with CursorColumn
2617 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2618 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002619 If you only want the highlighting in the current window you can use
2620 these autocommands: >
2621 au WinLeave * set nocursorline nocursorcolumn
2622 au WinEnter * set cursorline cursorcolumn
2623<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002624
2625 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2626'cursorline' 'cul' boolean (default off)
2627 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002628 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002629 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002630 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2631 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002632 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002633 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002634
2635
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002636 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002637'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002638 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002639 {not available when compiled without the |+syntax|
2640 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002641 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002642 Valid values:
2643 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002644 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002645 "screenline" Highlight only the screen line of the cursor with
2646 CursorLine |hl-CursorLine|.
2647 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002648 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002649
2650 Special value:
2651 "both" Alias for the values "line,number".
2652
2653 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002654
2655
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 *'debug'*
2657'debug' string (default "")
2658 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002659 These values can be used:
2660 msg Error messages that would otherwise be omitted will be given
2661 anyway.
2662 throw Error messages that would otherwise be omitted will be given
2663 anyway and also throw an exception and set |v:errmsg|.
2664 beep A message will be given when otherwise only a beep would be
2665 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002666 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002667 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2668 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669
2670 *'define'* *'def'*
2671'define' 'def' string (default "^\s*#\s*define")
2672 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002673 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 pattern, just like for the "/" command. This option is used for the
2675 commands like "[i" and "[d" |include-search|. The 'isident' option is
2676 used to recognize the defined name after the match:
2677 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2678 See |option-backslash| about inserting backslashes to include a space
2679 or backslash.
2680 The default value is for C programs. For C++ this value would be
2681 useful, to include const type declarations: >
2682 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002683< You can also use "\ze" just before the name and continue the pattern
2684 to check what is following. E.g. for Javascript, if a function is
2685 defined with "func_name = function(args)": >
2686 ^\s*\ze\i\+\s*=\s*function(
2687< If the function is defined with "func_name : function() {...": >
2688 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002690 To avoid that use `:let` with a single quote string: >
2691 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002692<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693
2694 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2695'delcombine' 'deco' boolean (default off)
2696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 If editing Unicode and this option is set, backspace and Normal mode
2698 "x" delete each combining character on its own. When it is off (the
2699 default) the character along with its combining characters are
2700 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002701 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702
2703 This is useful for Arabic, Hebrew and many other languages where one
2704 may have combining characters overtop of base characters, and want
2705 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002706 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707
2708 *'dictionary'* *'dict'*
2709'dictionary' 'dict' string (default "")
2710 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 List of file names, separated by commas, that are used to lookup words
2712 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2713 contain a list of words. This can be one word per line, or several
2714 words per line, separated by non-keyword characters (white space is
2715 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002716
2717 When this option is empty or an entry "spell" is present, and spell
2718 checking is enabled, words in the word lists for the currently active
2719 'spelllang' are used. See |spell|.
2720
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002721 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 after a comma are ignored, otherwise spaces are included in the file
2723 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002724 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 Where to find a list of words?
2726 - On FreeBSD, there is the file "/usr/share/dict/words".
2727 - In the Simtel archive, look in the "msdos/linguist" directory.
2728 - In "miscfiles" of the GNU collection.
2729 The use of |:set+=| and |:set-=| is preferred when adding or removing
2730 directories from the list. This avoids problems when a future version
2731 uses another default.
2732 Backticks cannot be used in this option for security reasons.
2733
2734 *'diff'* *'nodiff'*
2735'diff' boolean (default off)
2736 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 {not available when compiled without the |+diff|
2738 feature}
2739 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002740 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741
2742 *'dex'* *'diffexpr'*
2743'diffexpr' 'dex' string (default "")
2744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 {not available when compiled without the |+diff|
2746 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002747 Expression which is evaluated to obtain a diff file (either ed-style
2748 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 This option cannot be set from a |modeline| or in the |sandbox|, for
2750 security reasons.
2751
2752 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002753'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 {not available when compiled without the |+diff|
2756 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002757 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 All are optional. Items must be separated by a comma.
2759
2760 filler Show filler lines, to keep the text
2761 synchronized with a window that has inserted
2762 lines at the same position. Mostly useful
2763 when windows are side-by-side and 'scrollbind'
2764 is set.
2765
2766 context:{n} Use a context of {n} lines between a change
2767 and a fold that contains unchanged lines.
2768 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002769 When using zero the context is actually one,
2770 since folds require a line in between, also
2771 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 See |fold-diff|.
2773
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002774 iblank Ignore changes where lines are all blank. Adds
2775 the "-B" flag to the "diff" command if
2776 'diffexpr' is empty. Check the documentation
2777 of the "diff" command for what this does
2778 exactly.
2779 NOTE: the diff windows will get out of sync,
2780 because no differences between blank lines are
2781 taken into account.
2782
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 icase Ignore changes in case of text. "a" and "A"
2784 are considered the same. Adds the "-i" flag
2785 to the "diff" command if 'diffexpr' is empty.
2786
2787 iwhite Ignore changes in amount of white space. Adds
2788 the "-b" flag to the "diff" command if
2789 'diffexpr' is empty. Check the documentation
2790 of the "diff" command for what this does
2791 exactly. It should ignore adding trailing
2792 white space, but not leading white space.
2793
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002794 iwhiteall Ignore all white space changes. Adds
2795 the "-w" flag to the "diff" command if
2796 'diffexpr' is empty. Check the documentation
2797 of the "diff" command for what this does
2798 exactly.
2799
2800 iwhiteeol Ignore white space changes at end of line.
2801 Adds the "-Z" flag to the "diff" command if
2802 'diffexpr' is empty. Check the documentation
2803 of the "diff" command for what this does
2804 exactly.
2805
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002806 horizontal Start diff mode with horizontal splits (unless
2807 explicitly specified otherwise).
2808
2809 vertical Start diff mode with vertical splits (unless
2810 explicitly specified otherwise).
2811
Bram Moolenaarc8234772019-11-10 21:00:27 +01002812 closeoff When a window is closed where 'diff' is set
2813 and there is only one window remaining in the
2814 same tab page with 'diff' set, execute
2815 `:diffoff` in that window. This undoes a
2816 `:diffsplit` command.
2817
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002818 hiddenoff Do not use diff mode for a buffer when it
2819 becomes hidden.
2820
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002821 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2822 starting diff mode. Without this 2 is used.
2823
Bram Moolenaar4223d432021-02-10 13:18:17 +01002824 followwrap Follow the 'wrap' option and leave as it is.
2825
Bram Moolenaare828b762018-09-10 17:51:58 +02002826 internal Use the internal diff library. This is
2827 ignored when 'diffexpr' is set. *E960*
2828 When running out of memory when writing a
2829 buffer this item will be ignored for diffs
2830 involving that buffer. Set the 'verbose'
2831 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832
Bram Moolenaare828b762018-09-10 17:51:58 +02002833 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002834 Use the indent heuristic for the internal
2835 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002836
2837 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002838 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002839 algorithms are:
2840 myers the default algorithm
2841 minimal spend extra time to generate the
2842 smallest possible diff
2843 patience patience diff algorithm
2844 histogram histogram diff algorithm
2845
2846 Examples: >
2847 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002849 :set diffopt=internal,filler,foldcolumn:3
2850 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851<
2852 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2853'digraph' 'dg' boolean (default off)
2854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 {not available when compiled without the |+digraphs|
2856 feature}
2857 Enable the entering of digraphs in Insert mode with {char1} <BS>
2858 {char2}. See |digraphs|.
2859 NOTE: This option is reset when 'compatible' is set.
2860
2861 *'directory'* *'dir'*
2862'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002863 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 for Unix: ".,~/tmp,/var/tmp,/tmp")
2865 global
2866 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002867 Recommended value: ".,~/vimswap//" - this will put the swap file next
2868 to the edited file if possible, and in your personal swap directory
2869 otherwise. Make sure "~/vimswap//" is only readable for you.
2870
2871 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 - The swap file will be created in the first directory where this is
2873 possible.
2874 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002875 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 - A directory "." means to put the swap file in the same directory as
2877 the edited file. On Unix, a dot is prepended to the file name, so
2878 it doesn't show in a directory listing. On MS-Windows the "hidden"
2879 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002880 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2881 the swap file relative to where the edited file is. The leading "."
2882 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002883 - For Unix and Win32, if a directory ends in two path separators "//",
2884 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002885 with all path separators replaced by percent '%' signs (including
2886 the colon following the drive letter on Win32). This will ensure
2887 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002888 On Win32, it is also possible to end with "\\". However, When a
2889 separating comma is following, you must use "//", since "\\" will
2890 include the comma in the file name. Therefore it is recommended to
2891 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 - Spaces after the comma are ignored, other spaces are considered part
2893 of the directory name. To have a space at the start of a directory
2894 name, precede it with a backslash.
2895 - To include a comma in a directory name precede it with a backslash.
2896 - A directory name may end in an ':' or '/'.
2897 - Environment variables are expanded |:set_env|.
2898 - Careful with '\' characters, type one before a space, type two to
2899 get one in the option (see |option-backslash|), for example: >
2900 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2901< - For backwards compatibility with Vim version 3.0 a '>' at the start
2902 of the option is removed.
2903 Using "." first in the list is recommended. This means that editing
2904 the same file twice will result in a warning. Using "/tmp" on Unix is
2905 discouraged: When the system crashes you lose the swap file.
2906 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002907 choice than "/tmp". But others on the computer may be able to see the
2908 files, and it can contain a lot of files, your swap files get lost in
2909 the crowd. That is why a "tmp" directory in your home directory is
2910 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 The use of |:set+=| and |:set-=| is preferred when adding or removing
2912 directories from the list. This avoids problems when a future version
2913 uses another default.
2914 This option cannot be set from a |modeline| or in the |sandbox|, for
2915 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916
2917 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002918'display' 'dy' string (default "", set to "truncate" in
2919 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002921 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002922 flags:
2923 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002924 in a window will be displayed. "@@@" is put in the
2925 last columns of the last screen line to indicate the
2926 rest of the line is not displayed.
2927 truncate Like "lastline", but "@@@" is displayed in the first
2928 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929 uhex Show unprintable characters hexadecimal as <xx>
2930 instead of using ^C and ~C.
2931
Bram Moolenaard0796902016-09-16 20:02:31 +02002932 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002933 doesn't fit is replaced with "@" lines.
2934
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935 *'eadirection'* *'ead'*
2936'eadirection' 'ead' string (default "both")
2937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 Tells when the 'equalalways' option applies:
2939 ver vertically, width of windows is not affected
2940 hor horizontally, height of windows is not affected
2941 both width and height of windows is affected
2942
2943 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2944'edcompatible' 'ed' boolean (default off)
2945 global
2946 Makes the 'g' and 'c' flags of the ":substitute" command to be
2947 toggled each time the flag is given. See |complex-change|. See
2948 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002949 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002950 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951
Bram Moolenaar03413f42016-04-12 21:07:15 +02002952 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002953'emoji' 'emo' boolean (default: on)
2954 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002955 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002956 This excludes "text emoji" characters, which are normally displayed as
2957 single width. Unfortunately there is no good specification for this
2958 and it has been determined on trial-and-error basis. Use the
2959 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002960
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002962'encoding' 'enc' string (default for MS-Windows: "utf-8",
2963 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 Sets the character encoding used inside Vim. It applies to text in
2966 the buffers, registers, Strings in expressions, text stored in the
2967 viminfo file, etc. It sets the kind of characters which Vim can work
2968 with. See |encoding-names| for the possible values.
2969
2970 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002971 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002973 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974
Bram Moolenaar865242e2010-07-14 21:12:05 +02002975 This option cannot be set from a |modeline|. It would most likely
2976 corrupt the text.
2977
Bram Moolenaar3df01732017-02-17 22:47:16 +01002978 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2979 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 'encoding', "utf-8" is the natural choice for the environment and
2981 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002982 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 versions, and to avoid changing the encoding of newly created files
2984 without your knowledge (in case 'fileencodings' is empty).
2985
2986 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002987 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 iconv() or as specified with 'charconvert'.
2989
Bram Moolenaar207f0092020-08-30 17:20:20 +02002990 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002991 can use: >
2992 if has("multi_byte_encoding")
2993<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 Normally 'encoding' will be equal to your current locale. This will
2995 be the default if Vim recognizes your environment settings. If
2996 'encoding' is not set to the current locale, 'termencoding' must be
2997 set to convert typed and displayed text. See |encoding-table|.
2998
2999 When you set this option, it fires the |EncodingChanged| autocommand
3000 event so that you can set up fonts if necessary.
3001
3002 When the option is set, the value is converted to lowercase. Thus
3003 you can set it with uppercase values too. Underscores are translated
3004 to '-' signs.
3005 When the encoding is recognized, it is changed to the standard name.
3006 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3007 "iso-8859-2" and "utf8" becomes "utf-8".
3008
3009 Note: "latin1" is also used when the encoding could not be detected.
3010 This only works when editing files in the same encoding! When the
3011 actual character set is not latin1, make sure 'fileencoding' and
3012 'fileencodings' are empty. When conversion is needed, switch to using
3013 utf-8.
3014
3015 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3016 You don't notice this while editing, but it does matter for the
3017 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3018 setting 'encoding' to one of these values instead of utf-8 only has
3019 effect for encoding used for files when 'fileencoding' is empty.
3020
Bram Moolenaar661b1822005-07-28 22:36:45 +00003021 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3022 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023
3024 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3025'endofline' 'eol' boolean (default on)
3026 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003028 is on, or 'fixeol' option is off, no <EOL> will be written for the
3029 last line in the file. This option is automatically set or reset when
3030 starting to edit a new file, depending on whether file has an <EOL>
3031 for the last line in the file. Normally you don't have to set or
3032 reset this option.
3033 When 'binary' is off and 'fixeol' is on the value is not used when
3034 writing the file. When 'binary' is on or 'fixeol' is off it is used
3035 to remember the presence of a <EOL> for the last line in the file, so
3036 that when you write the file the situation from the original file can
3037 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038
3039 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3040'equalalways' 'ea' boolean (default on)
3041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003043 splitting or closing a window. This also happens the moment the
3044 option is switched on. When off, splitting a window will reduce the
3045 size of the current window and leave the other windows the same. When
3046 closing a window the extra lines are given to the window next to it
3047 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 When mixing vertically and horizontally split windows, a minimal size
3049 is computed and some windows may be larger if there is room. The
3050 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003051 Changing the height and width of a window can be avoided by setting
3052 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003053 If a window size is specified when creating a new window sizes are
3054 currently not equalized (it's complicated, but may be implemented in
3055 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056
3057 *'equalprg'* *'ep'*
3058'equalprg' 'ep' string (default "")
3059 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003061 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003062 or 'indentexpr'. When Vim was compiled without internal formatting,
3063 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003064 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065 about including spaces and backslashes.
3066 This option cannot be set from a |modeline| or in the |sandbox|, for
3067 security reasons.
3068
3069 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3070'errorbells' 'eb' boolean (default off)
3071 global
3072 Ring the bell (beep or screen flash) for error messages. This only
3073 makes a difference for error messages, the bell will be used always
3074 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003075 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003076 screen flash or do nothing. See 'belloff' to finetune when to ring the
3077 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078
3079 *'errorfile'* *'ef'*
3080'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3081 others: "errors.err")
3082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 {not available when compiled without the |+quickfix|
3084 feature}
3085 Name of the errorfile for the QuickFix mode (see |:cf|).
3086 When the "-q" command-line argument is used, 'errorfile' is set to the
3087 following argument. See |-q|.
3088 NOT used for the ":make" command. See 'makeef' for that.
3089 Environment variables are expanded |:set_env|.
3090 See |option-backslash| about including spaces and backslashes.
3091 This option cannot be set from a |modeline| or in the |sandbox|, for
3092 security reasons.
3093
3094 *'errorformat'* *'efm'*
3095'errorformat' 'efm' string (default is very long)
3096 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 {not available when compiled without the |+quickfix|
3098 feature}
3099 Scanf-like description of the format for the lines in the error file
3100 (see |errorformat|).
3101
3102 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3103'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 Function keys that start with an <Esc> are recognized in Insert
3106 mode. When this option is off, the cursor and function keys cannot be
3107 used in Insert mode if they start with an <Esc>. The advantage of
3108 this is that the single <Esc> is recognized immediately, instead of
3109 after one second. Instead of resetting this option, you might want to
3110 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3111 when 'esckeys' is off, you can still map anything, but the cursor keys
3112 won't work by default.
3113 NOTE: This option is set to the Vi default value when 'compatible' is
3114 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003115 NOTE: when this option is off then the |modifyOtherKeys| functionality
3116 is disabled while in Insert mode to avoid ending Insert mode with any
3117 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118
3119 *'eventignore'* *'ei'*
3120'eventignore' 'ei' string (default "")
3121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003123 When set to "all" or when "all" is one of the items, all autocommand
3124 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003125 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 :set ei=WinEnter,WinLeave
3127<
3128 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3129'expandtab' 'et' boolean (default off)
3130 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003132 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3134 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003135 This option is reset when the 'paste' option is set and restored when
3136 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 NOTE: This option is reset when 'compatible' is set.
3138
3139 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3140'exrc' 'ex' boolean (default off)
3141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003143 directory.
3144
3145 Setting this option is a potential security leak. E.g., consider
3146 unpacking a package or fetching files from github, a .vimrc in there
3147 might be a trojan horse. BETTER NOT SET THIS OPTION!
3148 Instead, define an autocommand in your .vimrc to set options for a
3149 matching directory.
3150
3151 If you do switch this option on you should also consider setting the
3152 'secure' option (see |initialization|).
3153 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 This option cannot be set from a |modeline| or in the |sandbox|, for
3155 security reasons.
3156
3157 *'fileencoding'* *'fenc'* *E213*
3158'fileencoding' 'fenc' string (default: "")
3159 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003161
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003163 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 When 'fileencoding' is empty, the same value as 'encoding' will be
3165 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003166 No error will be given when the value is set, only when it is used,
3167 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003168 Conversion will also be done when 'encoding' and 'fileencoding' are
3169 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3170 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003172 'encoding' is "utf-8" or another Unicode encoding, conversion
3173 is most likely done in a way that the reverse conversion
3174 results in the same text. When 'encoding' is not "utf-8" some
3175 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003176
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 See 'encoding' for the possible values. Additionally, values may be
3178 specified that can be handled by the converter, see
3179 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003180
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 When reading a file 'fileencoding' will be set from 'fileencodings'.
3182 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003183 'fileencoding', use the |++enc| argument. One exception: when
3184 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003185 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003186
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3188 When the option is set, the value is converted to lowercase. Thus
3189 you can set it with uppercase values too. '_' characters are
3190 replaced with '-'. If a name is recognized from the list for
3191 'encoding', it is replaced by the standard name. For example
3192 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003193
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 When this option is set, after starting to edit a file, the 'modified'
3195 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003196
3197 Keep in mind that changing 'fenc' from a modeline happens
3198 AFTER the text has been read, thus it applies to when the file will be
3199 written. If you do set 'fenc' in a modeline, you might want to set
3200 'nomodified' to avoid not being able to ":q".
3201
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 This option can not be changed when 'modifiable' is off.
3203
3204 *'fe'*
3205 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003206 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 old short name was 'fe', which is no longer used.
3208
3209 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003210'fileencodings' 'fencs' string (default: "ucs-bom",
3211 "ucs-bom,utf-8,default,latin1" when
3212 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 This is a list of character encodings considered when starting to edit
3215 an existing file. When a file is read, Vim tries to use the first
3216 mentioned character encoding. If an error is detected, the next one
3217 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003218 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 an empty string, which means the value of 'encoding' is used.
3220 WARNING: Conversion can cause loss of information! When
3221 'encoding' is "utf-8" (or one of the other Unicode variants)
3222 conversion is most likely done in a way that the reverse
3223 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003224 "utf-8" some non-ASCII characters may be lost! You can use
3225 the |++bad| argument to specify what is done with characters
3226 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 For an empty file or a file with only ASCII characters most encodings
3228 will work and the first entry of 'fileencodings' will be used (except
3229 "ucs-bom", which requires the BOM to be present). If you prefer
3230 another encoding use an BufReadPost autocommand event to test if your
3231 preferred encoding is to be used. Example: >
3232 au BufReadPost * if search('\S', 'w') == 0 |
3233 \ set fenc=iso-2022-jp | endif
3234< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3235 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003236 When the |++enc| argument is used then the value of 'fileencodings' is
3237 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003238 Note that 'fileencodings' is not used for a new file, the global value
3239 of 'fileencoding' is used instead. You can set it with: >
3240 :setglobal fenc=iso-8859-2
3241< This means that a non-existing file may get a different encoding than
3242 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 The special value "ucs-bom" can be used to check for a Unicode BOM
3244 (Byte Order Mark) at the start of the file. It must not be preceded
3245 by "utf-8" or another Unicode encoding for this to work properly.
3246 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3247 because Vim cannot detect an error, thus the encoding is always
3248 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003249 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003250 environment. On MS-Windows this is the system encoding. Otherwise
3251 this is the default value for 'encoding'. It is useful when
3252 'encoding' is set to "utf-8" and your environment uses a non-latin1
3253 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003254 When 'encoding' is "utf-8" and a file contains an illegal byte
3255 sequence it won't be recognized as UTF-8. You can use the |8g8|
3256 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 WRONG VALUES: WHAT'S WRONG:
3258 latin1,utf-8 "latin1" will always be used
3259 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3260 file
3261 cp1250,latin1 "cp1250" will always be used
3262 If 'fileencodings' is empty, 'fileencoding' is not modified.
3263 See 'fileencoding' for the possible values.
3264 Setting this option does not have an effect until the next time a file
3265 is read.
3266
3267 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003268'fileformat' 'ff' string (MS-Windows default: "dos",
3269 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 This gives the <EOL> of the current buffer, which is used for
3272 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003273 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 unix <NL>
3275 mac <CR>
3276 When "dos" is used, CTRL-Z at the end of a file is ignored.
3277 See |file-formats| and |file-read|.
3278 For the character encoding of the file see 'fileencoding'.
3279 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003280 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 This option is set automatically when starting to edit a file and
3282 'fileformats' is not empty and 'binary' is off.
3283 When this option is set, after starting to edit a file, the 'modified'
3284 option is set, because the file would be different when written.
3285 This option can not be changed when 'modifiable' is off.
3286 For backwards compatibility: When this option is set to "dos",
3287 'textmode' is set, otherwise 'textmode' is reset.
3288
3289 *'fileformats'* *'ffs'*
3290'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003291 Vim+Vi MS-Windows: "dos,unix",
3292 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 Vi Cygwin: "unix,dos",
3294 Vi others: "")
3295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 This gives the end-of-line (<EOL>) formats that will be tried when
3297 starting to edit a new buffer and when reading a file into an existing
3298 buffer:
3299 - When empty, the format defined with 'fileformat' will be used
3300 always. It is not set automatically.
3301 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003302 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 'fileformats' name will be used when a file is read into an existing
3304 buffer, no matter what 'fileformat' for that buffer is set to.
3305 - When more than one name is present, separated by commas, automatic
3306 <EOL> detection will be done when reading a file. When starting to
3307 edit a file, a check is done for the <EOL>:
3308 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3309 'fileformat' is set to "dos".
3310 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003311 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003313 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3314 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003315 This means that "mac" is only chosen when:
3316 "unix" is not present or no <NL> is found in the file, and
3317 "dos" is not present or no <CR><NL> is found in the file.
3318 Except: if "unix" was chosen, but there is a <CR> before
3319 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003320 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 4. If 'fileformat' is still not set, the first name from
3322 'fileformats' is used.
3323 When reading a file into an existing buffer, the same is done, but
3324 this happens like 'fileformat' has been set appropriately for that
3325 file only, the option is not changed.
3326 When 'binary' is set, the value of 'fileformats' is not used.
3327
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003328 When Vim starts up with an empty buffer the first item is used. You
3329 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003330
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3332 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3333 done:
3334 - When 'fileformats' is empty, there is no automatic detection. Dos
3335 format will be used.
3336 - When 'fileformats' is set to one or more names, automatic detection
3337 is done. This is based on the first <NL> in the file: If there is a
3338 <CR> in front of it, Dos format is used, otherwise Unix format is
3339 used.
3340 Also see |file-formats|.
3341 For backwards compatibility: When this option is set to an empty
3342 string or one format (no comma is included), 'textauto' is reset,
3343 otherwise 'textauto' is set.
3344 NOTE: This option is set to the Vi default value when 'compatible' is
3345 set and to the Vim default value when 'compatible' is reset.
3346
Bram Moolenaarbf884932013-04-05 22:26:15 +02003347 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3348'fileignorecase' 'fic' boolean (default on for systems where case in file
3349 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003350 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003351 When set case is ignored when using file names and directories.
3352 See 'wildignorecase' for only ignoring case when doing completion.
3353
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 *'filetype'* *'ft'*
3355'filetype' 'ft' string (default: "")
3356 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 When this option is set, the FileType autocommand event is triggered.
3358 All autocommands that match with the value of this option will be
3359 executed. Thus the value of 'filetype' is used in place of the file
3360 name.
3361 Otherwise this option does not always reflect the current file type.
3362 This option is normally set when the file type is detected. To enable
3363 this use the ":filetype on" command. |:filetype|
3364 Setting this option to a different value is most useful in a modeline,
3365 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003366 Example, for in an IDL file:
3367 /* vim: set filetype=idl : */ ~
3368 |FileType| |filetypes|
3369 When a dot appears in the value then this separates two filetype
3370 names. Example:
3371 /* vim: set filetype=c.doxygen : */ ~
3372 This will use the "c" filetype first, then the "doxygen" filetype.
3373 This works both for filetype plugins and for syntax files. More than
3374 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 This option is not copied to another buffer, independent of the 's' or
3376 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003377 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378
3379 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003380'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003382 {not available when compiled without the |+folding|
3383 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 Characters to fill the statuslines and vertical separators.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003385 It is a comma-separated list of items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386
3387 item default Used for ~
3388 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003389 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 vert:c '|' vertical separators |:vsplit|
3391 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003392 foldopen:c '-' mark the beginning of a fold
3393 foldclose:c '+' show a closed fold
3394 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003396 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003398 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003399 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 otherwise.
3401
3402 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003403 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404< This is similar to the default, except that these characters will also
3405 be used when there is highlighting.
3406
Bram Moolenaar008bff92021-03-04 21:55:58 +01003407 For "stl" and "stlnc" single-byte and multibyte characters are
3408 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003409
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 The highlighting used for these items:
3411 item highlight group ~
3412 stl:c StatusLine |hl-StatusLine|
3413 stlnc:c StatusLineNC |hl-StatusLineNC|
3414 vert:c VertSplit |hl-VertSplit|
3415 fold:c Folded |hl-Folded|
3416 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003417 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003419 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3420'fixendofline' 'fixeol' boolean (default on)
3421 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003422 When writing a file and this option is on, <EOL> at the end of file
3423 will be restored if missing. Turn this option off if you want to
3424 preserve the situation from the original file.
3425 When the 'binary' option is set the value of this option doesn't
3426 matter.
3427 See the 'endofline' option.
3428
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003430'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 {only available when compiled with the |+rightleft|
3433 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003434 This option was for using Farsi, which has been removed. See
3435 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436
3437 *'foldclose'* *'fcl'*
3438'foldclose' 'fcl' string (default "")
3439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 {not available when compiled without the |+folding|
3441 feature}
3442 When set to "all", a fold is closed when the cursor isn't in it and
3443 its level is higher than 'foldlevel'. Useful if you want folds to
3444 automatically close when moving out of them.
3445
3446 *'foldcolumn'* *'fdc'*
3447'foldcolumn' 'fdc' number (default 0)
3448 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 {not available when compiled without the |+folding|
3450 feature}
3451 When non-zero, a column with the specified width is shown at the side
3452 of the window which indicates open and closed folds. The maximum
3453 value is 12.
3454 See |folding|.
3455
3456 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3457'foldenable' 'fen' boolean (default on)
3458 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 {not available when compiled without the |+folding|
3460 feature}
3461 When off, all folds are open. This option can be used to quickly
3462 switch between showing all text unfolded and viewing the text with
3463 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003464 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 'foldenable' is off.
3466 This option is set by commands that create a new fold or close a fold.
3467 See |folding|.
3468
3469 *'foldexpr'* *'fde'*
3470'foldexpr' 'fde' string (default: "0")
3471 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003473 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003475 for each line to obtain its fold level. The context is set to the
3476 script where 'foldexpr' was set, script-local items can be accessed.
3477 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003478
Bram Moolenaar30b65812012-07-12 22:01:11 +02003479 The expression will be evaluated in the |sandbox| if set from a
3480 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003481 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003482 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003483
3484 It is not allowed to change text or jump to another window while
3485 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486
3487 *'foldignore'* *'fdi'*
3488'foldignore' 'fdi' string (default: "#")
3489 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 {not available when compiled without the |+folding|
3491 feature}
3492 Used only when 'foldmethod' is "indent". Lines starting with
3493 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003494 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 The default "#" works well for C programs. See |fold-indent|.
3496
3497 *'foldlevel'* *'fdl'*
3498'foldlevel' 'fdl' number (default: 0)
3499 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 {not available when compiled without the |+folding|
3501 feature}
3502 Sets the fold level: Folds with a higher level will be closed.
3503 Setting this option to zero will close all folds. Higher numbers will
3504 close fewer folds.
3505 This option is set by commands like |zm|, |zM| and |zR|.
3506 See |fold-foldlevel|.
3507
3508 *'foldlevelstart'* *'fdls'*
3509'foldlevelstart' 'fdls' number (default: -1)
3510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 {not available when compiled without the |+folding|
3512 feature}
3513 Sets 'foldlevel' when starting to edit another buffer in a window.
3514 Useful to always start editing with all folds closed (value zero),
3515 some folds closed (one) or no folds closed (99).
3516 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003517 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 ignores this option and closes all folds.
3519 It is also done before BufReadPre autocommands, to allow an autocmd to
3520 overrule the 'foldlevel' value for specific files.
3521 When the value is negative, it is not used.
3522
3523 *'foldmarker'* *'fmr'* *E536*
3524'foldmarker' 'fmr' string (default: "{{{,}}}")
3525 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 {not available when compiled without the |+folding|
3527 feature}
3528 The start and end marker used when 'foldmethod' is "marker". There
3529 must be one comma, which separates the start and end marker. The
3530 marker is a literal string (a regular expression would be too slow).
3531 See |fold-marker|.
3532
3533 *'foldmethod'* *'fdm'*
3534'foldmethod' 'fdm' string (default: "manual")
3535 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 {not available when compiled without the |+folding|
3537 feature}
3538 The kind of folding used for the current window. Possible values:
3539 |fold-manual| manual Folds are created manually.
3540 |fold-indent| indent Lines with equal indent form a fold.
3541 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3542 |fold-marker| marker Markers are used to specify folds.
3543 |fold-syntax| syntax Syntax highlighting items specify folds.
3544 |fold-diff| diff Fold text that is not changed.
3545
3546 *'foldminlines'* *'fml'*
3547'foldminlines' 'fml' number (default: 1)
3548 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 {not available when compiled without the |+folding|
3550 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003551 Sets the number of screen lines above which a fold can be displayed
3552 closed. Also for manually closed folds. With the default value of
3553 one a fold can only be closed if it takes up two or more screen lines.
3554 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003555 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 "zc" to close a fold, which is displayed open because it's smaller
3557 than 'foldminlines', a following "zc" may close a containing fold.
3558
3559 *'foldnestmax'* *'fdn'*
3560'foldnestmax' 'fdn' number (default: 20)
3561 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 {not available when compiled without the |+folding|
3563 feature}
3564 Sets the maximum nesting of folds for the "indent" and "syntax"
3565 methods. This avoids that too many folds will be created. Using more
3566 than 20 doesn't work, because the internal limit is 20.
3567
3568 *'foldopen'* *'fdo'*
3569'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3570 search,tag,undo")
3571 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 {not available when compiled without the |+folding|
3573 feature}
3574 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003575 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003577 NOTE: When the command is part of a mapping this option is not used.
3578 Add the |zv| command to the mapping to get the same effect.
3579 (rationale: the mapping may want to control opening folds itself)
3580
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 item commands ~
3582 all any
3583 block "(", "{", "[[", "[{", etc.
3584 hor horizontal movements: "l", "w", "fx", etc.
3585 insert any command in Insert mode
3586 jump far jumps: "G", "gg", etc.
3587 mark jumping to a mark: "'m", CTRL-O, etc.
3588 percent "%"
3589 quickfix ":cn", ":crew", ":make", etc.
3590 search search for a pattern: "/", "n", "*", "gd", etc.
3591 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003592 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 tag jumping to a tag: ":ta", CTRL-T, etc.
3594 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 When a movement command is used for an operator (e.g., "dl" or "y%")
3596 this option is not used. This means the operator will include the
3597 whole closed fold.
3598 Note that vertical movements are not here, because it would make it
3599 very difficult to move onto a closed fold.
3600 In insert mode the folds containing the cursor will always be open
3601 when text is inserted.
3602 To close folds you can re-apply 'foldlevel' with the |zx| command or
3603 set the 'foldclose' option to "all".
3604
3605 *'foldtext'* *'fdt'*
3606'foldtext' 'fdt' string (default: "foldtext()")
3607 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 {not available when compiled without the |+folding|
3609 feature}
3610 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003611 fold. The context is set to the script where 'foldexpr' was set,
3612 script-local items can be accessed. See |fold-foldtext| for the
3613 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614
Bram Moolenaar30b65812012-07-12 22:01:11 +02003615 The expression will be evaluated in the |sandbox| if set from a
3616 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003617 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003618
3619 It is not allowed to change text or jump to another window while
3620 evaluating 'foldtext' |textlock|.
3621
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003622 *'formatexpr'* *'fex'*
3623'formatexpr' 'fex' string (default "")
3624 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003625 {not available when compiled without the |+eval|
3626 feature}
3627 Expression which is evaluated to format a range of lines for the |gq|
3628 operator or automatic formatting (see 'formatoptions'). When this
3629 option is empty 'formatprg' is used.
3630
3631 The |v:lnum| variable holds the first line to be formatted.
3632 The |v:count| variable holds the number of lines to be formatted.
3633 The |v:char| variable holds the character that is going to be
3634 inserted if the expression is being evaluated due to
3635 automatic formatting. This can be empty. Don't insert
3636 it yet!
3637
3638 Example: >
3639 :set formatexpr=mylang#Format()
3640< This will invoke the mylang#Format() function in the
3641 autoload/mylang.vim file in 'runtimepath'. |autoload|
3642
3643 The expression is also evaluated when 'textwidth' is set and adding
3644 text beyond that limit. This happens under the same conditions as
3645 when internal formatting is used. Make sure the cursor is kept in the
3646 same spot relative to the text then! The |mode()| function will
3647 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003648
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003649 When the expression evaluates to non-zero Vim will fall back to using
3650 the internal format mechanism.
3651
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003652 If the expression starts with s: or |<SID>|, then it is replaced with
3653 the script ID (|local-function|). Example: >
3654 set formatexpr=s:MyFormatExpr()
3655 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003656< Otherwise, the expression is evaluated in the context of the script
3657 where the option was set, thus script-local items are available.
3658
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003659 The expression will be evaluated in the |sandbox| when set from a
3660 modeline, see |sandbox-option|. That stops the option from working,
3661 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003662 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003663 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003664
Bram Moolenaar86b68352004-12-27 21:59:20 +00003665 *'formatlistpat'* *'flp'*
3666'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3667 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003668 A pattern that is used to recognize a list header. This is used for
3669 the "n" flag in 'formatoptions'.
3670 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003671 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003672 while still checking more characters. There must be a character
3673 following the pattern, when it matches the whole line it is handled
3674 like there is no match.
3675 The default recognizes a number, followed by an optional punctuation
3676 character and white space.
3677
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003678 *'formatoptions'* *'fo'*
3679'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3680 local to buffer
3681 This is a sequence of letters which describes how automatic
3682 formatting is to be done. See |fo-table|. When the 'paste' option is
3683 on, no formatting is done (like 'formatoptions' is empty). Commas can
3684 be inserted for readability.
3685 To avoid problems with flags that are added in the future, use the
3686 "+=" and "-=" feature of ":set" |add-option-flags|.
3687 NOTE: This option is set to the Vi default value when 'compatible' is
3688 set and to the Vim default value when 'compatible' is reset.
3689
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 *'formatprg'* *'fp'*
3691'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003692 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003694 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003696 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003697 If the 'formatexpr' option is not empty it will be used instead.
3698 Otherwise, if 'formatprg' option is an empty string, the internal
3699 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003700 Environment variables are expanded |:set_env|. See |option-backslash|
3701 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003702 This option cannot be set from a |modeline| or in the |sandbox|, for
3703 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704
Bram Moolenaard94464e2015-11-02 15:28:18 +01003705 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003706'fsync' 'fs' boolean (default on)
3707 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003708 When on, the library function fsync() will be called after writing a
3709 file. This will flush a file to disk, ensuring that it is safely
3710 written even on filesystems which do metadata-only journaling. This
3711 will force the harddrive to spin up on Linux systems running in laptop
3712 mode, so it may be undesirable in some situations. Be warned that
3713 turning this off increases the chances of data loss after a crash. On
3714 systems without an fsync() implementation, this variable is always
3715 off.
3716 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003717 'fsync' also applies to |writefile()| (unless a flag is used to
3718 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003719 This option cannot be set from a |modeline| or in the |sandbox|, for
3720 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003721
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3723'gdefault' 'gd' boolean (default off)
3724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 When on, the ":substitute" flag 'g' is default on. This means that
3726 all matches in a line are substituted instead of one. When a 'g' flag
3727 is given to a ":substitute" command, this will toggle the substitution
3728 of all or one match. See |complex-change|.
3729
3730 command 'gdefault' on 'gdefault' off ~
3731 :s/// subst. all subst. one
3732 :s///g subst. one subst. all
3733 :s///gg subst. all subst. one
3734
3735 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003736 DEPRECATED: Setting this option may break plugins that are not aware
3737 of this option. Also, many users get confused that adding the /g flag
3738 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003739 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740
3741 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003742'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 Format to recognize for the ":grep" command output.
3745 This is a scanf-like string that uses the same format as the
3746 'errorformat' option: see |errorformat|.
3747
3748 *'grepprg'* *'gp'*
3749'grepprg' 'gp' string (default "grep -n ",
3750 Unix: "grep -n $* /dev/null",
3751 Win32: "findstr /n" or "grep -n",
3752 VMS: "SEARCH/NUMBERS ")
3753 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003754 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 and '#' characters, which are expanded like when used in a command-
3756 line. The placeholder "$*" is allowed to specify where the arguments
3757 will be included. Environment variables are expanded |:set_env|. See
3758 |option-backslash| about including spaces and backslashes.
3759 When your "grep" accepts the "-H" argument, use this to make ":grep"
3760 also work well with a single file: >
3761 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003762< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003763 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3764 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003765 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 apply equally to 'grepprg'.
3767 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3768 otherwise it's "grep -n".
3769 This option cannot be set from a |modeline| or in the |sandbox|, for
3770 security reasons.
3771
3772 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3773'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3774 ve:ver35-Cursor,
3775 o:hor50-Cursor,
3776 i-ci:ver25-Cursor/lCursor,
3777 r-cr:hor20-Cursor/lCursor,
3778 sm:block-Cursor
3779 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003780 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 "n-v-c:block,o:hor50,i-ci:hor15,
3782 r-cr:hor30,sm:block")
3783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003785 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003787 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003788 height of the cursor can be changed. This can be done by specifying a
3789 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003790 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3791 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003793 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 mode-list and an argument-list:
3795 mode-list:argument-list,mode-list:argument-list,..
3796 The mode-list is a dash separated list of these modes:
3797 n Normal mode
3798 v Visual mode
3799 ve Visual mode with 'selection' "exclusive" (same as 'v',
3800 if not specified)
3801 o Operator-pending mode
3802 i Insert mode
3803 r Replace mode
3804 c Command-line Normal (append) mode
3805 ci Command-line Insert mode
3806 cr Command-line Replace mode
3807 sm showmatch in Insert mode
3808 a all modes
3809 The argument-list is a dash separated list of these arguments:
3810 hor{N} horizontal bar, {N} percent of the character height
3811 ver{N} vertical bar, {N} percent of the character width
3812 block block cursor, fills the whole character
3813 [only one of the above three should be present]
3814 blinkwait{N} *cursor-blinking*
3815 blinkon{N}
3816 blinkoff{N}
3817 blink times for cursor: blinkwait is the delay before
3818 the cursor starts blinking, blinkon is the time that
3819 the cursor is shown and blinkoff is the time that the
3820 cursor is not shown. The times are in msec. When one
3821 of the numbers is zero, there is no blinking. The
3822 default is: "blinkwait700-blinkon400-blinkoff250".
3823 These numbers are used for a missing entry. This
3824 means that blinking is enabled by default. To switch
3825 blinking off you can use "blinkon0". The cursor only
3826 blinks when Vim is waiting for input, not while
3827 executing a command.
3828 To make the cursor blink in an xterm, see
3829 |xterm-blink|.
3830 {group-name}
3831 a highlight group name, that sets the color and font
3832 for the cursor
3833 {group-name}/{group-name}
3834 Two highlight group names, the first is used when
3835 no language mappings are used, the other when they
3836 are. |language-mapping|
3837
3838 Examples of parts:
3839 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3840 block cursor with colors from the "nCursor"
3841 highlight group
3842 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3843 In Insert and Command-line Insert mode, use a
3844 30% vertical bar cursor with colors from the
3845 "iCursor" highlight group. Blink a bit
3846 faster.
3847
3848 The 'a' mode is different. It will set the given argument-list for
3849 all modes. It does not reset anything to defaults. This can be used
3850 to do a common setting for all modes. For example, to switch off
3851 blinking: "a:blinkon0"
3852
3853 Examples of cursor highlighting: >
3854 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3855 :highlight Cursor gui=NONE guifg=bg guibg=fg
3856<
3857 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003858 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859'guifont' 'gfn' string (default "")
3860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 {only available when compiled with GUI enabled}
3862 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003863 In its simplest form the value is just one font name.
3864 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865
3866 *'guifontset'* *'gfs'*
3867 *E250* *E252* *E234* *E597* *E598*
3868'guifontset' 'gfs' string (default "")
3869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 {only available when compiled with GUI enabled and
3871 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003872 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 When not empty, specifies two (or more) fonts to be used. The first
3874 one for normal English, the second one for your special language. See
3875 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003876
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3878'guifontwide' 'gfw' string (default "")
3879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 {only available when compiled with GUI enabled}
3881 When not empty, specifies a comma-separated list of fonts to be used
3882 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003883 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003884
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 *'guiheadroom'* *'ghr'*
3886'guiheadroom' 'ghr' number (default 50)
3887 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003888 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 The number of pixels subtracted from the screen height when fitting
3890 the GUI window on the screen. Set this before the GUI is started,
3891 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003892 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 lines will be left for window decorations and other items on the
3894 screen. Set it to a negative value to allow windows taller than the
3895 screen.
3896
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003897 *'guiligatures'* *'gli'* *E1243*
3898'guiligatures' 'gli' string (default "")
3899 global
3900 {only for GTK GUI}
3901 List of ASCII characters that, when combined together, can create more
3902 complex shapes. Each character must be a printable ASCII character
3903 with a value in the 32-127 range.
3904 Example: >
3905 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3906< Changing this option updates screen output immediately. Set it to an
3907 empty string to disable ligatures.
3908
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003910'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3911 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003912 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003913 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003916 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 sequence of letters which describes what components and options of the
3918 GUI should be used.
3919 To avoid problems with flags that are added in the future, use the
3920 "+=" and "-=" feature of ":set" |add-option-flags|.
3921
Bram Moolenaar13568252018-03-16 20:46:58 +01003922 Valid characters are as follows:
3923 *'go-!'*
3924 '!' External commands are executed in a terminal window. Without
3925 this flag the MS-Windows GUI will open a console window to
3926 execute the command. The Unix GUI will simulate a dumb
3927 terminal to list the command output.
3928 The terminal window will be positioned at the bottom, and grow
3929 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003930 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 'a' Autoselect: If present, then whenever VISUAL mode is started,
3932 or the Visual area extended, Vim tries to become the owner of
3933 the windowing system's global selection. This means that the
3934 Visually highlighted text is available for pasting into other
3935 applications as well as into Vim itself. When the Visual mode
3936 ends, possibly due to an operation on the text, or when an
3937 application wants to paste the selection, the highlighted text
3938 is automatically yanked into the "* selection register.
3939 Thus the selection is still available for pasting into other
3940 applications after the VISUAL mode has ended.
3941 If not present, then Vim won't become the owner of the
3942 windowing system's global selection unless explicitly told to
3943 by a yank or delete operation for the "* register.
3944 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003945 *'go-P'*
3946 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003947 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003948 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003949 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 applies to the modeless selection.
3951
3952 'guioptions' autoselect Visual autoselect modeless ~
3953 "" - -
3954 "a" yes yes
3955 "A" - yes
3956 "aA" yes yes
3957
Bram Moolenaar02467872007-05-06 13:22:01 +00003958 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 'c' Use console dialogs instead of popup dialogs for simple
3960 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003961 *'go-d'*
3962 'd' Use dark theme variant if available. Currently only works for
3963 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003964 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003965 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003966 'guitablabel' can be used to change the text in the labels.
3967 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003968 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003969 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003970 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 'f' Foreground: Don't use fork() to detach the GUI from the shell
3972 where it was started. Use this for programs that wait for the
3973 editor to finish (e.g., an e-mail program). Alternatively you
3974 can use "gvim -f" or ":gui -f" to start the GUI in the
3975 foreground. |gui-fork|
3976 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003977 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003978 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3980 corner of the window. It's black&white on non-GTK, because of
3981 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003982 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003984 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003985 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003987 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003989 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003990 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 'g' Grey menu items: Make menu items that are not active grey. If
3992 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00003993 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 't' Include tearoff menu items. Currently only works for Win32,
3995 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003996 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003997 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
3998 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003999 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004001 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 'R' Right-hand scrollbar is present when there is a vertically
4003 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004004 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004006 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 'L' Left-hand scrollbar is present when there is a vertically
4008 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004009 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4011 the longest visible line, or on the cursor line if the 'h'
4012 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004013 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 'h' Limit horizontal scrollbar size to the length of the cursor
4015 line. Reduces computations. |gui-horiz-scroll|
4016
4017 And yes, you may even have scrollbars on the left AND the right if
4018 you really want to :-). See |gui-scrollbars| for more information.
4019
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004020 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 'v' Use a vertical button layout for dialogs. When not included,
4022 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004023 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004024 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 'p' Use Pointer callbacks for X11 GUI. This is required for some
4026 window managers. If the cursor is not blinking or hollow at
4027 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004028 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004030 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004031 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004032 *'go-k'*
4033 'k' Keep the GUI window size when adding/removing a scrollbar, or
4034 toolbar, tabline, etc. Instead, the behavior is similar to
4035 when the window is maximized and will adjust 'lines' and
4036 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004037 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004038 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004039
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 *'guipty'* *'noguipty'*
4041'guipty' boolean (default on)
4042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 {only available when compiled with GUI enabled}
4044 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4045 I/O to/from shell commands. See |gui-pty|.
4046
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004047 *'guitablabel'* *'gtl'*
4048'guitablabel' 'gtl' string (default empty)
4049 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004050 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004051 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004052 pages line. When empty and when the result is empty Vim will use a
4053 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004054
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004055 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004056 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004057 The expression will be evaluated in the |sandbox| when set from a
4058 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004059 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004060
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004061 Only used when the GUI tab pages line is displayed. 'e' must be
4062 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4063 used.
4064
Bram Moolenaar57657d82006-04-21 22:12:41 +00004065 *'guitabtooltip'* *'gtt'*
4066'guitabtooltip' 'gtt' string (default empty)
4067 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004068 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004069 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004070 pages line. When empty Vim will use a default tooltip.
4071 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004072 You can include a line break. Simplest method is to use |:let|: >
4073 :let &guitabtooltip = "line one\nline two"
4074<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004075
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004077'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 (others) "$VIMRUNTIME/doc/help.txt")
4079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 Name of the main help file. All distributed help files should be
4081 placed together in one directory. Additionally, all "doc" directories
4082 in 'runtimepath' will be used.
4083 Environment variables are expanded |:set_env|. For example:
4084 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004085 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 spaces and backslashes.
4087 This option cannot be set from a |modeline| or in the |sandbox|, for
4088 security reasons.
4089
4090 *'helpheight'* *'hh'*
4091'helpheight' 'hh' number (default 20)
4092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 Minimal initial height of the help window when it is opened with the
4094 ":help" command. The initial height of the help window is half of the
4095 current window, or (when the 'ea' option is on) the same as other
4096 windows. When the height is less than 'helpheight', the height is
4097 set to 'helpheight'. Set to zero to disable.
4098
4099 *'helplang'* *'hlg'*
4100'helplang' 'hlg' string (default: messages language or empty)
4101 global
4102 {only available when compiled with the |+multi_lang|
4103 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004104 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 for which the desired help can be found. The English help will always
4106 be used as a last resort. You can add "en" to prefer English over
4107 another language, but that will only find tags that exist in that
4108 language and not in the English help.
4109 Example: >
4110 :set helplang=de,it
4111< This will first search German, then Italian and finally English help
4112 files.
4113 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4114 try to find the tag in the current language before using this option.
4115 See |help-translated|.
4116
4117 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4118'hidden' 'hid' boolean (default off)
4119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 When off a buffer is unloaded when it is |abandon|ed. When on a
4121 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4122 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004123
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004125 hidden even if the 'hidden' option is off when these three are true:
4126 - the buffer is modified
4127 - 'autowrite' is off or writing is not possible
4128 - the '!' flag was used
4129 Also see |windows.txt|.
4130
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004131 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 This option is set for one command with ":hide {command}" |:hide|.
4133 WARNING: It's easy to forget that you have changes in hidden buffers.
4134 Think twice when using ":q!" or ":qa!".
4135
4136 *'highlight'* *'hl'*
4137'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004138 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4139 d:Directory,e:ErrorMsg,i:IncSearch,
4140 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004141 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004142 N:CursorLineNr,r:Question,s:StatusLine,
4143 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004144 v:Visual,V:VisualNOS,w:WarningMsg,
4145 W:WildMenu,f:Folded,F:FoldColumn,
4146 A:DiffAdd,C:DiffChange,D:DiffDelete,
4147 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004148 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004149 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004150 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4151 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004152 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004153 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004156 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004158 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004160 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4161 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 characters from 'showbreak'
4163 |hl-Directory| d directories in CTRL-D listing and other special
4164 things in listings
4165 |hl-ErrorMsg| e error messages
4166 h (obsolete, ignored)
4167 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004168 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4170 |hl-MoreMsg| m |more-prompt|
4171 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004172 |hl-LineNr| n line number for ":number" and ":#" commands, and
4173 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004174 |hl-LineNrAbove| a line number above the cursor for when the
4175 'relativenumber' option is set.
4176 |hl-LineNrBelow| b line number below the cursor for when the
4177 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004178 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4179 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 |hl-Question| r |hit-enter| prompt and yes/no questions
4181 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004182 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4184 |hl-VertSplit| c column used to separate vertically split windows
4185 |hl-Visual| v Visual mode
4186 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4187 Selection" Only X11 Gui's |gui-x11| and
4188 |xterm-clipboard|.
4189 |hl-WarningMsg| w warning messages
4190 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4191 |hl-Folded| f line used for closed folds
4192 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004193 |hl-DiffAdd| A added line in diff mode
4194 |hl-DiffChange| C changed line in diff mode
4195 |hl-DiffDelete| D deleted line in diff mode
4196 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004198 |hl-Conceal| - the placeholders used for concealed characters
4199 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004200 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004201 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004202 |hl-SpellRare| R rare word |spell|
4203 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004204 |hl-Pmenu| + popup menu normal line
4205 |hl-PmenuSel| = popup menu selected line
4206 |hl-PmenuSbar| x popup menu scrollbar
4207 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208
4209 The display modes are:
4210 r reverse (termcap entry "mr" and "me")
4211 i italic (termcap entry "ZH" and "ZR")
4212 b bold (termcap entry "md" and "me")
4213 s standout (termcap entry "so" and "se")
4214 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004215 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004216 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 n no highlighting
4218 - no highlighting
4219 : use a highlight group
4220 The default is used for occasions that are not included.
4221 If you want to change what the display modes do, see |dos-colors|
4222 for an example.
4223 When using the ':' display mode, this must be followed by the name of
4224 a highlight group. A highlight group can be used to define any type
4225 of highlighting, including using color. See |:highlight| on how to
4226 define one. The default uses a different group for each occasion.
4227 See |highlight-default| for the default highlight groups.
4228
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004230'history' 'hi' number (Vim default: 50, Vi default: 0,
4231 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004234 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004236 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 NOTE: This option is set to the Vi default value when 'compatible' is
4238 set and to the Vim default value when 'compatible' is reset.
4239
4240 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4241'hkmap' 'hk' boolean (default off)
4242 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 {only available when compiled with the |+rightleft|
4244 feature}
4245 When on, the keyboard is mapped for the Hebrew character set.
4246 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4247 toggle this option. See |rileft.txt|.
4248 NOTE: This option is reset when 'compatible' is set.
4249
4250 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4251'hkmapp' 'hkp' boolean (default off)
4252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 {only available when compiled with the |+rightleft|
4254 feature}
4255 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4256 This is useful if you have a non-Hebrew keyboard.
4257 See |rileft.txt|.
4258 NOTE: This option is reset when 'compatible' is set.
4259
Bram Moolenaar036986f2017-03-16 17:41:02 +01004260 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4261'hlsearch' 'hls' boolean (default off)
4262 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004263 {not available when compiled without the
4264 |+extra_search| feature}
4265 When there is a previous search pattern, highlight all its matches.
4266 The type of highlighting used can be set with the 'l' occasion in the
4267 'highlight' option. This uses the "Search" highlight group by
4268 default. Note that only the matching text is highlighted, any offsets
4269 are not applied.
4270 See also: 'incsearch' and |:match|.
4271 When you get bored looking at the highlighted matches, you can turn it
4272 off with |:nohlsearch|. This does not change the option value, as
4273 soon as you use a search command, the highlighting comes back.
4274 'redrawtime' specifies the maximum time spent on finding matches.
4275 When the search pattern can match an end-of-line, Vim will try to
4276 highlight all of the matched text. However, this depends on where the
4277 search starts. This will be the first line in the window or the first
4278 line below a closed fold. A match in a previous line which is not
4279 drawn may not continue in a newly drawn line.
4280 You can specify whether the highlight status is restored on startup
4281 with the 'h' flag in 'viminfo' |viminfo-h|.
4282 NOTE: This option is reset when 'compatible' is set.
4283
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 *'icon'* *'noicon'*
4285'icon' boolean (default off, on when title can be restored)
4286 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 When on, the icon text of the window will be set to the value of
4288 'iconstring' (if it is not empty), or to the name of the file
4289 currently being edited. Only the last part of the name is used.
4290 Overridden by the 'iconstring' option.
4291 Only works if the terminal supports setting window icons (currently
4292 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4293 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4294 builtin termcap).
4295 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004296 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004298 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299
4300 *'iconstring'*
4301'iconstring' string (default "")
4302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 When this option is not empty, it will be used for the icon text of
4304 the window. This happens only when the 'icon' option is on.
4305 Only works if the terminal supports setting window icon text
4306 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004307 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 When Vim was compiled with HAVE_X11 defined, the original icon will be
4309 restored if possible |X11|.
4310 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004311 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004313 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 {not available when compiled without the |+statusline| feature}
4315
4316 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4317'ignorecase' 'ic' boolean (default off)
4318 global
4319 Ignore case in search patterns. Also used when searching in the tags
4320 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004321 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 Can be overruled by using "\c" or "\C" in the pattern, see
4323 |/ignorecase|.
4324
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004325 *'imactivatefunc'* *'imaf'*
4326'imactivatefunc' 'imaf' string (default "")
4327 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004328 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004329 activate or deactivate the Input Method. The value can be the name of
4330 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4331 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004332 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004333 The expression will be evaluated in the |sandbox| when set from a
4334 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004335
4336 Example: >
4337 function ImActivateFunc(active)
4338 if a:active
4339 ... do something
4340 else
4341 ... do something
4342 endif
4343 " return value is not used
4344 endfunction
4345 set imactivatefunc=ImActivateFunc
4346<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 *'imactivatekey'* *'imak'*
4348'imactivatekey' 'imak' string (default "")
4349 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004351 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 Specifies the key that your Input Method in X-Windows uses for
4353 activation. When this is specified correctly, vim can fully control
4354 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4355 You can't use this option to change the activation key, the option
4356 tells Vim what the key is.
4357 Format:
4358 [MODIFIER_FLAG-]KEY_STRING
4359
4360 These characters can be used for MODIFIER_FLAG (case is ignored):
4361 S Shift key
4362 L Lock key
4363 C Control key
4364 1 Mod1 key
4365 2 Mod2 key
4366 3 Mod3 key
4367 4 Mod4 key
4368 5 Mod5 key
4369 Combinations are allowed, for example "S-C-space" or "SC-space" are
4370 both shift+ctrl+space.
4371 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4372
4373 Example: >
4374 :set imactivatekey=S-space
4375< "S-space" means shift+space. This is the activation key for kinput2 +
4376 canna (Japanese), and ami (Korean).
4377
4378 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4379'imcmdline' 'imc' boolean (default off)
4380 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 When set the Input Method is always on when starting to edit a command
4382 line, unless entering a search pattern (see 'imsearch' for that).
4383 Setting this option is useful when your input method allows entering
4384 English characters directly, e.g., when it's used to type accented
4385 characters with dead keys.
4386
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004387 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 When set the Input Method is never used. This is useful to disable
4391 the IM when it doesn't work properly.
4392 Currently this option is on by default for SGI/IRIX machines. This
4393 may change in later releases.
4394
4395 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004396'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 Specifies whether :lmap or an Input Method (IM) is to be used in
4399 Insert mode. Valid values:
4400 0 :lmap is off and IM is off
4401 1 :lmap is ON and IM is off
4402 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 To always reset the option to zero when leaving Insert mode with <Esc>
4404 this can be used: >
4405 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4406< This makes :lmap and IM turn off automatically when leaving Insert
4407 mode.
4408 Note that this option changes when using CTRL-^ in Insert mode
4409 |i_CTRL-^|.
4410 The value is set to 1 when setting 'keymap' to a valid keymap name.
4411 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004412 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 methods. Use 'imdisable' to disable XIM then.
4414
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004415 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004416 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004417 |+multi_byte_ime| or |global-ime|.
4418
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004420'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 Specifies whether :lmap or an Input Method (IM) is to be used when
4423 entering a search pattern. Valid values:
4424 -1 the value of 'iminsert' is used, makes it look like
4425 'iminsert' is also used when typing a search pattern
4426 0 :lmap is off and IM is off
4427 1 :lmap is ON and IM is off
4428 2 :lmap is off and IM is ON
4429 Note that this option changes when using CTRL-^ in Command-line mode
4430 |c_CTRL-^|.
4431 The value is set to 1 when it is not -1 and setting the 'keymap'
4432 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004433 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 methods. Use 'imdisable' to disable XIM then.
4435
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004436 *'imstatusfunc'* *'imsf'*
4437'imstatusfunc' 'imsf' string (default "")
4438 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004439 This option specifies a function that is called to obtain the status
4440 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004441 The value can be the name of a function, a |lambda| or a |Funcref|.
4442 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004443 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004444
4445 Example: >
4446 function ImStatusFunc()
4447 let is_active = ...do something
4448 return is_active ? 1 : 0
4449 endfunction
4450 set imstatusfunc=ImStatusFunc
4451<
4452 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004453 The expression will be evaluated in the |sandbox| when set from a
4454 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004455
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004456 *'imstyle'* *'imst'*
4457'imstyle' 'imst' number (default 1)
4458 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004459 {only available when compiled with |+xim| and
4460 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004461 This option specifies the input style of Input Method:
4462 0 use on-the-spot style
4463 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004464 See: |xim-input-style|
4465
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004466 For a long time on-the-spot style had been used in the GTK version of
4467 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004468 |single-repeat|, etc. Therefore over-the-spot style becomes the
4469 default now. This should work fine for most people, however if you
4470 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004471 The expression will be evaluated in the |sandbox| when set from a
4472 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004473
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 *'include'* *'inc'*
4475'include' 'inc' string (default "^\s*#\s*include")
4476 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 {not available when compiled without the
4478 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004479 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 pattern, just like for the "/" command (See |pattern|). The default
4481 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004482 "]I", "[d", etc.
4483 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004484 comes after the matched pattern. But if "\zs" appears in the pattern
4485 then the text matched from "\zs" to the end, or until "\ze" if it
4486 appears, is used as the file name. Use this to include characters
4487 that are not in 'isfname', such as a space. You can then use
4488 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004489 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490
4491 *'includeexpr'* *'inex'*
4492'includeexpr' 'inex' string (default "")
4493 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004495 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004497 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 :set includeexpr=substitute(v:fname,'\\.','/','g')
4499< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004500
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004502 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 Also used for |<cfile>|.
4504
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004505 If the expression starts with s: or |<SID>|, then it is replaced with
4506 the script ID (|local-function|). Example: >
4507 set includeexpr=s:MyIncludeExpr(v:fname)
4508 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004509< Otherwise, the expression is evaluated in the context of the script
4510 where the option was set, thus script-local items are available.
4511
Bram Moolenaar30b65812012-07-12 22:01:11 +02004512 The expression will be evaluated in the |sandbox| when set from a
4513 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004514 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004515
4516 It is not allowed to change text or jump to another window while
4517 evaluating 'includeexpr' |textlock|.
4518
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004520'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4521 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004524 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004525 While typing a search command, show where the pattern, as it was typed
4526 so far, matches. The matched string is highlighted. If the pattern
4527 is invalid or not found, nothing is shown. The screen will be updated
4528 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004529 Also applies to the pattern in commands: >
4530 :global
4531 :lvimgrep
4532 :lvimgrepadd
4533 :smagic
4534 :snomagic
4535 :sort
4536 :substitute
4537 :vglobal
4538 :vimgrep
4539 :vimgrepadd
4540< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004541 original position when no match is found and when pressing <Esc>. You
4542 still need to finish the search command with <Enter> to move the
4543 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004544 You can use the CTRL-G and CTRL-T keys to move to the next and
4545 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004546 When compiled with the |+reltime| feature Vim only searches for about
4547 half a second. With a complicated pattern and/or a lot of text the
4548 match may not be found. This is to avoid that Vim hangs while you
4549 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004550 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004551 When 'hlsearch' is on, all matched strings are highlighted too while
4552 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004553 If you don't want to turn 'hlsearch' on, but want to highlight all
4554 matches while searching, you can turn on and off 'hlsearch' with
4555 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004556 augroup vimrc-incsearch-highlight
4557 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004558 autocmd CmdlineEnter /,\? :set hlsearch
4559 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004560 augroup END
4561<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004562 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004563 to the command line. If 'ignorecase' and 'smartcase' are set and the
4564 command line has no uppercase characters, the added character is
4565 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004566 CTRL-R CTRL-W can be used to add the word at the end of the current
4567 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 NOTE: This option is reset when 'compatible' is set.
4569
4570 *'indentexpr'* *'inde'*
4571'indentexpr' 'inde' string (default "")
4572 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 {not available when compiled without the |+cindent|
4574 or |+eval| features}
4575 Expression which is evaluated to obtain the proper indent for a line.
4576 It is used when a new line is created, for the |=| operator and
4577 in Insert mode as specified with the 'indentkeys' option.
4578 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004579 'smartindent' indenting. When 'lisp' is set, this option is
4580 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 When 'paste' is set this option is not used for indenting.
4582 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004583 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004585
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004586 If the expression starts with s: or |<SID>|, then it is replaced with
4587 the script ID (|local-function|). Example: >
4588 set indentexpr=s:MyIndentExpr()
4589 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004590< Otherwise, the expression is evaluated in the context of the script
4591 where the option was set, thus script-local items are available.
4592
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 The expression must return the number of spaces worth of indent. It
4594 can return "-1" to keep the current indent (this means 'autoindent' is
4595 used for the indent).
4596 Functions useful for computing the indent are |indent()|, |cindent()|
4597 and |lispindent()|.
4598 The evaluation of the expression must not have side effects! It must
4599 not change the text, jump to another window, etc. Afterwards the
4600 cursor position is always restored, thus the cursor may be moved.
4601 Normally this option would be set to call a function: >
4602 :set indentexpr=GetMyIndent()
4603< Error messages will be suppressed, unless the 'debug' option contains
4604 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004605 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004606 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607
Bram Moolenaar30b65812012-07-12 22:01:11 +02004608 The expression will be evaluated in the |sandbox| when set from a
4609 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004610 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004611
4612 It is not allowed to change text or jump to another window while
4613 evaluating 'indentexpr' |textlock|.
4614
4615
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004617'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 {not available when compiled without the |+cindent|
4620 feature}
4621 A list of keys that, when typed in Insert mode, cause reindenting of
4622 the current line. Only happens if 'indentexpr' isn't empty.
4623 The format is identical to 'cinkeys', see |indentkeys-format|.
4624 See |C-indenting| and |indent-expression|.
4625
4626 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4627'infercase' 'inf' boolean (default off)
4628 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004630 'ignorecase' is also on, the case of the match is adjusted depending
4631 on the typed text. If the typed text contains a lowercase letter
4632 where the match has an upper case letter, the completed part is made
4633 lowercase. If the typed text has no lowercase letters and the match
4634 has a lowercase letter where the typed text has an uppercase letter,
4635 and there is a letter before it, the completed part is made uppercase.
4636 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637
4638 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4639'insertmode' 'im' boolean (default off)
4640 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 Makes Vim work in a way that Insert mode is the default mode. Useful
4642 if you want to use Vim as a modeless editor. Used for |evim|.
4643 These Insert mode commands will be useful:
4644 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004645 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 this is a mapping, it is executed as if 'insertmode' was off.
4647 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004649 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4650 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651
4652 These items change when 'insertmode' is set:
4653 - when starting to edit of a file, Vim goes to Insert mode.
4654 - <Esc> in Insert mode is a no-op and beeps.
4655 - <Esc> in Normal mode makes Vim go to Insert mode.
4656 - CTRL-L in Insert mode is a command, it is not inserted.
4657 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4658 However, when <Esc> is used inside a mapping, it behaves like
4659 'insertmode' was not set. This was done to be able to use the same
4660 mappings with 'insertmode' set or not set.
4661 When executing commands with |:normal| 'insertmode' is not used.
4662
4663 NOTE: This option is reset when 'compatible' is set.
4664
4665 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004666'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4668 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4669 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4670 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4671 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 The characters specified by this option are included in file names and
4674 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004675 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 Multi-byte characters 256 and above are always included, only the
4677 characters up to 255 are specified with this option.
4678 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004679 Think twice before adding white space to this option. Although a
4680 space may appear inside a file name, the effect will be that Vim
4681 doesn't know where a file name starts or ends when doing completion.
4682 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683
4684 Note that on systems using a backslash as path separator, Vim tries to
4685 do its best to make it work as you would expect. That is a bit
4686 tricky, since Vi originally used the backslash to escape special
4687 characters. Vim will not remove a backslash in front of a normal file
4688 name character on these systems, but it will on Unix and alikes. The
4689 '&' and '^' are not included by default, because these are special for
4690 cmd.exe.
4691
4692 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004693 Each part can be a single character number or a range. A range is two
4694 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 decimal number between 0 and 255 or the ASCII character itself (does
4696 not work for digits). Example:
4697 "_,-,128-140,#-43" (include '_' and '-' and the range
4698 128 to 140 and '#' to 43)
4699 If a part starts with '^', the following character number or range
4700 will be excluded from the option. The option is interpreted from left
4701 to right. Put the excluded character after the range where it is
4702 included. To include '^' itself use it as the last character of the
4703 option or the end of a range. Example:
4704 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4705 If the character is '@', all characters where isalpha() returns TRUE
4706 are included. Normally these are the characters a to z and A to Z,
4707 plus accented characters. To include '@' itself use "@-@". Examples:
4708 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004709 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 "a-z,A-Z,@-@" All letters plus the '@' character.
4711 A comma can be included by using it where a character number is
4712 expected. Example:
4713 "48-57,,,_" Digits, comma and underscore.
4714 A comma can be excluded by prepending a '^'. Example:
4715 " -~,^,,9" All characters from space to '~', excluding
4716 comma, plus <Tab>.
4717 See |option-backslash| about including spaces and backslashes.
4718
4719 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004720'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 "@,48-57,_,128-167,224-235"
4722 otherwise: "@,48-57,_,192-255")
4723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 The characters given by this option are included in identifiers.
4725 Identifiers are used in recognizing environment variables and after a
4726 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004727 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004728 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004730 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4732
4733 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004734'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 "@,48-57,_,128-167,224-235"
4736 otherwise: "@,48-57,_,192-255"
4737 Vi default: "@,48-57,_")
4738 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004740 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004741 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004742 characters above 255 check the "word" character class (any character
4743 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004744 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 For a help file it is set to all non-blank printable characters except
4746 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4747 command).
4748 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004749 This option also influences syntax highlighting, unless the syntax
4750 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 NOTE: This option is set to the Vi default value when 'compatible' is
4752 set and to the Vim default value when 'compatible' is reset.
4753
4754 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004755'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 "@,~-255"; otherwise: "@,161-255")
4757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 The characters given by this option are displayed directly on the
4759 screen. It is also used for "\p" in a |pattern|. The characters from
4760 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4761 even when they are not included in 'isprint' or excluded. See
4762 'isfname' for a description of the format of this option.
4763
4764 Non-printable characters are displayed with two characters:
4765 0 - 31 "^@" - "^_"
4766 32 - 126 always single characters
4767 127 "^?"
4768 128 - 159 "~@" - "~_"
4769 160 - 254 "| " - "|~"
4770 255 "~?"
4771 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4772 displayed as <xx>, with the hexadecimal value of the byte.
4773 When 'display' contains "uhex" all unprintable characters are
4774 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004775 The SpecialKey highlighting will be used for unprintable characters.
4776 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777
4778 Multi-byte characters 256 and above are always included, only the
4779 characters up to 255 are specified with this option. When a character
4780 is printable but it is not available in the current font, a
4781 replacement character will be shown.
4782 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4783 There is no option to specify these characters.
4784
4785 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4786'joinspaces' 'js' boolean (default on)
4787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 Insert two spaces after a '.', '?' and '!' with a join command.
4789 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4790 Otherwise only one space is inserted.
4791 NOTE: This option is set when 'compatible' is set.
4792
4793 *'key'*
4794'key' string (default "")
4795 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004796 {only available when compiled with the |+cryptv|
4797 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004799 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 Careful: Do not set the key value by hand, someone might see the typed
4801 key. Use the |:X| command. But you can make 'key' empty: >
4802 :set key=
4803< It is not possible to get the value of this option with ":set key" or
4804 "echo &key". This is to avoid showing it to someone who shouldn't
4805 know. It also means you cannot see it yourself once you have set it,
4806 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004807 You can use "&key" in an expression to detect whether encryption is
4808 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809
4810 *'keymap'* *'kmp'* *E544*
4811'keymap' 'kmp' string (default "")
4812 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 {only available when compiled with the |+keymap|
4814 feature}
4815 Name of a keyboard mapping. See |mbyte-keymap|.
4816 Setting this option to a valid keymap name has the side effect of
4817 setting 'iminsert' to one, so that the keymap becomes effective.
4818 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004819 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820
4821 *'keymodel'* *'km'*
4822'keymodel' 'km' string (default "")
4823 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004824 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 can do. These values can be used:
4826 startsel Using a shifted special key starts selection (either
4827 Select mode or Visual mode, depending on "key" being
4828 present in 'selectmode').
4829 stopsel Using a not-shifted special key stops selection.
4830 Special keys in this context are the cursor keys, <End>, <Home>,
4831 <PageUp> and <PageDown>.
4832 The 'keymodel' option is set by the |:behave| command.
4833
4834 *'keywordprg'* *'kp'*
4835'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004836 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 Program to use for the |K| command. Environment variables are
4839 expanded |:set_env|. ":help" may be used to access the Vim internal
4840 help. (Note that previously setting the global option to the empty
4841 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004842 When the first character is ":", the command is invoked as a Vim
4843 Ex command prefixed with [count].
4844 When "man", "man -s" or an Ex command is used, Vim will automatically
4845 translate a count for the "K" command and pass it as the first
4846 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 See |option-backslash| about including spaces and backslashes.
4848 Example: >
4849 :set keywordprg=man\ -s
4850< This option cannot be set from a |modeline| or in the |sandbox|, for
4851 security reasons.
4852
4853 *'langmap'* *'lmap'* *E357* *E358*
4854'langmap' 'lmap' string (default "")
4855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 {only available when compiled with the |+langmap|
4857 feature}
4858 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004859 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004860 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861 care of translating these special characters to the original meaning
4862 of the key. This means you don't have to change the keyboard mode to
4863 be able to execute Normal mode commands.
4864 This is the opposite of the 'keymap' option, where characters are
4865 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004866 Also consider setting 'langremap' to off, to prevent 'langmap' from
4867 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004868 This option cannot be set from a |modeline| or in the |sandbox|, for
4869 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004871 Example (for Greek, in UTF-8): *greek* >
4872 :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 +00004873< Example (exchanges meaning of z and y for commands): >
4874 :set langmap=zy,yz,ZY,YZ
4875<
4876 The 'langmap' option is a list of parts, separated with commas. Each
4877 part can be in one of two forms:
4878 1. A list of pairs. Each pair is a "from" character immediately
4879 followed by the "to" character. Examples: "aA", "aAbBcC".
4880 2. A list of "from" characters, a semi-colon and a list of "to"
4881 characters. Example: "abc;ABC"
4882 Example: "aA,fgh;FGH,cCdDeE"
4883 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004884 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885
4886 This will allow you to activate vim actions without having to switch
4887 back and forth between the languages. Your language characters will
4888 be understood as normal vim English characters (according to the
4889 langmap mappings) in the following cases:
4890 o Normal/Visual mode (commands, buffer/register names, user mappings)
4891 o Insert/Replace Mode: Register names after CTRL-R
4892 o Insert/Replace Mode: Mappings
4893 Characters entered in Command-line mode will NOT be affected by
4894 this option. Note that this option can be changed at any time
4895 allowing to switch between mappings for different languages/encodings.
4896 Use a mapping to avoid having to type it each time!
4897
4898 *'langmenu'* *'lm'*
4899'langmenu' 'lm' string (default "")
4900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 {only available when compiled with the |+menu| and
4902 |+multi_lang| features}
4903 Language to use for menu translation. Tells which file is loaded
4904 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004905 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906< (without the spaces). For example, to always use the Dutch menus, no
4907 matter what $LANG is set to: >
4908 :set langmenu=nl_NL.ISO_8859-1
4909< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004910 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 If your $LANG is set to a non-English language but you do want to use
4912 the English menus: >
4913 :set langmenu=none
4914< This option must be set before loading menus, switching on filetype
4915 detection or syntax highlighting. Once the menus are defined setting
4916 this option has no effect. But you could do this: >
4917 :source $VIMRUNTIME/delmenu.vim
4918 :set langmenu=de_DE.ISO_8859-1
4919 :source $VIMRUNTIME/menu.vim
4920< Warning: This deletes all menus that you defined yourself!
4921
Bram Moolenaard94464e2015-11-02 15:28:18 +01004922 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004923'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004924 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004925 {only available when compiled with the |+langmap|
4926 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004927 This is just like 'langremap' but with the value inverted. It only
4928 exists for backwards compatibility. When setting 'langremap' then
4929 'langnoremap' is set to the inverted value, and the other way around.
4930
4931 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004932'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004933 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004934 {only available when compiled with the |+langmap|
4935 feature}
4936 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004937 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004938 'langmap' disables some of your mappings, try resetting this option.
4939 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004940 that works for you to avoid mappings to break.
4941
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 *'laststatus'* *'ls'*
4943'laststatus' 'ls' number (default 1)
4944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 The value of this option influences when the last window will have a
4946 status line:
4947 0: never
4948 1: only if there are at least two windows
4949 2: always
4950 The screen looks nicer with a status line if you have several
4951 windows, but it takes another screen line. |status-line|
4952
4953 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4954'lazyredraw' 'lz' boolean (default off)
4955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 When this option is set, the screen will not be redrawn while
4957 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004958 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 update use |:redraw|.
4960
4961 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4962'linebreak' 'lbr' boolean (default off)
4963 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004964 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004966 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 than at the last character that fits on the screen. Unlike
4968 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004969 it only affects the way the file is displayed, not its contents.
4970 If 'breakindent' is set, line is visually indented. Then, the value
4971 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004972 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 Note that <Tab> characters after an <EOL> are mostly not displayed
4974 with the right amount of white space.
4975
4976 *'lines'* *E593*
4977'lines' number (default 24 or terminal height)
4978 global
4979 Number of lines of the Vim window.
4980 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004981 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 When Vim is running in the GUI or in a resizable window, setting this
4983 option will cause the window size to be changed. When you only want
4984 to use the size for the GUI, put the command in your |gvimrc| file.
4985 Vim limits the number of lines to what fits on the screen. You can
4986 use this command to get the tallest window possible: >
4987 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004988< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004989 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 When you set this option and Vim is unable to change the physical
4991 number of lines of the display, the display may be messed up.
4992
4993 *'linespace'* *'lsp'*
4994'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 {only in the GUI}
4997 Number of pixel lines inserted between characters. Useful if the font
4998 uses the full character cell height, making lines touch each other.
4999 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005000 With some fonts there can be too much room between lines (to have
5001 space for ascents and descents). Then it makes sense to set
5002 'linespace' to a negative value. This may cause display problems
5003 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004
5005 *'lisp'* *'nolisp'*
5006'lisp' boolean (default off)
5007 local to buffer
5008 {not available when compiled without the |+lispindent|
5009 feature}
5010 Lisp mode: When <Enter> is typed in insert mode set the indent for
5011 the next line to Lisp standards (well, sort of). Also happens with
5012 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5013 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5014 better. Also see 'lispwords'.
5015 The '-' character is included in keyword characters. Redefines the
5016 "=" operator to use this same indentation algorithm rather than
5017 calling an external program if 'equalprg' is empty.
5018 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019
5020 *'lispwords'* *'lw'*
5021'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005022 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 {not available when compiled without the |+lispindent|
5024 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005025 Comma-separated list of words that influence the Lisp indenting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 |'lisp'|
5027
5028 *'list'* *'nolist'*
5029'list' boolean (default off)
5030 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005031 List mode: By default show tabs as CTRL-I is displayed, display $
5032 after end of line. Useful to see the difference between tabs and
5033 spaces and for trailing blanks. Further changed by the 'listchars'
5034 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005035
5036 The cursor is displayed at the start of the space a Tab character
5037 occupies, not at the end as usual in Normal mode. To get this cursor
5038 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005039 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005040<
5041 Note that list mode will also affect formatting (set with 'textwidth'
5042 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 changing the way tabs are displayed.
5044
5045 *'listchars'* *'lcs'*
5046'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005047 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005048 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005049 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005050 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 eol:c Character to show at the end of each line. When
5052 omitted, there is no extra character at the end of the
5053 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005054 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005055 tab:xy[z] Two or three characters to be used to show a tab.
5056 The third character is optional.
5057
5058 tab:xy The 'x' is always used, then 'y' as many times as will
5059 fit. Thus "tab:>-" displays:
5060 >
5061 >-
5062 >--
5063 etc.
5064
5065 tab:xyz The 'z' is always used, then 'x' is prepended, and
5066 then 'y' is used as many times as will fit. Thus
5067 "tab:<->" displays:
5068 >
5069 <>
5070 <->
5071 <-->
5072 etc.
5073
5074 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005075 *lcs-space*
5076 space:c Character to show for a space. When omitted, spaces
5077 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005078 *lcs-multispace*
5079 multispace:c...
5080 One or more characters to use cyclically to show for
5081 multiple consecutive spaces. Overrides the "space"
5082 setting, except for single spaces. When omitted, the
5083 "space" setting is used. For example,
5084 `:set listchars=multispace:---+` shows ten consecutive
5085 spaces as:
5086 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005087 *lcs-lead*
5088 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005089 leading spaces are blank. Overrides the "space" and
5090 "multispace" settings for leading spaces. You can
5091 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005092 :set listchars+=tab:>-,lead:.
5093< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005094 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005095 trailing spaces are blank. Overrides the "space" and
5096 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005097 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 extends:c Character to show in the last column, when 'wrap' is
5099 off and the line continues beyond the right of the
5100 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005101 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005102 precedes:c Character to show in the first visible column of the
5103 physical line, when there is text preceding the
5104 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005105 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005106 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005107 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005108 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005109 nbsp:c Character to show for a non-breakable space character
5110 (0xA0 (160 decimal) and U+202F). Left blank when
5111 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005113 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005115 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005117 Each character can be specified as hex: >
5118 set listchars=eol:\\x24
5119 set listchars=eol:\\u21b5
5120 set listchars=eol:\\U000021b5
5121< Note that a double backslash is used. The number of hex characters
5122 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5123
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 Examples: >
5125 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005126 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127 :set lcs=extends:>,precedes:<
5128< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005129 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5130 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005131 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132
5133 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5134'loadplugins' 'lpl' boolean (default on)
5135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 When on the plugin scripts are loaded when starting up |load-plugins|.
5137 This option can be reset in your |vimrc| file to disable the loading
5138 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005139 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5140 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141
Bram Moolenaard94464e2015-11-02 15:28:18 +01005142 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005143'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005144 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005145 {only available when compiled with the |+lua/dyn|
5146 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005147 Specifies the name of the Lua shared library. The default is
5148 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005149 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005150 This option cannot be set from a |modeline| or in the |sandbox|, for
5151 security reasons.
5152
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005153 *'macatsui'* *'nomacatsui'*
5154'macatsui' boolean (default on)
5155 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005156 {not supported}
5157 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005158
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 *'magic'* *'nomagic'*
5160'magic' boolean (default on)
5161 global
5162 Changes the special characters that can be used in search patterns.
5163 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005164 WARNING: Switching this option off most likely breaks plugins! That
5165 is because many patterns assume it's on and will fail when it's off.
5166 Only switch it off when working with old Vi scripts. In any other
5167 situation write patterns that work when 'magic' is on. Include "\M"
5168 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005169 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5170 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171
5172 *'makeef'* *'mef'*
5173'makeef' 'mef' string (default: "")
5174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 {not available when compiled without the |+quickfix|
5176 feature}
5177 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5178 and the |:grep| command.
5179 When it is empty, an internally generated temp file will be used.
5180 When "##" is included, it is replaced by a number to make the name
5181 unique. This makes sure that the ":make" command doesn't overwrite an
5182 existing file.
5183 NOT used for the ":cf" command. See 'errorfile' for that.
5184 Environment variables are expanded |:set_env|.
5185 See |option-backslash| about including spaces and backslashes.
5186 This option cannot be set from a |modeline| or in the |sandbox|, for
5187 security reasons.
5188
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005189 *'makeencoding'* *'menc'*
5190'makeencoding' 'menc' string (default "")
5191 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005192 Encoding used for reading the output of external commands. When empty,
5193 encoding is not converted.
5194 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5195 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5196 and `:laddfile`.
5197
5198 This would be mostly useful when you use MS-Windows and set 'encoding'
5199 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5200 'makeencoding' to "char" has the same effect as setting to the system
5201 locale encoding. Example: >
5202 :set encoding=utf-8
5203 :set makeencoding=char " system locale is used
5204<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 *'makeprg'* *'mp'*
5206'makeprg' 'mp' string (default "make", VMS: "MMS")
5207 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005208 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005209 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5210 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005211 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005212 Environment variables are expanded |:set_env|. See |option-backslash|
5213 about including spaces and backslashes.
5214 Note that a '|' must be escaped twice: once for ":set" and once for
5215 the interpretation of a command. When you use a filter called
5216 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 :set makeprg=gmake\ \\\|\ myfilter
5218< The placeholder "$*" can be given (even multiple times) to specify
5219 where the arguments will be included, for example: >
5220 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5221< This option cannot be set from a |modeline| or in the |sandbox|, for
5222 security reasons.
5223
5224 *'matchpairs'* *'mps'*
5225'matchpairs' 'mps' string (default "(:),{:},[:]")
5226 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005228 other.
5229 Only character pairs are allowed that are different, thus you cannot
5230 jump between two double quotes.
5231 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005232 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005233 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234 :set mps+=<:>
5235
5236< A more exotic example, to jump between the '=' and ';' in an
5237 assignment, useful for languages like C and Java: >
5238 :au FileType c,cpp,java set mps+==:;
5239
5240< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005241 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242
5243 *'matchtime'* *'mat'*
5244'matchtime' 'mat' number (default 5)
5245 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 Tenths of a second to show the matching paren, when 'showmatch' is
5247 set. Note that this is not in milliseconds, like other options that
5248 set a time. This is to be compatible with Nvi.
5249
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005250 *'maxcombine'* *'mco'*
5251'maxcombine' 'mco' number (default 2)
5252 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005253 The maximum number of combining characters supported for displaying.
5254 Only used when 'encoding' is "utf-8".
5255 The default is OK for most languages. Hebrew may require 4.
5256 Maximum value is 6.
5257 Even when this option is set to 2 you can still edit text with more
5258 combining characters, you just can't see them. Use |g8| or |ga|.
5259 See |mbyte-combining|.
5260
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 *'maxfuncdepth'* *'mfd'*
5262'maxfuncdepth' 'mfd' number (default 100)
5263 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005264 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005265 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 Maximum depth of function calls for user functions. This normally
5267 catches endless recursion. When using a recursive function with
5268 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5269 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005270 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005271 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 See also |:function|.
5273
5274 *'maxmapdepth'* *'mmd'* *E223*
5275'maxmapdepth' 'mmd' number (default 1000)
5276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 Maximum number of times a mapping is done without resulting in a
5278 character to be used. This normally catches endless mappings, like
5279 ":map x y" with ":map y x". It still does not catch ":map g wg",
5280 because the 'w' is used before the next mapping is done. See also
5281 |key-mapping|.
5282
5283 *'maxmem'* *'mm'*
5284'maxmem' 'mm' number (default between 256 to 5120 (system
5285 dependent) or half the amount of memory
5286 available)
5287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5289 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005290 other memory to be freed.
5291 The maximum usable value is about 2000000. Use this to work without a
5292 limit.
5293 The value is ignored when 'swapfile' is off.
5294 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005296 *'maxmempattern'* *'mmp'*
5297'maxmempattern' 'mmp' number (default 1000)
5298 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005299 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005300 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005301 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005302 When Vim runs into the limit it gives an error message and mostly
5303 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005304 Running into the limit often means that the pattern is very
5305 inefficient or too complex. This may already happen with the pattern
5306 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005307 Might also happen on redraw, when syntax rules try to match a complex
5308 text structure.
5309 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5310 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005311
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 *'maxmemtot'* *'mmt'*
5313'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5314 dependent) or half the amount of memory
5315 available)
5316 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005317 Maximum amount of memory in Kbyte to use for all buffers together.
5318 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005319 without a limit.
5320 On 64 bit machines higher values might work. But hey, do you really
5321 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005322 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005323 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005324 Buffers with 'swapfile' off still count to the total amount of memory
5325 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005326 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327
5328 *'menuitems'* *'mis'*
5329'menuitems' 'mis' number (default 25)
5330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 {not available when compiled without the |+menu|
5332 feature}
5333 Maximum number of items to use in a menu. Used for menus that are
5334 generated from a list of items, e.g., the Buffers menu. Changing this
5335 option has no direct effect, the menu must be refreshed first.
5336
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005337 *'mkspellmem'* *'msm'*
5338'mkspellmem' 'msm' string (default "460000,2000,500")
5339 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005340 {not available when compiled without the |+syntax|
5341 feature}
5342 Parameters for |:mkspell|. This tunes when to start compressing the
5343 word tree. Compression can be slow when there are many words, but
5344 it's needed to avoid running out of memory. The amount of memory used
5345 per word depends very much on how similar the words are, that's why
5346 this tuning is complicated.
5347
5348 There are three numbers, separated by commas:
5349 {start},{inc},{added}
5350
5351 For most languages the uncompressed word tree fits in memory. {start}
5352 gives the amount of memory in Kbyte that can be used before any
5353 compression is done. It should be a bit smaller than the amount of
5354 memory that is available to Vim.
5355
5356 When going over the {start} limit the {inc} number specifies the
5357 amount of memory in Kbyte that can be allocated before another
5358 compression is done. A low number means compression is done after
5359 less words are added, which is slow. A high number means more memory
5360 will be allocated.
5361
5362 After doing compression, {added} times 1024 words can be added before
5363 the {inc} limit is ignored and compression is done when any extra
5364 amount of memory is needed. A low number means there is a smaller
5365 chance of hitting the {inc} limit, less memory is used but it's
5366 slower.
5367
5368 The languages for which these numbers are important are Italian and
5369 Hungarian. The default works for when you have about 512 Mbyte. If
5370 you have 1 Gbyte you could use: >
5371 :set mkspellmem=900000,3000,800
5372< If you have less than 512 Mbyte |:mkspell| may fail for some
5373 languages, no matter what you set 'mkspellmem' to.
5374
Bram Moolenaar07607392019-05-26 19:20:43 +02005375 This option cannot be set from a |modeline| or in the |sandbox|.
5376
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005378'modeline' 'ml' boolean (Vim default: on (off for root),
5379 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005381 If 'modeline' is on 'modelines' gives the number of lines that is
5382 checked for set commands. If 'modeline' is off or 'modelines' is zero
5383 no lines are checked. See |modeline|.
5384
5385 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5386'modelineexpr' 'mle' boolean (default: off)
5387 global
5388 When on allow some options that are an expression to be set in the
5389 modeline. Check the option for whether it is affected by
5390 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005391 This option cannot be set from a |modeline| or in the |sandbox|, for
5392 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005393
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 *'modelines'* *'mls'*
5395'modelines' 'mls' number (default 5)
5396 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 If 'modeline' is on 'modelines' gives the number of lines that is
5398 checked for set commands. If 'modeline' is off or 'modelines' is zero
5399 no lines are checked. See |modeline|.
5400 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5401 set and to the Vim default value when 'compatible' is reset.
5402
5403 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005404 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405'modifiable' 'ma' boolean (default on)
5406 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 When off the buffer contents cannot be changed. The 'fileformat' and
5408 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005409 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410
5411 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5412'modified' 'mod' boolean (default off)
5413 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 When on, the buffer is considered to be modified. This option is set
5415 when:
5416 1. A change was made to the text since it was last written. Using the
5417 |undo| command to go back to the original text will reset the
5418 option. But undoing changes that were made before writing the
5419 buffer will set the option again, since the text is different from
5420 when it was written.
5421 2. 'fileformat' or 'fileencoding' is different from its original
5422 value. The original value is set when the buffer is read or
5423 written. A ":set nomodified" command also resets the original
5424 values to the current values and the 'modified' option will be
5425 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005426 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005427 This option is not set when a change is made to the buffer as the
5428 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5429 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5430 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5432 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005433 Note that the text may actually be the same, e.g. 'modified' is set
5434 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435
5436 *'more'* *'nomore'*
5437'more' boolean (Vim default: on, Vi default: off)
5438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 When on, listings pause when the whole screen is filled. You will get
5440 the |more-prompt|. When this option is off there are no pauses, the
5441 listing continues until finished.
5442 NOTE: This option is set to the Vi default value when 'compatible' is
5443 set and to the Vim default value when 'compatible' is reset.
5444
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005445 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005446'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005447 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005449 Enable the use of the mouse. Works for most terminals (xterm, Win32
5450 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5451 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5452 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005453 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 v Visual mode
5455 i Insert mode
5456 c Command-line mode
5457 h all previous modes when editing a help file
5458 a all previous modes
5459 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005460 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005462< If your terminal can't overrule the mouse events going to the
5463 application, use: >
5464 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005465< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005466 back to Vim using the mouse events.
5467 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5468 "xterm".
5469
5470 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 modeless selection. This doesn't move the text cursor.
5472
5473 See |mouse-using|. Also see |'clipboard'|.
5474
5475 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005476 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 the mouse buttons can still be used by keeping the shift key pressed.
5478 Also see the 'clipboard' option.
5479
5480 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5481'mousefocus' 'mousef' boolean (default off)
5482 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 {only works in the GUI}
5484 The window that the mouse pointer is on is automatically activated.
5485 When changing the window layout or window focus in another way, the
5486 mouse pointer is moved to the window with keyboard focus. Off is the
5487 default because it makes using the pull down menus a little goofy, as
5488 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005489 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005490 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491
5492 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5493'mousehide' 'mh' boolean (default on)
5494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 {only works in the GUI}
5496 When on, the mouse pointer is hidden when characters are typed.
5497 The mouse pointer is restored when the mouse is moved.
5498
5499 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005500'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 Sets the model to use for the mouse. The name mostly specifies what
5503 the right mouse button is used for:
5504 extend Right mouse button extends a selection. This works
5505 like in an xterm.
5506 popup Right mouse button pops up a menu. The shifted left
5507 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005508 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 popup_setpos Like "popup", but the cursor will be moved to the
5510 position where the mouse was clicked, and thus the
5511 selected operation will act upon the clicked object.
5512 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005513 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 course, that right clicking outside a selection will
5515 end Visual mode.
5516 Overview of what button does what for each model:
5517 mouse extend popup(_setpos) ~
5518 left click place cursor place cursor
5519 left drag start selection start selection
5520 shift-left search word extend selection
5521 right click extend selection popup menu (place cursor)
5522 right drag extend selection -
5523 middle click paste paste
5524
5525 In the "popup" model the right mouse button produces a pop-up menu.
5526 You need to define this first, see |popup-menu|.
5527
5528 Note that you can further refine the meaning of buttons with mappings.
5529 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5530 selection (because that's handled in the GUI code directly).
5531
5532 The 'mousemodel' option is set by the |:behave| command.
5533
Ernie Raelc4cb5442022-04-03 15:47:28 +01005534 *'mousemoveevent'* *'mousemev'*
5535'mousemoveevent' 'mousemev' boolean (default off)
5536 global
5537 {only works in the GUI}
5538 When on, mouse move events are delivered to the input queue and are
5539 available for mapping. The default, off, avoids the mouse movement
5540 overhead except when needed. See |gui-mouse-mapping|.
5541 Warning: Setting this option can make pending mappings to be aborted
5542 when the mouse is moved.
5543 Currently only works in the GUI, may be made to work in a terminal
5544 later.
5545
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005547'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5548 vs:leftright,vd:lrsizing,m:no,
5549 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 {only available when compiled with the |+mouseshape|
5552 feature}
5553 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005554 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 like used for 'guicursor'. Each part consist of a mode/location-list
5556 and an argument-list:
5557 mode-list:shape,mode-list:shape,..
5558 The mode-list is a dash separated list of these modes/locations:
5559 In a normal window: ~
5560 n Normal mode
5561 v Visual mode
5562 ve Visual mode with 'selection' "exclusive" (same as 'v',
5563 if not specified)
5564 o Operator-pending mode
5565 i Insert mode
5566 r Replace mode
5567
5568 Others: ~
5569 c appending to the command-line
5570 ci inserting in the command-line
5571 cr replacing in the command-line
5572 m at the 'Hit ENTER' or 'More' prompts
5573 ml idem, but cursor in the last line
5574 e any mode, pointer below last window
5575 s any mode, pointer on a status line
5576 sd any mode, while dragging a status line
5577 vs any mode, pointer on a vertical separator line
5578 vd any mode, while dragging a vertical separator line
5579 a everywhere
5580
5581 The shape is one of the following:
5582 avail name looks like ~
5583 w x arrow Normal mouse pointer
5584 w x blank no pointer at all (use with care!)
5585 w x beam I-beam
5586 w x updown up-down sizing arrows
5587 w x leftright left-right sizing arrows
5588 w x busy The system's usual busy pointer
5589 w x no The system's usual 'no input' pointer
5590 x udsizing indicates up-down resizing
5591 x lrsizing indicates left-right resizing
5592 x crosshair like a big thin +
5593 x hand1 black hand
5594 x hand2 white hand
5595 x pencil what you write with
5596 x question big ?
5597 x rightup-arrow arrow pointing right-up
5598 w x up-arrow arrow pointing up
5599 x <number> any X11 pointer number (see X11/cursorfont.h)
5600
5601 The "avail" column contains a 'w' if the shape is available for Win32,
5602 x for X11.
5603 Any modes not specified or shapes not available use the normal mouse
5604 pointer.
5605
5606 Example: >
5607 :set mouseshape=s:udsizing,m:no
5608< will make the mouse turn to a sizing arrow over the status lines and
5609 indicate no input when the hit-enter prompt is displayed (since
5610 clicking the mouse has no effect in this state.)
5611
5612 *'mousetime'* *'mouset'*
5613'mousetime' 'mouset' number (default 500)
5614 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005615 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 time in msec between two mouse clicks for the second click to be
5617 recognized as a multi click.
5618
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005619 *'mzschemedll'*
5620'mzschemedll' string (default depends on the build)
5621 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005622 {only available when compiled with the |+mzscheme/dyn|
5623 feature}
5624 Specifies the name of the MzScheme shared library. The default is
5625 DYNAMIC_MZSCH_DLL which was specified at compile time.
5626 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005627 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005628 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005629 This option cannot be set from a |modeline| or in the |sandbox|, for
5630 security reasons.
5631
5632 *'mzschemegcdll'*
5633'mzschemegcdll' string (default depends on the build)
5634 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005635 {only available when compiled with the |+mzscheme/dyn|
5636 feature}
5637 Specifies the name of the MzScheme GC shared library. The default is
5638 DYNAMIC_MZGC_DLL which was specified at compile time.
5639 The value can be equal to 'mzschemedll' if it includes the GC code.
5640 Environment variables are expanded |:set_env|.
5641 This option cannot be set from a |modeline| or in the |sandbox|, for
5642 security reasons.
5643
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005644 *'mzquantum'* *'mzq'*
5645'mzquantum' 'mzq' number (default 100)
5646 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005647 {not available when compiled without the |+mzscheme|
5648 feature}
5649 The number of milliseconds between polls for MzScheme threads.
5650 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005651 NOTE: This option is set to the Vim default value when 'compatible'
5652 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005653
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005655'nrformats' 'nf' string (default "bin,octal,hex",
5656 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 This defines what bases Vim will consider for numbers when using the
5659 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5660 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005661 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005663 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005664 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005666 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 considered to be hexadecimal. Example: Using CTRL-X on
5668 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005669 bin If included, numbers starting with "0b" or "0B" will be
5670 considered to be binary. Example: Using CTRL-X on
5671 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005672 unsigned If included, numbers are recognized as unsigned. Thus a
5673 leading dash or negative sign won't be considered as part of
5674 the number. Examples:
5675 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5676 (without "unsigned" it would become "9-2021").
5677 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5678 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005679 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5680 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 Numbers which simply begin with a digit in the range 1-9 are always
5682 considered decimal. This also happens for numbers that are not
5683 recognized as octal or hex.
5684
5685 *'number'* *'nu'* *'nonumber'* *'nonu'*
5686'number' 'nu' boolean (default off)
5687 local to window
5688 Print the line number in front of each line. When the 'n' option is
5689 excluded from 'cpoptions' a wrapped line will not use the column of
5690 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005691 The 'numberwidth' option can be used to set the room used for the line
5692 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 When a long, wrapped line doesn't start with the first character, '-'
5694 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005695 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5696 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005697 *number_relativenumber*
5698 The 'relativenumber' option changes the displayed number to be
5699 relative to the cursor. Together with 'number' there are these
5700 four combinations (cursor in line 3):
5701
Bram Moolenaar3848e002016-03-19 18:42:29 +01005702 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005703 'nornu' 'nornu' 'rnu' 'rnu'
5704
5705 |apple | 1 apple | 2 apple | 2 apple
5706 |pear | 2 pear | 1 pear | 1 pear
5707 |nobody | 3 nobody | 0 nobody |3 nobody
5708 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005710 *'numberwidth'* *'nuw'*
5711'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5712 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005713 {only available when compiled with the |+linebreak|
5714 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005715 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005716 when the 'number' or 'relativenumber' option is set or printing lines
5717 with a line number. Since one space is always between the number and
5718 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005719 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005720 fit the highest line number in the buffer respectively the number of
5721 rows in the window, depending on whether 'number' or 'relativenumber'
5722 is set. Thus with the Vim default of 4 there is room for a line number
5723 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005724 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005725 NOTE: This option is set to the Vi default value when 'compatible' is
5726 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005727
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005728 *'omnifunc'* *'ofu'*
5729'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005730 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005731 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005732 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005733 This option specifies a function to be used for Insert mode omni
5734 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005735 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005736 invoked and what it should return. The value can be the name of a
5737 function, a |lambda| or a |Funcref|. See |option-value-function| for
5738 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005739 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005740 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005741 This option cannot be set from a |modeline| or in the |sandbox|, for
5742 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005743
5744
Bram Moolenaar02467872007-05-06 13:22:01 +00005745 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005746'opendevice' 'odev' boolean (default off)
5747 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005748 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005749 Enable reading and writing from devices. This may get Vim stuck on a
5750 device that can be opened but doesn't actually do the I/O. Therefore
5751 it is off by default.
5752 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5753 result in editing a device.
5754
5755
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005756 *'operatorfunc'* *'opfunc'*
5757'operatorfunc' 'opfunc' string (default: empty)
5758 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005759 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005760 See |:map-operator| for more info and an example. The value can be
5761 the name of a function, a |lambda| or a |Funcref|. See
5762 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005763
5764 This option cannot be set from a |modeline| or in the |sandbox|, for
5765 security reasons.
5766
5767
Bram Moolenaar251e1912011-06-19 05:09:16 +02005768 *'osfiletype'* *'oft'*
5769'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005771 This option was supported on RISC OS, which has been removed.
5772
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005774 *'packpath'* *'pp'*
5775'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005776 Directories used to find packages. See |packages|.
5777
5778
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005780'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 global
5782 Specifies the nroff macros that separate paragraphs. These are pairs
5783 of two letters (see |object-motions|).
5784
5785 *'paste'* *'nopaste'*
5786'paste' boolean (default off)
5787 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005788 Put Vim in Paste mode. This is useful if you want to cut or copy
5789 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 unexpected effects.
5791 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005792 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 knows about pasting and will mostly do the right thing without 'paste'
5794 being set. The same is true for a terminal where Vim handles the
5795 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005796 This option is reset when starting the GUI. Thus if you set it in
5797 your .vimrc it will work in a terminal, but not in the GUI. Setting
5798 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5799 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 When the 'paste' option is switched on (also when it was already on):
5801 - mapping in Insert mode and Command-line mode is disabled
5802 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005804 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005805 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 - 'revins' is reset
5807 - 'ruler' is reset
5808 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005809 - 'smarttab' is reset
5810 - 'softtabstop' is set to 0
5811 - 'textwidth' is set to 0
5812 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005813 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005816 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005817 - 'indentexpr'
5818 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005819 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 NOTE: When you start editing another file while the 'paste' option is
5821 on, settings from the modelines or autocommands may change the
5822 settings again, causing trouble when pasting text. You might want to
5823 set the 'paste' option again.
5824 When the 'paste' option is reset the mentioned options are restored to
5825 the value before the moment 'paste' was switched from off to on.
5826 Resetting 'paste' before ever setting it does not have any effect.
5827 Since mapping doesn't work while 'paste' is active, you need to use
5828 the 'pastetoggle' option to toggle the 'paste' option with some key.
5829
5830 *'pastetoggle'* *'pt'*
5831'pastetoggle' 'pt' string (default "")
5832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 When non-empty, specifies the key sequence that toggles the 'paste'
5834 option. This is like specifying a mapping: >
5835 :map {keys} :set invpaste<CR>
5836< Where {keys} is the value of 'pastetoggle'.
5837 The difference is that it will work even when 'paste' is set.
5838 'pastetoggle' works in Insert mode and Normal mode, but not in
5839 Command-line mode.
5840 Mappings are checked first, thus overrule 'pastetoggle'. However,
5841 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5842 this: >
5843 :map <F10> :set paste<CR>
5844 :map <F11> :set nopaste<CR>
5845 :imap <F10> <C-O>:set paste<CR>
5846 :imap <F11> <nop>
5847 :set pastetoggle=<F11>
5848< This will make <F10> start paste mode and <F11> stop paste mode.
5849 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5850 mode everything is inserted literally, except the 'pastetoggle' key
5851 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005852 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853
5854 *'pex'* *'patchexpr'*
5855'patchexpr' 'pex' string (default "")
5856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857 {not available when compiled without the |+diff|
5858 feature}
5859 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005860 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861
Bram Moolenaardbc28022014-07-26 13:40:44 +02005862 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863'patchmode' 'pm' string (default "")
5864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 When non-empty the oldest version of a file is kept. This can be used
5866 to keep the original version of a file if you are changing files in a
5867 source distribution. Only the first time that a file is written a
5868 copy of the original file will be kept. The name of the copy is the
5869 name of the original file with the string in the 'patchmode' option
5870 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005871 ".orig" or ".org". 'backupdir' must not be empty for this to work
5872 (Detail: The backup file is renamed to the patchmode file after the
5873 new file has been successfully written, that's why it must be possible
5874 to write a backup file). If there was no file to be backed up, an
5875 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 When the 'backupskip' pattern matches, a patchmode file is not made.
5877 Using 'patchmode' for compressed files appends the extension at the
5878 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5879 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005880 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005882 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 other systems: ".,,")
5885 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005887 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5888 provided that the file being searched for has a relative path (not
5889 starting with "/", "./" or "../"). The directories in the 'path'
5890 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 - Use commas to separate directory names: >
5892 :set path=.,/usr/local/include,/usr/include
5893< - Spaces can also be used to separate directory names (for backwards
5894 compatibility with version 3.0). To have a space in a directory
5895 name, precede it with an extra backslash, and escape the space: >
5896 :set path=.,/dir/with\\\ space
5897< - To include a comma in a directory name precede it with an extra
5898 backslash: >
5899 :set path=.,/dir/with\\,comma
5900< - To search relative to the directory of the current file, use: >
5901 :set path=.
5902< - To search in the current directory use an empty string between two
5903 commas: >
5904 :set path=,,
5905< - A directory name may end in a ':' or '/'.
5906 - Environment variables are expanded |:set_env|.
5907 - When using |netrw.vim| URLs can be used. For example, adding
5908 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005909 - Search upwards and downwards in a directory tree using "*", "**" and
5910 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 {not available when compiled without the |+path_extra| feature}
5912 - Careful with '\' characters, type two to get one in the option: >
5913 :set path=.,c:\\include
5914< Or just use '/' instead: >
5915 :set path=.,c:/include
5916< Don't forget "." or files won't even be found in the same directory as
5917 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005918 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 it is something like 256 or 1024 characters.
5920 You can check if all the include files are found, using the value of
5921 'path', see |:checkpath|.
5922 The use of |:set+=| and |:set-=| is preferred when adding or removing
5923 directories from the list. This avoids problems when a future version
5924 uses another default. To remove the current directory use: >
5925 :set path-=
5926< To add the current directory use: >
5927 :set path+=
5928< To use an environment variable, you probably need to replace the
5929 separator. Here is an example to append $INCL, in which directory
5930 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005931 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932< Replace the ';' with a ':' or whatever separator is used. Note that
5933 this doesn't work when $INCL contains a comma or white space.
5934
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005935 *'perldll'*
5936'perldll' string (default depends on the build)
5937 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005938 {only available when compiled with the |+perl/dyn|
5939 feature}
5940 Specifies the name of the Perl shared library. The default is
5941 DYNAMIC_PERL_DLL, which was specified at compile time.
5942 Environment variables are expanded |:set_env|.
5943 This option cannot be set from a |modeline| or in the |sandbox|, for
5944 security reasons.
5945
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5947'preserveindent' 'pi' boolean (default off)
5948 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949 When changing the indent of the current line, preserve as much of the
5950 indent structure as possible. Normally the indent is replaced by a
5951 series of tabs followed by spaces as required (unless |'expandtab'| is
5952 enabled, in which case only spaces are used). Enabling this option
5953 means the indent will preserve as many existing characters as possible
5954 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005955 'expandtab' does not apply to the preserved white space, a Tab remains
5956 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 NOTE: When using ">>" multiple times the resulting indent is a mix of
5958 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005959 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960 Also see 'copyindent'.
5961 Use |:retab| to clean up white space.
5962
5963 *'previewheight'* *'pvh'*
5964'previewheight' 'pvh' number (default 12)
5965 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005966 {not available when compiled without the |+quickfix|
5967 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005969 commands. Used for |CTRL-W_}| when no count is given. Not used when
5970 'previewpopup' is set.
5971
5972 *'previewpopup'* *'pvp'*
5973'previewpopup' 'pvp' string (default empty)
5974 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005975 {not available when compiled without the |+textprop|
5976 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005977 When not empty a popup window is used for commands that would open a
5978 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005979 Not used for the insert completion info, add "popup" to
5980 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981
5982 *'previewwindow'* *'nopreviewwindow'*
5983 *'pvw'* *'nopvw'* *E590*
5984'previewwindow' 'pvw' boolean (default off)
5985 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005986 {not available when compiled without the |+quickfix|
5987 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005988 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989 set. It's normally not set directly, but by using one of the commands
5990 |:ptag|, |:pedit|, etc.
5991
5992 *'printdevice'* *'pdev'*
5993'printdevice' 'pdev' string (default empty)
5994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 {only available when compiled with the |+printer|
5996 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005997 The name of the printer to be used for |:hardcopy|.
5998 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005999 This option cannot be set from a |modeline| or in the |sandbox|, for
6000 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001
Bram Moolenaar8299df92004-07-10 09:47:34 +00006002 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006003'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 {only available when compiled with the |+printer|
6006 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006007 Sets the character encoding used when printing.
6008 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009
6010 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006011'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 {only available when compiled with the |+printer|
6014 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006015 Expression used to print the PostScript produced with |:hardcopy|.
6016 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006017 This option cannot be set from a |modeline| or in the |sandbox|, for
6018 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019
Bram Moolenaar8299df92004-07-10 09:47:34 +00006020 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021'printfont' 'pfn' string (default "courier")
6022 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 {only available when compiled with the |+printer|
6024 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006025 The name of the font that will be used for |:hardcopy|.
6026 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027
6028 *'printheader'* *'pheader'*
6029'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 {only available when compiled with the |+printer|
6032 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006033 The format of the header produced in |:hardcopy| output.
6034 See |pheader-option|.
6035
6036 *'printmbcharset'* *'pmbcs'*
6037'printmbcharset' 'pmbcs' string (default "")
6038 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006039 {only available when compiled with the |+printer|
6040 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006041 The CJK character set to be used for CJK output from |:hardcopy|.
6042 See |pmbcs-option|.
6043
6044 *'printmbfont'* *'pmbfn'*
6045'printmbfont' 'pmbfn' string (default "")
6046 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006047 {only available when compiled with the |+printer|
6048 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006049 List of font names to be used for CJK output from |:hardcopy|.
6050 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051
6052 *'printoptions'* *'popt'*
6053'printoptions' 'popt' string (default "")
6054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006056 List of items that control the format of the output of |:hardcopy|.
6057 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006059 *'prompt'* *'noprompt'*
6060'prompt' boolean (default on)
6061 global
6062 When on a ":" prompt is used in Ex mode.
6063
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006064 *'pumheight'* *'ph'*
6065'pumheight' 'ph' number (default 0)
6066 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006067 Determines the maximum number of items to show in the popup menu for
6068 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006069 |ins-completion-menu|.
6070
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006071 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006072'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006073 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006074 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006075 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006076
Bram Moolenaard94464e2015-11-02 15:28:18 +01006077 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006078'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006079 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006080 {only available when compiled with the |+python/dyn|
6081 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006082 Specifies the name of the Python 2.x shared library. The default is
6083 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006084 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006085 This option cannot be set from a |modeline| or in the |sandbox|, for
6086 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006087
Bram Moolenaar94073162018-01-31 21:49:05 +01006088 *'pythonhome'*
6089'pythonhome' string (default "")
6090 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006091 {only available when compiled with the |+python/dyn|
6092 feature}
6093 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6094 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6095 which was specified at compile time, will be used for the Python 2.x
6096 home directory.
6097 Environment variables are expanded |:set_env|.
6098 This option cannot be set from a |modeline| or in the |sandbox|, for
6099 security reasons.
6100
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006101 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006102'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006103 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006104 {only available when compiled with the |+python3/dyn|
6105 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006106 Specifies the name of the Python 3 shared library. The default is
6107 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006108 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006109 This option cannot be set from a |modeline| or in the |sandbox|, for
6110 security reasons.
6111
Bram Moolenaar94073162018-01-31 21:49:05 +01006112 *'pythonthreehome'*
6113'pythonthreehome' string (default "")
6114 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006115 {only available when compiled with the |+python3/dyn|
6116 feature}
6117 Specifies the name of the Python 3 home directory. When
6118 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6119 PYTHON3_HOME, which was specified at compile time, will be used for
6120 the Python 3 home directory.
6121 Environment variables are expanded |:set_env|.
6122 This option cannot be set from a |modeline| or in the |sandbox|, for
6123 security reasons.
6124
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006125 *'pyxversion'* *'pyx'*
6126'pyxversion' 'pyx' number (default depends on the build)
6127 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006128 {only available when compiled with the |+python| or
6129 the |+python3| feature}
6130 Specifies the python version used for pyx* functions and commands
6131 |python_x|. The default value is as follows:
6132
6133 Compiled with Default ~
6134 |+python| and |+python3| 0
6135 only |+python| 2
6136 only |+python3| 3
6137
6138 Available values are 0, 2 and 3.
6139 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6140 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6141 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6142 to 2 if Python 2 is available.
6143 See also: |has-pythonx|
6144
6145 If Vim is compiled with only |+python| or |+python3| setting
6146 'pyxversion' has no effect. The pyx* functions and commands are
6147 always the same as the compiled version.
6148
6149 This option cannot be set from a |modeline| or in the |sandbox|, for
6150 security reasons.
6151
Bram Moolenaar858ba062020-05-31 23:11:59 +02006152 *'quickfixtextfunc'* *'qftf'*
6153'quickfixtextfunc' 'qftf' string (default "")
6154 global
6155 {only available when compiled with the |+quickfix|
6156 feature}
6157 This option specifies a function to be used to get the text to display
6158 in the quickfix and location list windows. This can be used to
6159 customize the information displayed in the quickfix or location window
6160 for each entry in the corresponding quickfix or location list. See
6161 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006162 function and an example. The value can be the name of a function, a
6163 |lambda| or a |Funcref|. See |option-value-function| for more
6164 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006165
6166 This option cannot be set from a |modeline| or in the |sandbox|, for
6167 security reasons.
6168
Bram Moolenaar677ee682005-01-27 14:41:15 +00006169 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006170'quoteescape' 'qe' string (default "\")
6171 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006172 The characters that are used to escape quotes in a string. Used for
6173 objects like a', a" and a` |a'|.
6174 When one of the characters in this option is found inside a string,
6175 the following character will be skipped. The default value makes the
6176 text "foo\"bar\\" considered to be one string.
6177
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6179'readonly' 'ro' boolean (default off)
6180 local to buffer
6181 If on, writes fail unless you use a '!'. Protects you from
6182 accidentally overwriting a file. Default on when Vim is started
6183 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006184 When using ":w!" the 'readonly' option is reset for the current
6185 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006186 When using the ":view" command the 'readonly' option is set for the
6187 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006188 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006190 *'redrawtime'* *'rdt'*
6191'redrawtime' 'rdt' number (default 2000)
6192 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006193 {only available when compiled with the |+reltime|
6194 feature}
6195 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006196 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006197 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006198 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006199 matches will be highlighted.
6200 For syntax highlighting the time applies per window. When over the
6201 limit syntax highlighting is disabled until |CTRL-L| is used.
6202 This is used to avoid that Vim hangs when using a very complicated
6203 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006204
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006205 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006206'regexpengine' 're' number (default 0)
6207 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006208 This selects the default regexp engine. |two-engines|
6209 The possible values are:
6210 0 automatic selection
6211 1 old engine
6212 2 NFA engine
6213 Note that when using the NFA engine and the pattern contains something
6214 that is not supported the pattern will not match. This is only useful
6215 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006216 Using automatic selection enables Vim to switch the engine, if the
6217 default engine becomes too costly. E.g., when the NFA engine uses too
6218 many states. This should prevent Vim from hanging on a combination of
6219 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006220
Bram Moolenaar64486672010-05-16 15:46:46 +02006221 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6222'relativenumber' 'rnu' boolean (default off)
6223 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006224 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006225 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006226 precede some vertical motion commands (e.g. j k + -) with, without
6227 having to calculate it yourself. Especially useful in combination with
6228 other commands (e.g. y d c < > gq gw =).
6229 When the 'n' option is excluded from 'cpoptions' a wrapped
6230 line will not use the column of line numbers (this is the default when
6231 'compatible' isn't set).
6232 The 'numberwidth' option can be used to set the room used for the line
6233 number.
6234 When a long, wrapped line doesn't start with the first character, '-'
6235 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006236 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6237 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006238
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006239 The number in front of the cursor line also depends on the value of
6240 'number', see |number_relativenumber| for all combinations of the two
6241 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006242
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 *'remap'* *'noremap'*
6244'remap' boolean (default on)
6245 global
6246 Allows for mappings to work recursively. If you do not want this for
6247 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006248 NOTE: To avoid portability problems with Vim scripts, always keep
6249 this option at the default "on". Only switch it off when working with
6250 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006252 *'renderoptions'* *'rop'*
6253'renderoptions' 'rop' string (default: empty)
6254 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006255 {only available when compiled with GUI and DIRECTX on
6256 MS-Windows}
6257 Select a text renderer and set its options. The options depend on the
6258 renderer.
6259
6260 Syntax: >
6261 set rop=type:{renderer}(,{name}:{value})*
6262<
6263 Currently, only one optional renderer is available.
6264
6265 render behavior ~
6266 directx Vim will draw text using DirectX (DirectWrite). It makes
6267 drawn glyphs more beautiful than default GDI.
6268 It requires 'encoding' is "utf-8", and only works on
6269 MS-Windows Vista or newer version.
6270
6271 Options:
6272 name meaning type value ~
6273 gamma gamma float 1.0 - 2.2 (maybe)
6274 contrast enhancedContrast float (unknown)
6275 level clearTypeLevel float (unknown)
6276 geom pixelGeometry int 0 - 2 (see below)
6277 renmode renderingMode int 0 - 6 (see below)
6278 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006279 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006280
Bram Moolenaar92467d32017-12-05 13:22:16 +01006281 See this URL for detail (except for scrlines):
6282 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006283
6284 For geom: structure of a device pixel.
6285 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6286 1 - DWRITE_PIXEL_GEOMETRY_RGB
6287 2 - DWRITE_PIXEL_GEOMETRY_BGR
6288
6289 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006290 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006291
6292 For renmode: method of rendering glyphs.
6293 0 - DWRITE_RENDERING_MODE_DEFAULT
6294 1 - DWRITE_RENDERING_MODE_ALIASED
6295 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6296 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6297 4 - DWRITE_RENDERING_MODE_NATURAL
6298 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6299 6 - DWRITE_RENDERING_MODE_OUTLINE
6300
6301 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006302 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006303
6304 For taamode: antialiasing mode used for drawing text.
6305 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6306 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6307 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6308 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6309
6310 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006311 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6312
Bram Moolenaara338adc2018-01-31 20:51:47 +01006313 For scrlines:
6314 This was used for optimizing scrolling behavior, however this
6315 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006316
6317 Example: >
6318 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006319 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006320 set rop=type:directx
6321<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006322 If select a raster font (Courier, Terminal or FixedSys which
6323 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006324 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006325
6326 NOTE: It is known that some fonts and options combination
6327 causes trouble on drawing glyphs.
6328
Bram Moolenaar92467d32017-12-05 13:22:16 +01006329 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006330 special made fonts (True-Type fonts which includes only
6331 bitmap glyphs).
6332 - 'taamode:3' will not work with some vector fonts.
6333
6334 NOTE: With this option, you can display colored emoji
6335 (emoticon) in Windows 8.1 or later. To display colored emoji,
6336 there are some conditions which you should notice.
6337
6338 - If your font includes non-colored emoji already, it will
6339 be used.
6340 - If your font doesn't have emoji, the system chooses an
6341 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6342 will be used.
6343 - When this alternative font didn't have fixed width glyph,
6344 emoji might be rendered beyond the bounding box of drawing
6345 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006346
6347 Other render types are currently not supported.
6348
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 *'report'*
6350'report' number (default 2)
6351 global
6352 Threshold for reporting number of lines changed. When the number of
6353 changed lines is more than 'report' a message will be given for most
6354 ":" commands. If you want it always, set 'report' to 0.
6355 For the ":substitute" command the number of substitutions is used
6356 instead of the number of lines.
6357
6358 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6359'restorescreen' 'rs' boolean (default on)
6360 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006361 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 When set, the screen contents is restored when exiting Vim. This also
6363 happens when executing external commands.
6364
6365 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6366 options in your .vimrc. To disable restoring:
6367 set t_ti= t_te=
6368 To enable restoring (for an xterm):
6369 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6370 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6371
6372 *'revins'* *'ri'* *'norevins'* *'nori'*
6373'revins' 'ri' boolean (default off)
6374 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 {only available when compiled with the |+rightleft|
6376 feature}
6377 Inserting characters in Insert mode will work backwards. See "typing
6378 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6379 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006380 NOTE: This option is reset when 'compatible' is set.
6381 This option is reset when 'paste' is set and restored when 'paste' is
6382 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383
6384 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6385'rightleft' 'rl' boolean (default off)
6386 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 {only available when compiled with the |+rightleft|
6388 feature}
6389 When on, display orientation becomes right-to-left, i.e., characters
6390 that are stored in the file appear from the right to the left.
6391 Using this option, it is possible to edit files for languages that
6392 are written from the right to the left such as Hebrew and Arabic.
6393 This option is per window, so it is possible to edit mixed files
6394 simultaneously, or to view the same file in both ways (this is
6395 useful whenever you have a mixed text file with both right-to-left
6396 and left-to-right strings so that both sets are displayed properly
6397 in different windows). Also see |rileft.txt|.
6398
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006399 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400'rightleftcmd' 'rlc' string (default "search")
6401 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 {only available when compiled with the |+rightleft|
6403 feature}
6404 Each word in this option enables the command line editing to work in
6405 right-to-left mode for a group of commands:
6406
6407 search "/" and "?" commands
6408
6409 This is useful for languages such as Hebrew, Arabic and Farsi.
6410 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6411
Bram Moolenaard94464e2015-11-02 15:28:18 +01006412 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006413'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006414 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006415 {only available when compiled with the |+ruby/dyn|
6416 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006417 Specifies the name of the Ruby shared library. The default is
6418 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006419 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006420 This option cannot be set from a |modeline| or in the |sandbox|, for
6421 security reasons.
6422
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006424'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 {not available when compiled without the
6427 |+cmdline_info| feature}
6428 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006429 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 text in the file is shown on the far right:
6431 Top first line is visible
6432 Bot last line is visible
6433 All first and last line are visible
6434 45% relative position in the file
6435 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006436 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006438 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 this option takes precedence over 'ruler' and 'rulerformat'
6440 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006441 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 the text column (byte number) and the screen column are shown,
6443 separated with a dash.
6444 For an empty line "0-1" is shown.
6445 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006446 This option is reset when 'paste' is set and restored when 'paste' is
6447 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 If you don't want to see the ruler all the time but want to know where
6449 you are, use "g CTRL-G" |g_CTRL-G|.
6450 NOTE: This option is reset when 'compatible' is set.
6451
6452 *'rulerformat'* *'ruf'*
6453'rulerformat' 'ruf' string (default empty)
6454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 {not available when compiled without the |+statusline|
6456 feature}
6457 When this option is not empty, it determines the content of the ruler
6458 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006459 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006460 This option cannot be set in a modeline when 'modelineexpr' is off.
6461
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 The default ruler width is 17 characters. To make the ruler 15
6463 characters wide, put "%15(" at the start and "%)" at the end.
6464 Example: >
6465 :set rulerformat=%15(%c%V\ %p%%%)
6466<
6467 *'runtimepath'* *'rtp'* *vimfiles*
6468'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006469 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 $VIM/vimfiles,
6471 $VIMRUNTIME,
6472 $VIM/vimfiles/after,
6473 $HOME/.vim/after"
6474 Amiga: "home:vimfiles,
6475 $VIM/vimfiles,
6476 $VIMRUNTIME,
6477 $VIM/vimfiles/after,
6478 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006479 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 $VIM/vimfiles,
6481 $VIMRUNTIME,
6482 $VIM/vimfiles/after,
6483 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006484 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 $VIMRUNTIME,
6486 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006487 Haiku: "$BE_USER_SETTINGS/vim,
6488 $VIM/vimfiles,
6489 $VIMRUNTIME,
6490 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006491 $BE_USER_SETTINGS/vim/after"
6492 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 $VIM/vimfiles,
6494 $VIMRUNTIME,
6495 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006496 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 This is a list of directories which will be searched for runtime
6499 files:
6500 filetype.vim filetypes by file name |new-filetype|
6501 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006502 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 colors/ color scheme files |:colorscheme|
6504 compiler/ compiler files |:compiler|
6505 doc/ documentation |write-local-help|
6506 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006507 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 indent/ indent scripts |indent-expression|
6509 keymap/ key mapping files |mbyte-keymap|
6510 lang/ menu translations |:menutrans|
6511 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006512 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 plugin/ plugin scripts |write-plugin|
6514 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006515 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 syntax/ syntax files |mysyntaxfile|
6517 tutor/ files for vimtutor |tutor|
6518
6519 And any other file searched for with the |:runtime| command.
6520
6521 The defaults for most systems are setup to search five locations:
6522 1. In your home directory, for your personal preferences.
6523 2. In a system-wide Vim directory, for preferences from the system
6524 administrator.
6525 3. In $VIMRUNTIME, for files distributed with Vim.
6526 *after-directory*
6527 4. In the "after" directory in the system-wide Vim directory. This is
6528 for the system administrator to overrule or add to the distributed
6529 defaults (rarely needed)
6530 5. In the "after" directory in your home directory. This is for
6531 personal preferences to overrule or add to the distributed defaults
6532 or system-wide settings (rarely needed).
6533
Bram Moolenaard0796902016-09-16 20:02:31 +02006534 More entries are added when using |packages|. If it gets very long
6535 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6536 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006537
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6539 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006540 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 wildcards.
6542 See |:runtime|.
6543 Example: >
6544 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6545< This will use the directory "~/vimruntime" first (containing your
6546 personal Vim runtime files), then "/mygroup/vim" (shared between a
6547 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6548 files).
6549 You probably should always include $VIMRUNTIME somewhere, to use the
6550 distributed runtime files. You can put a directory before $VIMRUNTIME
6551 to find files which replace a distributed runtime files. You can put
6552 a directory after $VIMRUNTIME to find files which add to distributed
6553 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006554 When Vim is started with |--clean| the home directory entries are not
6555 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 This option cannot be set from a |modeline| or in the |sandbox|, for
6557 security reasons.
6558
6559 *'scroll'* *'scr'*
6560'scroll' 'scr' number (default: half the window height)
6561 local to window
6562 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6563 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006564 changes. This may happen when enabling the |status-line| or
6565 'tabline' option after setting the 'scroll' option.
6566 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006567 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006568 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569
6570 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6571'scrollbind' 'scb' boolean (default off)
6572 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 See also |scroll-binding|. When this option is set, the current
6574 window scrolls as other scrollbind windows (windows that also have
6575 this option set) scroll. This option is useful for viewing the
6576 differences between two versions of a file, see 'diff'.
6577 See |'scrollopt'| for options that determine how this option should be
6578 interpreted.
6579 This option is mostly reset when splitting a window to edit another
6580 file. This means that ":split | edit file" results in two windows
6581 with scroll-binding, but ":split file" does not.
6582
Bram Moolenaarae20f342019-11-05 21:09:23 +01006583 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6584'scrollfocus' 'scf' boolean (default off)
6585 global
6586 {only for MS-Windows GUI}
6587 When using the scroll wheel and this option is set, the window under
6588 the mouse pointer is scrolled. With this option off the current
6589 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006590 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006591
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 *'scrolljump'* *'sj'*
6593'scrolljump' 'sj' number (default 1)
6594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 Minimal number of lines to scroll when the cursor gets off the
6596 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6597 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006598 When set to a negative number from -1 to -100 this is used as the
6599 percentage of the window height. Thus -50 scrolls half the window
6600 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 NOTE: This option is set to 1 when 'compatible' is set.
6602
6603 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006604'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006605 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 Minimal number of screen lines to keep above and below the cursor.
6607 This will make some context visible around where you are working. If
6608 you set it to a very large value (999) the cursor line will always be
6609 in the middle of the window (except at the start or end of the file or
6610 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006611 After using the local value, go back the global value with one of
6612 these two: >
6613 setlocal scrolloff<
6614 setlocal scrolloff=-1
6615< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 NOTE: This option is set to 0 when 'compatible' is set.
6617
6618 *'scrollopt'* *'sbo'*
6619'scrollopt' 'sbo' string (default "ver,jump")
6620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006622 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6623 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 The following words are available:
6625 ver Bind vertical scrolling for 'scrollbind' windows
6626 hor Bind horizontal scrolling for 'scrollbind' windows
6627 jump Applies to the offset between two windows for vertical
6628 scrolling. This offset is the difference in the first
6629 displayed line of the bound windows. When moving
6630 around in a window, another 'scrollbind' window may
6631 reach a position before the start or after the end of
6632 the buffer. The offset is not changed though, when
6633 moving back the 'scrollbind' window will try to scroll
6634 to the desired position when possible.
6635 When now making that window the current one, two
6636 things can be done with the relative offset:
6637 1. When "jump" is not included, the relative offset is
6638 adjusted for the scroll position in the new current
6639 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006640 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 2. When "jump" is included, the other windows are
6642 scrolled to keep the same relative offset. When
6643 going back to the other window, it still uses the
6644 same relative offset.
6645 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006646 When 'diff' mode is active there always is vertical scroll binding,
6647 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648
6649 *'sections'* *'sect'*
6650'sections' 'sect' string (default "SHNHH HUnhsh")
6651 global
6652 Specifies the nroff macros that separate sections. These are pairs of
6653 two letters (See |object-motions|). The default makes a section start
6654 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6655
6656 *'secure'* *'nosecure'* *E523*
6657'secure' boolean (default off)
6658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 When on, ":autocmd", shell and write commands are not allowed in
6660 ".vimrc" and ".exrc" in the current directory and map commands are
6661 displayed. Switch it off only if you know that you will not run into
6662 problems, or when the 'exrc' option is off. On Unix this option is
6663 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006664 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 'secure' at the end of your ~/.vimrc then.
6666 This option cannot be set from a |modeline| or in the |sandbox|, for
6667 security reasons.
6668
6669 *'selection'* *'sel'*
6670'selection' 'sel' string (default "inclusive")
6671 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 This option defines the behavior of the selection. It is only used
6673 in Visual and Select mode.
6674 Possible values:
6675 value past line inclusive ~
6676 old no yes
6677 inclusive yes yes
6678 exclusive yes no
6679 "past line" means that the cursor is allowed to be positioned one
6680 character past the line.
6681 "inclusive" means that the last character of the selection is included
6682 in an operation. For example, when "x" is used to delete the
6683 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006684 When "old" is used and 'virtualedit' allows the cursor to move past
6685 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 Note that when "exclusive" is used and selecting from the end
6687 backwards, you cannot include the last character of a line, when
6688 starting in Normal mode and 'virtualedit' empty.
6689
6690 The 'selection' option is set by the |:behave| command.
6691
6692 *'selectmode'* *'slm'*
6693'selectmode' 'slm' string (default "")
6694 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006695 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 Select mode instead of Visual mode, when a selection is started.
6697 Possible values:
6698 mouse when using the mouse
6699 key when using shifted special keys
6700 cmd when using "v", "V" or CTRL-V
6701 See |Select-mode|.
6702 The 'selectmode' option is set by the |:behave| command.
6703
6704 *'sessionoptions'* *'ssop'*
6705'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006706 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006708 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 feature}
6710 Changes the effect of the |:mksession| command. It is a comma
6711 separated list of words. Each word enables saving and restoring
6712 something:
6713 word save and restore ~
6714 blank empty windows
6715 buffers hidden and unloaded buffers, not just those in windows
6716 curdir the current directory
6717 folds manually created folds, opened/closed folds and local
6718 fold options
6719 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006720 and contain at least one lowercase letter. Only
6721 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 help the help window
6723 localoptions options and mappings local to a window or buffer (not
6724 global values for local options)
6725 options all options and mappings (also global values for local
6726 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006727 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 resize size of the Vim window: 'lines' and 'columns'
6729 sesdir the directory in which the session file is located
6730 will become the current directory (useful with
6731 projects accessed over a network from different
6732 systems)
6733 slash backslashes in file names replaced with forward
6734 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006735 tabpages all tab pages; without this only the current tab page
6736 is restored, so that you can make a session for each
6737 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006738 terminal include terminal windows where the command can be
6739 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 unix with Unix end-of-line format (single <NL>), even when
6741 on Windows or DOS
6742 winpos position of the whole Vim window
6743 winsize window sizes
6744
6745 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006746 When neither "curdir" nor "sesdir" is included, file names are stored
6747 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006748 If you leave out "options" many things won't work well after restoring
6749 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 "slash" and "unix" are useful on Windows when sharing session files
6751 with Unix. The Unix version of Vim cannot source dos format scripts,
6752 but the Windows version of Vim can source unix format scripts.
6753
6754 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006755'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 global
6757 Name of the shell to use for ! and :! commands. When changing the
6758 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6759 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006760 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 See |option-backslash| about including spaces and backslashes.
6762 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006763
Bram Moolenaara2baa732022-02-04 16:09:54 +00006764 In |restricted-mode| shell commands will not be possible. This mode
6765 is used if the value of $SHELL ends in "false" or "nologin".
6766
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006767 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006768 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6770< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006771 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006773 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006775 Example with escaped space (Vim will do this when initializing the
6776 option from $SHELL): >
6777 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006778< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006779 backslashes are consumed by `:set`.
6780
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 Under MS-Windows, when the executable ends in ".com" it must be
6782 included. Thus setting the shell to "command.com" or "4dos.com"
6783 works, but "command" and "4dos" do not work for all commands (e.g.,
6784 filtering).
6785 For unknown reasons, when using "4dos.com" the current directory is
6786 changed to "C:\". To avoid this set 'shell' like this: >
6787 :set shell=command.com\ /c\ 4dos
6788< This option cannot be set from a |modeline| or in the |sandbox|, for
6789 security reasons.
6790
6791 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006792'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006793 Win32, when 'shell' contains "powershell":
6794 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006795 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006798 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6799 For MS-Windows, the default is set according to the value of 'shell',
6800 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006801 On Unix it can have more than one flag. Each white space separated
6802 part is passed as an argument to the shell command.
6803 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006804 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 This option cannot be set from a |modeline| or in the |sandbox|, for
6806 security reasons.
6807
6808 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006809'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6810 "2>&1| tee", or
6811 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 {not available when compiled without the |+quickfix|
6814 feature}
6815 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006816 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 including spaces and backslashes.
6818 The name of the temporary file can be represented by "%s" if necessary
6819 (the file name is appended automatically if no %s appears in the value
6820 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006821 For the Amiga the default is ">". For MS-Windows using powershell the
6822 default is "2>&1 | Out-File -Encoding default", otherwise the default
6823 is ">%s 2>&1". The output is directly saved in a file and not echoed
6824 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006825 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 in a file and echoed to the screen. If the 'shell' option is "csh" or
6827 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006828 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006829 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6830 means that stderr is also included. Before using the 'shell' option a
6831 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006832 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6833 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 The initialization of this option is done after reading the ".vimrc"
6835 and the other initializations, so that when the 'shell' option is set
6836 there, the 'shellpipe' option changes automatically, unless it was
6837 explicitly set before.
6838 When 'shellpipe' is set to an empty string, no redirection of the
6839 ":make" output will be done. This is useful if you use a 'makeprg'
6840 that writes to 'makeef' by itself. If you want no piping, but do
6841 want to include the 'makeef', set 'shellpipe' to a single space.
6842 Don't forget to precede the space with a backslash: ":set sp=\ ".
6843 In the future pipes may be used for filtering and this option will
6844 become obsolete (at least for Unix).
6845 This option cannot be set from a |modeline| or in the |sandbox|, for
6846 security reasons.
6847
6848 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006849'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 Quoting character(s), put around the command passed to the shell, for
6852 the "!" and ":!" commands. The redirection is kept outside of the
6853 quoting. See 'shellxquote' to include the redirection. It's
6854 probably not useful to set both options.
6855 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006856 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006857 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 This option cannot be set from a |modeline| or in the |sandbox|, for
6859 security reasons.
6860
6861 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006862'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6863 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 String to be used to put the output of a filter command in a temporary
6866 file. See also |:!|. See |option-backslash| about including spaces
6867 and backslashes.
6868 The name of the temporary file can be represented by "%s" if necessary
6869 (the file name is appended automatically if no %s appears in the value
6870 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006871 The default is ">". For Unix, if the 'shell' option is "csh" or
6872 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006873 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006874 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6875 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006876 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6877 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006878 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6879 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 The initialization of this option is done after reading the ".vimrc"
6881 and the other initializations, so that when the 'shell' option is set
6882 there, the 'shellredir' option changes automatically unless it was
6883 explicitly set before.
6884 In the future pipes may be used for filtering and this option will
6885 become obsolete (at least for Unix).
6886 This option cannot be set from a |modeline| or in the |sandbox|, for
6887 security reasons.
6888
6889 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6890'shellslash' 'ssl' boolean (default off)
6891 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006892 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006894 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006895 powershell.exe. Backward slashes can still be typed, but they are
6896 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 Note that setting or resetting this option has no effect for some
6898 existing file names, thus this option needs to be set before opening
6899 any file for best results. This might change in the future.
6900 'shellslash' only works when a backslash can be used as a path
6901 separator. To test if this is so use: >
6902 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006903< Also see 'completeslash'.
6904
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006905 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6906'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6907 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006908 When on, use temp files for shell commands. When off use a pipe.
6909 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006910 Currently a pipe is only supported on Unix and MS-Windows 2K and
6911 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006912 :if has("filterpipe")
6913< The advantage of using a pipe is that nobody can read the temp file
6914 and the 'shell' command does not need to support redirection.
6915 The advantage of using a temp file is that the file type and encoding
6916 can be detected.
6917 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6918 |FilterWritePost| autocommands event are not triggered when
6919 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006920 The `system()` function does not respect this option and always uses
6921 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006922 NOTE: This option is set to the Vim default value when 'compatible'
6923 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006924
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 *'shelltype'* *'st'*
6926'shelltype' 'st' number (default 0)
6927 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006928 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 On the Amiga this option influences the way how the commands work
6930 which use a shell.
6931 0 and 1: always use the shell
6932 2 and 3: use the shell only to filter lines
6933 4 and 5: use shell only for ':sh' command
6934 When not using the shell, the command is executed directly.
6935
6936 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6937 1 and 3: use "shell cmd" to start external commands
6938
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006939 *'shellxescape'* *'sxe'*
6940'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006941 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006942 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006943 When 'shellxquote' is set to "(" then the characters listed in this
6944 option will be escaped with a '^' character. This makes it possible
6945 to execute most external commands with cmd.exe.
6946
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 *'shellxquote'* *'sxq'*
6948'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006949 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006950 for Win32, when 'shell' is
6951 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006952 for Win32, when 'shell' contains "sh"
6953 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 for Unix, when using system(): "\"")
6955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 Quoting character(s), put around the command passed to the shell, for
6957 the "!" and ":!" commands. Includes the redirection. See
6958 'shellquote' to exclude the redirection. It's probably not useful
6959 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006960 When the value is '(' then ')' is appended. When the value is '"('
6961 then ')"' is appended.
6962 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006963 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006964 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6965 pwsh.exe which automatically strips off the first and last quote on a
6966 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6967 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006968 'shell', to reduce the need to set this option by the user. See
6969 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 This option cannot be set from a |modeline| or in the |sandbox|, for
6971 security reasons.
6972
6973 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6974'shiftround' 'sr' boolean (default off)
6975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 Round indent to multiple of 'shiftwidth'. Applies to > and <
6977 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6978 a multiple of 'shiftwidth' (this is Vi compatible).
6979 NOTE: This option is reset when 'compatible' is set.
6980
6981 *'shiftwidth'* *'sw'*
6982'shiftwidth' 'sw' number (default 8)
6983 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006984 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006986 When zero the 'ts' value will be used. Use the |shiftwidth()|
6987 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988
6989 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006990'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6991 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 This option helps to avoid all the |hit-enter| prompts caused by file
6994 messages, for example with CTRL-G, and to avoid some other messages.
6995 It is a list of flags:
6996 flag meaning when present ~
6997 f use "(3 of 5)" instead of "(file 3 of 5)"
6998 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006999 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 m use "[+]" instead of "[Modified]"
7001 n use "[New]" instead of "[New File]"
7002 r use "[RO]" instead of "[readonly]"
7003 w use "[w]" instead of "written" for file write message
7004 and "[a]" instead of "appended" for ':w >> file' command
7005 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7006 "[unix format]" and "[mac]" instead of "[mac format]".
7007 a all of the above abbreviations
7008
7009 o overwrite message for writing a file with subsequent message
7010 for reading a file (useful for ":wn" or when 'autowrite' on)
7011 O message for reading a file overwrites any previous message.
7012 Also for quickfix message (e.g., ":cn").
7013 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007014 hit TOP, continuing at BOTTOM" messages; when using the search
7015 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 t truncate file message at the start if it is too long to fit
7017 on the command-line, "<" will appear in the left most column.
7018 Ignored in Ex mode.
7019 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007020 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 Ignored in Ex mode.
7022 W don't give "written" or "[w]" when writing a file
7023 A don't give the "ATTENTION" message when an existing swap file
7024 is found.
7025 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007026 c don't give |ins-completion-menu| messages. For example,
7027 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7028 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007029 q use "recording" instead of "recording @a"
7030 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007031 was used for the command; note that this also affects messages
7032 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007033 S do not show search count message when searching, e.g.
7034 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035
7036 This gives you the opportunity to avoid that a change between buffers
7037 requires you to hit <Enter>, but still gives as useful a message as
7038 possible for the space available. To get the whole message that you
7039 would have got with 'shm' empty, use ":file!"
7040 Useful values:
7041 shm= No abbreviation of message.
7042 shm=a Abbreviation, but no loss of information.
7043 shm=at Abbreviation, and truncate message when necessary.
7044
7045 NOTE: This option is set to the Vi default value when 'compatible' is
7046 set and to the Vim default value when 'compatible' is reset.
7047
7048 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7049'shortname' 'sn' boolean (default off)
7050 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 Filenames are assumed to be 8 characters plus one extension of 3
7052 characters. Multiple dots in file names are not allowed. When this
7053 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007054 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007056 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057
7058 *'showbreak'* *'sbr'* *E595*
7059'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007060 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007061 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 feature}
7063 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007064 values are "> " or "+++ ": >
7065 :set showbreak=>\
7066< Note the backslash to escape the trailing space. It's easier like
7067 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007068 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007069< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 comma (in a future version the comma might be used to separate the
7071 part that is shown at the end and at the start of a line).
7072 The characters are highlighted according to the '@' flag in
7073 'highlight'.
7074 Note that tabs after the showbreak will be displayed differently.
7075 If you want the 'showbreak' to appear in between line numbers, add the
7076 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007077 A window-local value overrules a global value. If the global value is
7078 set and you want no value in the current window use NONE: >
7079 :setlocal showbreak=NONE
7080<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007082'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7083 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085 {not available when compiled without the
7086 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007087 Show (partial) command in the last line of the screen. Set this
7088 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 In Visual mode the size of the selected area is shown:
7090 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007091 If the number of bytes is different it is also displayed: "2-6"
7092 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007094 - When selecting a block, the size in screen characters:
7095 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 NOTE: This option is set to the Vi default value when 'compatible' is
7097 set and to the Vim default value when 'compatible' is reset.
7098
7099 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7100'showfulltag' 'sft' boolean (default off)
7101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 When completing a word in insert mode (see |ins-completion|) from the
7103 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007104 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 matched a C function, you can see a template for what arguments are
7106 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007107 Note that this doesn't work well together with having "longest" in
7108 'completeopt', because the completion from the search pattern may not
7109 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110
7111 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7112'showmatch' 'sm' boolean (default off)
7113 global
7114 When a bracket is inserted, briefly jump to the matching one. The
7115 jump is only done if the match can be seen on the screen. The time to
7116 show the match can be set with 'matchtime'.
7117 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007118 seen or not).
7119 This option is reset when 'paste' is set and restored when 'paste' is
7120 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 When the 'm' flag is not included in 'cpoptions', typing a character
7122 will immediately move the cursor back to where it belongs.
7123 See the "sm" field in 'guicursor' for setting the cursor shape and
7124 blinking when showing the match.
7125 The 'matchpairs' option can be used to specify the characters to show
7126 matches for. 'rightleft' and 'revins' are used to look for opposite
7127 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007128 Also see the matchparen plugin for highlighting the match when moving
7129 around |pi_paren.txt|.
7130 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131
7132 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7133'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7134 global
7135 If in Insert, Replace or Visual mode put a message on the last line.
7136 Use the 'M' flag in 'highlight' to set the type of highlighting for
7137 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007138 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 doesn't mean XIM is really active, especially when 'imactivatekey' is
7140 not set.
7141 NOTE: This option is set to the Vi default value when 'compatible' is
7142 set and to the Vim default value when 'compatible' is reset.
7143
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007144 *'showtabline'* *'stal'*
7145'showtabline' 'stal' number (default 1)
7146 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007147 The value of this option specifies when the line with tab page labels
7148 will be displayed:
7149 0: never
7150 1: only if there are at least two tab pages
7151 2: always
7152 This is both for the GUI and non-GUI implementation of the tab pages
7153 line.
7154 See |tab-page| for more information about tab pages.
7155
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 *'sidescroll'* *'ss'*
7157'sidescroll' 'ss' number (default 0)
7158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 The minimal number of columns to scroll horizontally. Used only when
7160 the 'wrap' option is off and the cursor is moved off of the screen.
7161 When it is zero the cursor will be put in the middle of the screen.
7162 When using a slow terminal set it to a large number or 0. When using
7163 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7164 commands.
7165
7166 *'sidescrolloff'* *'siso'*
7167'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007168 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007170 right of the cursor if 'nowrap' is set. Setting this option to a
7171 value greater than 0 while having |'sidescroll'| also at a non-zero
7172 value makes some context visible in the line you are scrolling in
7173 horizontally (except at beginning of the line). Setting this option
7174 to a large value (like 999) has the effect of keeping the cursor
7175 horizontally centered in the window, as long as one does not come too
7176 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007177 After using the local value, go back the global value with one of
7178 these two: >
7179 setlocal sidescrolloff<
7180 setlocal sidescrolloff=-1
7181< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182
7183 Example: Try this together with 'sidescroll' and 'listchars' as
7184 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007185 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186
7187 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7188 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007189<
7190 *'signcolumn'* *'scl'*
7191'signcolumn' 'scl' string (default "auto")
7192 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007193 {not available when compiled without the |+signs|
7194 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007195 Whether or not to draw the signcolumn. Valid values are:
7196 "auto" only when there is a sign to display
7197 "no" never
7198 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007199 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007200 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201
7202
7203 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7204'smartcase' 'scs' boolean (default off)
7205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 Override the 'ignorecase' option if the search pattern contains upper
7207 case characters. Only used when the search pattern is typed and
7208 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007209 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7211 recalling the search pattern from history and hitting <Enter>.
7212 NOTE: This option is reset when 'compatible' is set.
7213
7214 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7215'smartindent' 'si' boolean (default off)
7216 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 {not available when compiled without the
7218 |+smartindent| feature}
7219 Do smart autoindenting when starting a new line. Works for C-like
7220 programs, but can also be used for other languages. 'cindent' does
7221 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007222 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007223 setting 'si' has no effect. 'indentexpr' is a more advanced
7224 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 Normally 'autoindent' should also be on when using 'smartindent'.
7226 An indent is automatically inserted:
7227 - After a line ending in '{'.
7228 - After a line starting with a keyword from 'cinwords'.
7229 - Before a line starting with '}' (only with the "O" command).
7230 When typing '}' as the first character in a new line, that line is
7231 given the same indent as the matching '{'.
7232 When typing '#' as the first character in a new line, the indent for
7233 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007234 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7236 When using the ">>" command, lines starting with '#' are not shifted
7237 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007238 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007239 This option is reset when 'paste' is set and restored when 'paste' is
7240 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241
7242 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7243'smarttab' 'sta' boolean (default off)
7244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007246 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7247 <BS> will delete a 'shiftwidth' worth of space at the start of the
7248 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007249 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007250 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7251 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007252 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007254 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007255 This option is reset when 'paste' is set and restored when 'paste' is
7256 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 NOTE: This option is reset when 'compatible' is set.
7258
7259 *'softtabstop'* *'sts'*
7260'softtabstop' 'sts' number (default 0)
7261 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 Number of spaces that a <Tab> counts for while performing editing
7263 operations, like inserting a <Tab> or using <BS>. It "feels" like
7264 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7265 used. This is useful to keep the 'ts' setting at its standard value
7266 of 8, while being able to edit like it is set to 'sts'. However,
7267 commands like "x" still work on the actual characters.
7268 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007269 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007270 'softtabstop' is set to 0 when the 'paste' option is set and restored
7271 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7273 spaces is minimized by using <Tab>s.
7274 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7275 set.
7276 NOTE: This option is set to 0 when 'compatible' is set.
7277
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007278 If Vim is compiled with the |+vartabs| feature then the value of
7279 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7280 anything other than an empty string.
7281
Bram Moolenaar217ad922005-03-20 22:37:15 +00007282 *'spell'* *'nospell'*
7283'spell' boolean (default off)
7284 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007285 {not available when compiled without the |+syntax|
7286 feature}
7287 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007288 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007289
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007290 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007291'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007292 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007293 {not available when compiled without the |+syntax|
7294 feature}
7295 Pattern to locate the end of a sentence. The following word will be
7296 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007297 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007298 When this check is not wanted make this option empty.
7299 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007300 Be careful with special characters, see |option-backslash| about
7301 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007302 To set this option automatically depending on the language, see
7303 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007304
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007305 *'spellfile'* *'spf'*
7306'spellfile' 'spf' string (default empty)
7307 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007308 {not available when compiled without the |+syntax|
7309 feature}
7310 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007311 commands. It must end in ".{encoding}.add". You need to include the
7312 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007313 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007314 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007315 |zg| and |zw| commands can be used to access each. This allows using
7316 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007317 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007318 you: Using the first directory in 'runtimepath' that is writable. If
7319 there is no "spell" directory yet it will be created. For the file
7320 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007321 ignoring the region.
7322 The resulting ".spl" file will be used for spell checking, it does not
7323 have to appear in 'spelllang'.
7324 Normally one file is used for all regions, but you can add the region
7325 name if you want to. However, it will then only be used when
7326 'spellfile' is set to it, for entries in 'spelllang' only files
7327 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007328 This option cannot be set from a |modeline| or in the |sandbox|, for
7329 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007330
Bram Moolenaar217ad922005-03-20 22:37:15 +00007331 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007332'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007333 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007334 {not available when compiled without the |+syntax|
7335 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007336 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007337 on spellchecking will be done for these languages. Example: >
7338 set spelllang=en_us,nl,medical
7339< This means US English, Dutch and medical words are recognized. Words
7340 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007341 The word list name must consist of alphanumeric characters, a dash or
7342 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007343 recommended to separate the two letter language name from a
7344 specification. Thus "en-rare" is used for rare English words.
7345 A region name must come last and have the form "_xx", where "xx" is
7346 the two-letter, lower case region name. You can use more than one
7347 region by listing them: "en_us,en_ca" supports both US and Canadian
7348 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007349 Britain. (Note: currently en_au and en_nz dictionaries are older than
7350 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007351 If the name "cjk" is included East Asian characters are excluded from
7352 spell checking. This is useful when editing text that also has Asian
7353 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007354 Note that the "medical" dictionary does not exist, it is just an
7355 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007356 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007357 As a special case the name of a .spl file can be given as-is. The
7358 first "_xx" in the name is removed and used as the region name
7359 (_xx is an underscore, two letters and followed by a non-letter).
7360 This is mainly for testing purposes. You must make sure the correct
7361 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007362 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007363 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7364 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007365 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007366
Bram Moolenaar98692072006-02-04 00:57:42 +00007367 If the |spellfile.vim| plugin is active and you use a language name
7368 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7369 will ask you if you want to download the file.
7370
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007371 After this option has been set successfully, Vim will source the files
7372 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007373 up to the first character that is not an ASCII letter or number and
7374 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007375
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007376 *'spelloptions'* *'spo'*
7377'spelloptions' 'spo' string (default "")
7378 local to buffer
7379 {not available when compiled without the |+syntax|
7380 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007381 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007382 camel When a word is CamelCased, assume "Cased" is a
7383 separate word: every upper-case character in a word
7384 that comes after a lower case character indicates the
7385 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007386
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007387 *'spellsuggest'* *'sps'*
7388'spellsuggest' 'sps' string (default "best")
7389 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007390 {not available when compiled without the |+syntax|
7391 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007392 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007393 the |spellsuggest()| function. This is a comma-separated list of
7394 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007395
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007396 best Internal method that works best for English. Finds
7397 changes like "fast" and uses a bit of sound-a-like
7398 scoring to improve the ordering.
7399
7400 double Internal method that uses two methods and mixes the
7401 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007402 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007403 word. That only works when the language specifies
7404 sound folding. Can be slow and doesn't always give
7405 better results.
7406
7407 fast Internal method that only checks for simple changes:
7408 character inserts/deletes/swaps. Works well for
7409 simple typing mistakes.
7410
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007411 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007412 Not used for |spellsuggest()|. The number of
7413 suggestions is never more than the value of 'lines'
7414 minus two.
7415
Bram Moolenaar585ee072022-01-29 11:22:17 +00007416 timeout:{millisec} Limit the time searching for suggestions to
7417 {millisec} milli seconds. Applies to the following
7418 methods. When omitted the limit is 5000. When
7419 negative there is no limit. {only works when built
7420 with the +reltime feature}
7421
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007422 file:{filename} Read file {filename}, which must have two columns,
7423 separated by a slash. The first column contains the
7424 bad word, the second column the suggested good word.
7425 Example:
7426 theribal/terrible ~
7427 Use this for common mistakes that do not appear at the
7428 top of the suggestion list with the internal methods.
7429 Lines without a slash are ignored, use this for
7430 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007431 The word in the second column must be correct,
7432 otherwise it will not be used. Add the word to an
7433 ".add" file if it is currently flagged as a spelling
7434 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007435 The file is used for all languages.
7436
7437 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7438 trouble with spaces. |v:val| holds the badly spelled
7439 word. The expression must evaluate to a List of
7440 Lists, each with a suggestion and a score.
7441 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007442 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007443 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007444 internal methods use. A lower score is better.
7445 This may invoke |spellsuggest()| if you temporarily
7446 set 'spellsuggest' to exclude the "expr:" part.
7447 Errors are silently ignored, unless you set the
7448 'verbose' option to a non-zero value.
7449
7450 Only one of "best", "double" or "fast" may be used. The others may
7451 appear several times in any order. Example: >
7452 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7453<
7454 This option cannot be set from a |modeline| or in the |sandbox|, for
7455 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007456
7457
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7459'splitbelow' 'sb' boolean (default off)
7460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 When on, splitting a window will put the new window below the current
7462 one. |:split|
7463
7464 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7465'splitright' 'spr' boolean (default off)
7466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 When on, splitting a window will put the new window right of the
7468 current one. |:vsplit|
7469
7470 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7471'startofline' 'sol' boolean (default on)
7472 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007474 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007475 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007476 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 with a linewise operator, with "%" with a count and to buffer changing
7478 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7479 only has a line number, e.g., ":25" or ":+".
7480 In case of buffer changing commands the cursor is placed at the column
7481 where it was the last time the buffer was edited.
7482 NOTE: This option is set when 'compatible' is set.
7483
Bram Moolenaar00654022011-02-25 14:42:19 +01007484 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007486 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 {not available when compiled without the |+statusline|
7488 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007489 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 Also see |status-line|.
7491
7492 The option consists of printf style '%' items interspersed with
7493 normal text. Each status line item is of the form:
7494 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007495 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007496 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497
Bram Moolenaar238a5642006-02-21 22:12:05 +00007498 When the option starts with "%!" then it is used as an expression,
7499 evaluated and the result is used as the option value. Example: >
7500 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007501< The *g:statusline_winid* variable will be set to the |window-ID| of the
7502 window that the status line belongs to.
7503 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007504 Note that the "%!" expression is evaluated in the context of the
7505 current window and buffer, while %{} items are evaluated in the
7506 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007507
7508 When there is error while evaluating the option then it will be made
7509 empty to avoid further errors. Otherwise screen updating would loop.
7510
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 Note that the only effect of 'ruler' when this option is set (and
7512 'laststatus' is 2) is controlling the output of |CTRL-G|.
7513
7514 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007515 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007517 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 minwid Minimum width of the item, padding as set by '-' & '0'.
7519 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007520 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 on the left for text items. Numeric items will be
7522 shifted down to maxwid-2 digits followed by '>'number
7523 where number is the amount of missing digits, much like
7524 an exponential notation.
7525 item A one letter code as described below.
7526
7527 Following is a description of the possible statusline items. The
7528 second character in "item" is the type:
7529 N for number
7530 S for string
7531 F for flags as described below
7532 - not applicable
7533
7534 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007535 f S Path to the file in the buffer, as typed or relative to current
7536 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 F S Full path to the file in the buffer.
7538 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007539 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007541 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007543 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007545 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007547 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007549 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7551 being used: "<keymap>"
7552 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007553 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 B N As above, in hexadecimal.
7555 o N Byte number in file of byte under cursor, first byte is 1.
7556 Mnemonic: Offset from start of file (with one added)
7557 {not available when compiled without |+byte_offset| feature}
7558 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007559 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 l N Line number.
7561 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007562 c N Column number (byte index).
7563 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007564 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 p N Percentage through file in lines as in |CTRL-G|.
7566 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007567 percentage described for 'ruler'. Always 3 in length, unless
7568 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007569 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007571 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007572 Note that there is no '%' before the closing '}'. The
7573 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007574 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007575 {% - This is almost same as { except the result of the expression is
7576 re-evaluated as a statusline format string. Thus if the
7577 return value of expr contains % items they will get expanded.
7578 The expression can contain the } character, the end of
7579 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007580 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007581 func! Stl_filename() abort
7582 return "%t"
7583 endfunc
7584< `stl=%{Stl_filename()}` results in `"%t"`
7585 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007586 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 ( - Start of item group. Can be used for setting the width and
7588 alignment of a section. Must be followed by %) somewhere.
7589 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007590 T N For 'tabline': start of tab page N label. Use %T after the last
7591 label. This information is used for mouse clicks.
7592 X N For 'tabline': start of close tab N label. Use %X after the
7593 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7594 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 < - Where to truncate line if too long. Default is at the start.
7596 No width fields allowed.
7597 = - Separation point between left and right aligned items.
7598 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007599 # - Set highlight group. The name must follow and then a # again.
7600 Thus use %#HLname# for highlight group HLname. The same
7601 highlighting is used, also for the statusline of non-current
7602 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007604 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 The difference between User{N} and StatusLine will be applied
7606 to StatusLineNC for the statusline of non-current windows.
7607 The number N must be between 1 and 9. See |hl-User1..9|
7608
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007609 When displaying a flag, Vim removes the leading comma, if any, when
7610 that flag comes right after plaintext. This will make a nice display
7611 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612
Bram Moolenaar582fd852005-03-28 20:58:01 +00007613 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 not set) and a minwid is not set for the group, the whole group will
7615 become empty. This will make a group like the following disappear
7616 completely from the statusline when none of the flags are set. >
7617 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007618< Beware that an expression is evaluated each and every time the status
7619 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007620 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007621 While evaluating %{} the current buffer and current window will be set
7622 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007623 currently being drawn. The expression will evaluate in this context.
7624 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7625 real current buffer and "g:actual_curwin" to the |window-ID| of the
7626 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007627
Bram Moolenaar30b65812012-07-12 22:01:11 +02007628 The 'statusline' option will be evaluated in the |sandbox| if set from
7629 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007630 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007631
7632 It is not allowed to change text or jump to another window while
7633 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634
7635 If the statusline is not updated when you want it (e.g., after setting
7636 a variable that's used in an expression), you can force an update by
7637 setting an option without changing its value. Example: >
7638 :let &ro = &ro
7639
7640< A result of all digits is regarded a number for display purposes.
7641 Otherwise the result is taken as flag text and applied to the rules
7642 described above.
7643
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007644 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007646 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647
7648 Examples:
7649 Emulate standard status line with 'ruler' set >
7650 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7651< Similar, but add ASCII value of char under the cursor (like "ga") >
7652 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7653< Display byte count and byte value, modified flag in red. >
7654 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7655 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7656< Display a ,GZ flag if a compressed file is loaded >
7657 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7658< In the |:autocmd|'s: >
7659 :let b:gzflag = 1
7660< And: >
7661 :unlet b:gzflag
7662< And define this function: >
7663 :function VarExists(var, val)
7664 : if exists(a:var) | return a:val | else | return '' | endif
7665 :endfunction
7666<
7667 *'suffixes'* *'su'*
7668'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670 Files with these suffixes get a lower priority when multiple files
7671 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007672 suffixes. Spaces after the comma are ignored. A dot is also seen as
7673 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 separator, precede it with a backslash (see |option-backslash| about
7675 including spaces and backslashes).
7676 See 'wildignore' for completely ignoring files.
7677 The use of |:set+=| and |:set-=| is preferred when adding or removing
7678 suffixes from the list. This avoids problems when a future version
7679 uses another default.
7680
7681 *'suffixesadd'* *'sua'*
7682'suffixesadd' 'sua' string (default "")
7683 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 {not available when compiled without the
7685 |+file_in_path| feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007686 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 file for the "gf", "[I", etc. commands. Example: >
7688 :set suffixesadd=.java
7689<
7690 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7691'swapfile' 'swf' boolean (default on)
7692 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007693 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 swapfile is not wanted for a specific buffer. For example, with
7695 confidential information that even root must not be able to access.
7696 Careful: All text will be in memory:
7697 - Don't use this for big files.
7698 - Recovery will be impossible!
7699 A swapfile will only be present when |'updatecount'| is non-zero and
7700 'swapfile' is set.
7701 When 'swapfile' is reset, the swap file for the current buffer is
7702 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7703 non-zero, a swap file is immediately created.
7704 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007705 If you want to open a new buffer without creating a swap file for it,
7706 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007707 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708
7709 This option is used together with 'bufhidden' and 'buftype' to
7710 specify special kinds of buffers. See |special-buffers|.
7711
7712 *'swapsync'* *'sws'*
7713'swapsync' 'sws' string (default "fsync")
7714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007716 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 When this option is empty parts of the swap file may be in memory and
7718 not written to disk. When the system crashes you may lose more work.
7719 On Unix the system does a sync now and then without Vim asking for it,
7720 so the disadvantage of setting this option off is small. On some
7721 systems the swap file will not be written at all. For a unix system
7722 setting it to "sync" will use the sync() call instead of the default
7723 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007724 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725
7726 *'switchbuf'* *'swb'*
7727'switchbuf' 'swb' string (default "")
7728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007730 Mostly for |quickfix| commands some values are also used for other
7731 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007732 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 useopen If included, jump to the first open window that
7734 contains the specified buffer (if there is one).
7735 Otherwise: Do not examine other windows.
7736 This setting is checked with |quickfix| commands, when
7737 jumping to errors (":cc", ":cn", "cp", etc.). It is
7738 also used in all buffer related split commands, for
7739 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007740 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007741 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007743 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007744 Otherwise: do not split, use current window (when used
7745 in the quickfix window: the previously used window or
7746 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007747 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007748 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007749 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007750 uselast If included, jump to the previously used window when
7751 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007753 *'synmaxcol'* *'smc'*
7754'synmaxcol' 'smc' number (default 3000)
7755 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007756 {not available when compiled without the |+syntax|
7757 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007758 Maximum column in which to search for syntax items. In long lines the
7759 text after this column is not highlighted and following lines may not
7760 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007761 This helps to avoid very slow redrawing for an XML file that is one
7762 long line.
7763 Set to zero to remove the limit.
7764
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 *'syntax'* *'syn'*
7766'syntax' 'syn' string (default empty)
7767 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 {not available when compiled without the |+syntax|
7769 feature}
7770 When this option is set, the syntax with this name is loaded, unless
7771 syntax highlighting has been switched off with ":syntax off".
7772 Otherwise this option does not always reflect the current syntax (the
7773 b:current_syntax variable does).
7774 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007775 not automatically recognized. Example, in an IDL file:
7776 /* vim: set syntax=idl : */ ~
7777 When a dot appears in the value then this separates two filetype
7778 names. Example:
7779 /* vim: set syntax=c.doxygen : */ ~
7780 This will use the "c" syntax first, then the "doxygen" syntax.
7781 Note that the second one must be prepared to be loaded as an addition,
7782 otherwise it will be skipped. More than one dot may appear.
7783 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 :set syntax=OFF
7785< To switch syntax highlighting on according to the current value of the
7786 'filetype' option: >
7787 :set syntax=ON
7788< What actually happens when setting the 'syntax' option is that the
7789 Syntax autocommand event is triggered with the value as argument.
7790 This option is not copied to another buffer, independent of the 's' or
7791 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007792 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007794 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007795'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007796 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007797 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007798 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007799 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007800
7801 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007802 option and only when there is no GUI tab line. When 'e' is in
7803 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007804 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007805
7806 The value is evaluated like with 'statusline'. You can use
7807 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007808 the text to be displayed. Use "%1T" for the first label, "%2T" for
7809 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007810
Bram Moolenaare12bab32019-01-08 22:02:56 +01007811 When changing something that is used in 'tabline' that does not
7812 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007813 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007814
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007815 Keep in mind that only one of the tab pages is the current one, others
7816 are invisible and you can't jump to their windows.
7817
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007818
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007819 *'tabpagemax'* *'tpm'*
7820'tabpagemax' 'tpm' number (default 10)
7821 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007822 Maximum number of tab pages to be opened by the |-p| command line
7823 argument or the ":tab all" command. |tabpage|
7824
7825
7826 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827'tabstop' 'ts' number (default 8)
7828 local to buffer
7829 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007830 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831
7832 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007833 appear wrong in many places, e.g., when printing it.
7834 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835
7836 There are four main ways to use tabs in Vim:
7837 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7838 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007839 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840 behave like a tab appears every 4 (or 3) characters.
7841 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7842 'expandtab'. This way you will always insert spaces. The
7843 formatting will never be messed up when 'tabstop' is changed.
7844 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007845 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846 works when using Vim to edit the file.
7847 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7848 'noexpandtab'. This should then work (for initial indents only)
7849 for any tabstop setting that people use. It might be nice to have
7850 tabs after the first non-blank inserted as spaces if you do this
7851 though. Otherwise aligned comments will be wrong when 'tabstop' is
7852 changed.
7853
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007854 If Vim is compiled with the |+vartabs| feature then the value of
7855 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7856 than an empty string.
7857
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7859'tagbsearch' 'tbs' boolean (default on)
7860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007862 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863 searching makes searching for a tag a LOT faster, but a linear search
7864 will find more tags if the tags file wasn't properly sorted.
7865 Vim normally assumes that your tags files are sorted, or indicate that
7866 they are not sorted. Only when this is not the case does the
7867 'tagbsearch' option need to be switched off.
7868
7869 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007870 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 certain files, or retry all files with a linear search. When
7872 'tagbsearch' is off, only a linear search is done.
7873
7874 Linear searching is done anyway, for one file, when Vim finds a line
7875 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007876 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877< [The whitespace before and after the '0' must be a single <Tab>]
7878
7879 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007880 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 instead of a normal tag name, a retry is done with a linear search.
7882 Tags in unsorted tags files, and matches with different case will only
7883 be found in the retry.
7884
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007885 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007886 linear search can be avoided when case is ignored. Use a value of '2'
7887 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7888 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007889 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7890 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7891 used for this as well. Note that case must be folded to uppercase for
7892 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007893
7894 By default, tag searches are case-sensitive. Case is ignored when
7895 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7896 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007897 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7898 'tagcase' is "smart", and the pattern contains only lowercase
7899 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900
7901 When 'tagbsearch' is off, tags searching is slower when a full match
7902 exists, but faster when no full match exists. Tags in unsorted tags
7903 files may only be found with 'tagbsearch' off.
7904 When the tags file is not sorted, or sorted in a wrong way (not on
7905 ASCII byte value), 'tagbsearch' should be off, or the line given above
7906 must be included in the tags file.
7907 This option doesn't affect commands that find all matching tags (e.g.,
7908 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007910 *'tagcase'* *'tc'*
7911'tagcase' 'tc' string (default "followic")
7912 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007913 This option specifies how case is handled when searching the tags
7914 file:
7915 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007916 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007917 ignore Ignore case
7918 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007919 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007920 NOTE: This option is set to the Vi default value when 'compatible' is
7921 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007922
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007923 *'tagfunc'* *'tfu'*
7924'tagfunc' 'tfu' string (default: empty)
7925 local to buffer
7926 {not available when compiled without the |+eval|
7927 feature}
7928 This option specifies a function to be used to perform tag searches.
7929 The function gets the tag pattern and should return a List of matching
7930 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007931 function and an example. The value can be the name of a function, a
7932 |lambda| or a |Funcref|. See |option-value-function| for more
7933 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007934
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 *'taglength'* *'tl'*
7936'taglength' 'tl' number (default 0)
7937 global
7938 If non-zero, tags are significant up to this number of characters.
7939
7940 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7941'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7942 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007943 If on and using a tags file in another directory, file names in that
7944 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 NOTE: This option is set to the Vi default value when 'compatible' is
7946 set and to the Vim default value when 'compatible' is reset.
7947
7948 *'tags'* *'tag'* *E433*
7949'tags' 'tag' string (default "./tags,tags", when compiled with
7950 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7951 global or local to buffer |global-local|
7952 Filenames for the tag command, separated by spaces or commas. To
7953 include a space or comma in a file name, precede it with a backslash
7954 (see |option-backslash| about including spaces and backslashes).
7955 When a file name starts with "./", the '.' is replaced with the path
7956 of the current file. But only when the 'd' flag is not included in
7957 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7958 |tags-option|.
7959 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007960 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7961 find all files named "tags" below "/lib". The filename itself cannot
7962 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7963 files called "tags?". {not available when compiled without the
7964 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007965 The |tagfiles()| function can be used to get a list of the file names
7966 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7968 files are also supported. They are automatically recognized. The
7969 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7970 differences are ignored (MS-Windows). |emacs-tags|
7971 The use of |:set+=| and |:set-=| is preferred when adding or removing
7972 file names from the list. This avoids problems when a future version
7973 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974
7975 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7976'tagstack' 'tgst' boolean (default on)
7977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 When on, the |tagstack| is used normally. When off, a ":tag" or
7979 ":tselect" command with an argument will not push the tag onto the
7980 tagstack. A following ":tag" without an argument, a ":pop" command or
7981 any other command that uses the tagstack will use the unmodified
7982 tagstack, but does change the pointer to the active entry.
7983 Resetting this option is useful when using a ":tag" command in a
7984 mapping which should not change the tagstack.
7985
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007986 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007987'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007988 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007989 {only available when compiled with the |+tcl/dyn|
7990 feature}
7991 Specifies the name of the Tcl shared library. The default is
7992 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007993 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007994 This option cannot be set from a |modeline| or in the |sandbox|, for
7995 security reasons.
7996
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 *'term'* *E529* *E530* *E531*
7998'term' string (default is $TERM, if that fails:
7999 in the GUI: "builtin_gui"
8000 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008001 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008002 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003 on Unix: "ansi"
8004 on VMS: "ansi"
8005 on Win 32: "win32")
8006 global
8007 Name of the terminal. Used for choosing the terminal control
8008 characters. Environment variables are expanded |:set_env|.
8009 For example: >
8010 :set term=$TERM
8011< See |termcap|.
8012
8013 *'termbidi'* *'tbidi'*
8014 *'notermbidi'* *'notbidi'*
8015'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 {only available when compiled with the |+arabic|
8018 feature}
8019 The terminal is in charge of Bi-directionality of text (as specified
8020 by Unicode). The terminal is also expected to do the required shaping
8021 that some languages (such as Arabic) require.
8022 Setting this option implies that 'rightleft' will not be set when
8023 'arabic' is set and the value of 'arabicshape' will be ignored.
8024 Note that setting 'termbidi' has the immediate effect that
8025 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8026 This option is reset when the GUI is started.
8027 For further details see |arabic.txt|.
8028
8029 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008030'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 Encoding used for the terminal. This specifies what character
8033 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008034 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008035 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008036 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008037 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8039 Any attempts to set a different value will be rejected, and an error
8040 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008041 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 because the Win32 system always passes Unicode characters.
8043 When empty, the same encoding is used as for the 'encoding' option.
8044 This is the normal value.
8045 Not all combinations for 'termencoding' and 'encoding' are valid. See
8046 |encoding-table|.
8047 The value for this option must be supported by internal conversions or
8048 iconv(). When this is not possible no conversion will be done and you
8049 will probably experience problems with non-ASCII characters.
8050 Example: You are working with the locale set to euc-jp (Japanese) and
8051 want to edit a UTF-8 file: >
8052 :let &termencoding = &encoding
8053 :set encoding=utf-8
8054< You need to do this when your system has no locale support for UTF-8.
8055
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008056 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008057'termguicolors' 'tgc' boolean (default off)
8058 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008059 {not available when compiled without the
8060 |+termguicolors| feature}
8061 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008062 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008063
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008064 Requires a ISO-8613-3 compatible terminal. If setting this option
8065 does not work (produces a colorless UI) reading |xterm-true-color|
8066 might help.
8067
8068 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8069 is required. Use this check to find out: >
8070 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008071< This requires Vim to be built with the |+vtp| feature.
8072
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008073 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008074 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008075
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008076 *'termwinkey'* *'twk'*
8077'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008078 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008079 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008080 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008081 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008082 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008083< The string must be one key stroke but can be multiple bytes.
8084 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008085 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008086 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008087
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008088 *'termwinscroll'* *'twsl'*
8089'termwinscroll' 'twsl' number (default 10000)
8090 local to buffer
8091 {not available when compiled without the
8092 |+terminal| feature}
8093 Number of scrollback lines to keep. When going over this limit the
8094 first 10% of the scrollback lines are deleted. This is just to reduce
8095 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008096 Also used as a limit for text sent to the terminal in one write,
8097 multiplied by the number of columns times 3 (average number of bytes
8098 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008099
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008100 *'termwinsize'* *'tws'*
8101'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008102 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008103 Size used when opening the |terminal| window. Format:
8104 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008105 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008106 - When set with a "x" (e.g., "24x80") the terminal size is not
8107 adjusted to the window size. If the window is smaller only the
8108 top-left part is displayed.
8109 - When set with a "*" (e.g., "10*50") the terminal size follows the
8110 window size, but will not be smaller than the specified rows and/or
8111 columns.
8112 - When rows is zero then use the height of the window.
8113 - When columns is zero then use the width of the window.
8114 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008115 - Can be overruled in the |term_start()| options with "term_rows" and
8116 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008117
8118 Examples:
8119 "30x0" uses 30 rows and the current window width.
8120 "20*0" uses at least 20 rows and the current window width.
8121 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008122 Note that the command running in the terminal window may still change
8123 the size of the terminal. In that case the Vim window will be
8124 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008125
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008126 *'termwintype'* *'twt'*
8127'termwintype' 'twt' string (default "")
8128 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008129 {only available when compiled with the |terminal|
8130 feature on MS-Windows}
8131 Specify the virtual console (pty) used when opening the terminal
8132 window.
8133
8134 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008135 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008136 "winpty" use winpty, fail if not supported
8137 "conpty" use |ConPTY|, fail if not supported
8138
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008139 |ConPTY| support depends on the platform. Windows 10 October 2018
8140 Update is the first version that supports ConPTY, however it is still
8141 considered unstable. ConPTY might become stable in the next release
8142 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008143 supported then you cannot open a terminal window.
8144
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 *'terse'* *'noterse'*
8146'terse' boolean (default off)
8147 global
8148 When set: Add 's' flag to 'shortmess' option (this makes the message
8149 for a search that hits the start or end of the file not being
8150 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8151 shortens a lot of messages}
8152
8153 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8154'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 This option is obsolete. Use 'fileformats'.
8157 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8158 set to the default value for the current system. When 'textauto' is
8159 reset, 'fileformats' is made empty.
8160 NOTE: This option is set to the Vi default value when 'compatible' is
8161 set and to the Vim default value when 'compatible' is reset.
8162
8163 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008164'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 others: default off)
8166 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 This option is obsolete. Use 'fileformat'.
8168 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8169 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8170 "unix".
8171
8172 *'textwidth'* *'tw'*
8173'textwidth' 'tw' number (default 0)
8174 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 Maximum width of text that is being inserted. A longer line will be
8176 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008177 this.
8178 'textwidth' is set to 0 when the 'paste' option is set and restored
8179 when 'paste' is reset.
8180 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008181 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008182 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 NOTE: This option is set to 0 when 'compatible' is set.
8184
8185 *'thesaurus'* *'tsr'*
8186'thesaurus' 'tsr' string (default "")
8187 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008189 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8190 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008191
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008192 This option is not used if 'thesaurusfunc' is set, either for the
8193 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008195 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008197 name. See |option-backslash| about using backslashes. The use of
8198 |:set+=| and |:set-=| is preferred when adding or removing directories
8199 from the list. This avoids problems when a future version uses
8200 another default. Backticks cannot be used in this option for security
8201 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008203 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008204'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008205 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008206 {not available when compiled without the |+eval|
8207 feature}
8208 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008209 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008210 The value can be the name of a function, a |lambda| or a |Funcref|.
8211 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008212
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008213 This option cannot be set from a |modeline| or in the |sandbox|, for
8214 security reasons.
8215
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8217'tildeop' 'top' boolean (default off)
8218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 When on: The tilde command "~" behaves like an operator.
8220 NOTE: This option is reset when 'compatible' is set.
8221
8222 *'timeout'* *'to'* *'notimeout'* *'noto'*
8223'timeout' 'to' boolean (default on)
8224 global
8225 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008226'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008228 These two options together determine the behavior when part of a
8229 mapped key sequence or keyboard code has been received:
8230
8231 'timeout' 'ttimeout' action ~
8232 off off do not time out
8233 on on or off time out on :mappings and key codes
8234 off on time out on key codes
8235
8236 If both options are off, Vim will wait until either the complete
8237 mapping or key sequence has been received, or it is clear that there
8238 is no mapping or key sequence for the received characters. For
8239 example: if you have mapped "vl" and Vim has received 'v', the next
8240 character is needed to see if the 'v' is followed by an 'l'.
8241 When one of the options is on, Vim will wait for about 1 second for
8242 the next character to arrive. After that the already received
8243 characters are interpreted as single characters. The waiting time can
8244 be changed with the 'timeoutlen' option.
8245 On slow terminals or very busy systems timing out may cause
8246 malfunctioning cursor keys. If both options are off, Vim waits
8247 forever after an entered <Esc> if there are key codes that start
8248 with <Esc>. You will have to type <Esc> twice. If you do not have
8249 problems with key codes, but would like to have :mapped key
8250 sequences not timing out in 1 second, set the 'ttimeout' option and
8251 reset the 'timeout' option.
8252
8253 NOTE: 'ttimeout' is reset when 'compatible' is set.
8254
8255 *'timeoutlen'* *'tm'*
8256'timeoutlen' 'tm' number (default 1000)
8257 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008258
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008260'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008262 The time in milliseconds that is waited for a key code or mapped key
8263 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8264 when part of a command has been typed.
8265 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8266 different timeout value for key codes is desired set 'ttimeoutlen' to
8267 a non-negative number.
8268
8269 ttimeoutlen mapping delay key code delay ~
8270 < 0 'timeoutlen' 'timeoutlen'
8271 >= 0 'timeoutlen' 'ttimeoutlen'
8272
8273 The timeout only happens when the 'timeout' and 'ttimeout' options
8274 tell so. A useful setting would be >
8275 :set timeout timeoutlen=3000 ttimeoutlen=100
8276< (time out on mapping after three seconds, time out on key codes after
8277 a tenth of a second).
8278
8279 *'title'* *'notitle'*
8280'title' boolean (default off, on when title can be restored)
8281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 When on, the title of the window will be set to the value of
8283 'titlestring' (if it is not empty), or to:
8284 filename [+=-] (path) - VIM
8285 Where:
8286 filename the name of the file being edited
8287 - indicates the file cannot be modified, 'ma' off
8288 + indicates the file was modified
8289 = indicates the file is read-only
8290 =+ indicates the file is read-only and modified
8291 (path) is the path of the file being edited
8292 - VIM the server name |v:servername| or "VIM"
8293 Only works if the terminal supports setting window titles
8294 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008295 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8297 *X11*
8298 When Vim was compiled with HAVE_X11 defined, the original title will
8299 be restored if possible. The output of ":version" will include "+X11"
8300 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8301 works for the icon name |'icon'|.
8302 But: When Vim was started with the |-X| argument, restoring the title
8303 will not work (except in the GUI).
8304 If the title cannot be restored, it is set to the value of 'titleold'.
8305 You might want to restore the title outside of Vim then.
8306 When using an xterm from a remote machine you can use this command:
8307 rsh machine_name xterm -display $DISPLAY &
8308 then the WINDOWID environment variable should be inherited and the
8309 title of the window should change back to what it should be after
8310 exiting Vim.
8311
8312 *'titlelen'*
8313'titlelen' number (default 85)
8314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008316 title. When the title is longer, only the end of the path name is
8317 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 Using a percentage makes this adapt to the width of the window. But
8319 it won't work perfectly, because the actual number of characters
8320 available also depends on the font used and other things in the title
8321 bar. When 'titlelen' is zero the full path is used. Otherwise,
8322 values from 1 to 30000 percent can be used.
8323 'titlelen' is also used for the 'titlestring' option.
8324
8325 *'titleold'*
8326'titleold' string (default "Thanks for flying Vim")
8327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008328 This option will be used for the window title when exiting Vim if the
8329 original title cannot be restored. Only happens if 'title' is on or
8330 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008331 This option cannot be set from a |modeline| or in the |sandbox|, for
8332 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333 *'titlestring'*
8334'titlestring' string (default "")
8335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336 When this option is not empty, it will be used for the title of the
8337 window. This happens only when the 'title' option is on.
8338 Only works if the terminal supports setting window titles (currently
8339 Amiga console, Win32 console, all GUI versions and terminals with a
8340 non-empty 't_ts' option).
8341 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008342 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008343
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344 When this option contains printf-style '%' items, they will be
8345 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008346 This option cannot be set in a modeline when 'modelineexpr' is off.
8347
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008349 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8351< The value of 'titlelen' is used to align items in the middle or right
8352 of the available space.
8353 Some people prefer to have the file name first: >
8354 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8355< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008356 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 separating space only when needed.
8358 NOTE: Use of special characters in 'titlestring' may cause the display
8359 to be garbled (e.g., when it contains a CR or NL character).
8360 {not available when compiled without the |+statusline| feature}
8361
8362 *'toolbar'* *'tb'*
8363'toolbar' 'tb' string (default "icons,tooltips")
8364 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008365 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008366 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 possible values are:
8368 icons Toolbar buttons are shown with icons.
8369 text Toolbar buttons shown with text.
8370 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008371 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 tooltips Tooltips are active for toolbar buttons.
8373 Tooltips refer to the popup help text which appears after the mouse
8374 cursor is placed over a toolbar button for a brief moment.
8375
8376 If you want the toolbar to be shown with icons as well as text, do the
8377 following: >
8378 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008379< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 will show icons if both are requested.
8381
8382 If none of the strings specified in 'toolbar' are valid or if
8383 'toolbar' is empty, this option is ignored. If you want to disable
8384 the toolbar, you need to set the 'guioptions' option. For example: >
8385 :set guioptions-=T
8386< Also see |gui-toolbar|.
8387
8388 *'toolbariconsize'* *'tbis'*
8389'toolbariconsize' 'tbis' string (default "small")
8390 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008391 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008393 tiny Use tiny icons.
8394 small Use small icons (default).
8395 medium Use medium-sized icons.
8396 large Use large icons.
8397 huge Use even larger icons.
8398 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008400 the current theme. Common dimensions are giant=48x48, huge=32x32,
8401 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402
8403 If 'toolbariconsize' is empty, the global default size as determined
8404 by user preferences or the current theme is used.
8405
8406 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8407'ttybuiltin' 'tbi' boolean (default on)
8408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409 When on, the builtin termcaps are searched before the external ones.
8410 When off the builtin termcaps are searched after the external ones.
8411 When this option is changed, you should set the 'term' option next for
8412 the change to take effect, for example: >
8413 :set notbi term=$TERM
8414< See also |termcap|.
8415 Rationale: The default for this option is "on", because the builtin
8416 termcap entries are generally better (many systems contain faulty
8417 xterm entries...).
8418
8419 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8420'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8421 sun-cmd, screen, rxvt, dtterm or
8422 iris-ansi; also on when running Vim in
8423 a DOS console)
8424 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 Indicates a fast terminal connection. More characters will be sent to
8426 the screen for redrawing, instead of using insert/delete line
8427 commands. Improves smoothness of redrawing when there are multiple
8428 windows and the terminal does not support a scrolling region.
8429 Also enables the extra writing of characters at the end of each screen
8430 line for lines that wrap. This helps when using copy/paste with the
8431 mouse in an xterm and other terminals.
8432
8433 *'ttymouse'* *'ttym'*
8434'ttymouse' 'ttym' string (default depends on 'term')
8435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 {only in Unix and VMS, doesn't work in the GUI; not
8437 available when compiled without |+mouse|}
8438 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008439 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 *xterm-mouse*
8441 xterm xterm-like mouse handling. The mouse generates
8442 "<Esc>[Mscr", where "scr" is three bytes:
8443 "s" = button state
8444 "c" = column plus 33
8445 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008446 This only works up to 223 columns! See "dec",
8447 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 xterm2 Works like "xterm", but with the xterm reporting the
8449 mouse position while the mouse is dragged. This works
8450 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008451 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 work. See below for how Vim detects this
8453 automatically.
8454 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008455 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008457 for the row and column. No other mouse events are
8458 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 *dec-mouse*
8460 dec DEC terminal mouse handling. The mouse generates a
8461 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008462 This is also available for an Xterm, if it was
8463 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008464 *jsbterm-mouse*
8465 jsbterm JSB term mouse handling.
8466 *pterm-mouse*
8467 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008468 *urxvt-mouse*
8469 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008470 The mouse works only if the terminal supports this
8471 encoding style, but it does not have 223 columns limit
8472 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008473 *sgr-mouse*
8474 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008475 mouse reporting. The mouse works even in columns
8476 beyond 223. This option is backward compatible with
8477 "xterm2" because it can also decode "xterm2" style
8478 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479
8480 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008481 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8482 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8484 recognized, if enabled at compile time. DEC terminal mouse codes
8485 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008486 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8487 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008489 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8490 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8491 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008492 Additionally, if vim is compiled with the |+termresponse| feature and
8493 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008494 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008496 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8497 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8498 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008499 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8500 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 :set t_RV=
8502<
8503 *'ttyscroll'* *'tsl'*
8504'ttyscroll' 'tsl' number (default 999)
8505 global
8506 Maximum number of lines to scroll the screen. If there are more lines
8507 to scroll the window is redrawn. For terminals where scrolling is
8508 very slow and redrawing is not slow this can be set to a small number,
8509 e.g., 3, to speed up displaying.
8510
8511 *'ttytype'* *'tty'*
8512'ttytype' 'tty' string (default from $TERM)
8513 global
8514 Alias for 'term', see above.
8515
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008516 *'undodir'* *'udir'*
8517'undodir' 'udir' string (default ".")
8518 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008519 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008520 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008521 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008522 "." means using the directory of the file. The undo file name for
8523 "file.txt" is ".file.txt.un~".
8524 For other directories the file name is the full path of the edited
8525 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008526 When writing: The first directory that exists is used. "." always
8527 works, no directories after "." will be used for writing.
8528 When reading all entries are tried to find an undo file. The first
8529 undo file that exists is used. When it cannot be read an error is
8530 given, no further entry is used.
8531 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008532 This option cannot be set from a |modeline| or in the |sandbox|, for
8533 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008534
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008535 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008536'undofile' 'udf' boolean (default off)
8537 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008538 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008539 When on, Vim automatically saves undo history to an undo file when
8540 writing a buffer to a file, and restores undo history from the same
8541 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008542 The directory where the undo file is stored is specified by 'undodir'.
8543 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008544 The undo file is not read when 'undoreload' causes the buffer from
8545 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008546 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008547 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008548
Bram Moolenaar071d4272004-06-13 20:20:40 +00008549 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008550'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008551 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008553 is kept in memory, higher numbers will cause more memory to be used.
8554 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8556 itself: >
8557 set ul=0
8558< But you can also get Vi compatibility by including the 'u' flag in
8559 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008560 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008561 Set to -1 for no undo at all. You might want to do this only for the
8562 current buffer: >
8563 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008565
8566 The local value is set to -123456 when the global value is to be used.
8567
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008568 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008570 *'undoreload'* *'ur'*
8571'undoreload' 'ur' number (default 10000)
8572 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008573 Save the whole buffer for undo when reloading it. This applies to the
8574 ":e!" command and reloading for when the buffer changed outside of
8575 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008576 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008577 of lines is smaller than the value of this option.
8578 Set this option to zero to disable undo for a reload.
8579
8580 When saving undo for a reload, any undo file is not read.
8581
8582 Note that this causes the whole buffer to be stored in memory. Set
8583 this option to a lower value if you run out of memory.
8584
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 *'updatecount'* *'uc'*
8586'updatecount' 'uc' number (default: 200)
8587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 After typing this many characters the swap file will be written to
8589 disk. When zero, no swap file will be created at all (see chapter on
8590 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8591 Vim with the "-n" option, see |startup|. When editing in readonly
8592 mode this option will be initialized to 10000.
8593 The swapfile can be disabled per buffer with |'swapfile'|.
8594 When 'updatecount' is set from zero to non-zero, swap files are
8595 created for all buffers that have 'swapfile' set. When 'updatecount'
8596 is set to zero, existing swap files are not deleted.
8597 Also see |'swapsync'|.
8598 This option has no meaning in buffers where |'buftype'| is "nofile"
8599 or "nowrite".
8600
8601 *'updatetime'* *'ut'*
8602'updatetime' 'ut' number (default 4000)
8603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 If this many milliseconds nothing is typed the swap file will be
8605 written to disk (see |crash-recovery|). Also used for the
8606 |CursorHold| autocommand event.
8607
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008608 *'varsofttabstop'* *'vsts'*
8609'varsofttabstop' 'vsts' string (default "")
8610 local to buffer
8611 {only available when compiled with the |+vartabs|
8612 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008613 A list of the number of spaces that a <Tab> counts for while editing,
8614 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8615 width <Tab>s are being inserted, while in fact a mixture of spaces
8616 and <Tab>s is used. Tab widths are separated with commas, with the
8617 final value applying to all subsequent tabs.
8618
8619 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008620 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008621 to use the following: >
8622 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008623< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8624 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008625
8626 Note that the value of |'softtabstop'| will be ignored while
8627 'varsofttabstop' is set.
8628
8629 *'vartabstop'* *'vts'*
8630'vartabstop' 'vts' string (default "")
8631 local to buffer
8632 {only available when compiled with the |+vartabs|
8633 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008634 A list of the number of spaces that a <Tab> in the file counts for,
8635 separated by commas. Each value corresponds to one tab, with the
8636 final value applying to all subsequent tabs. For example: >
8637 :set vartabstop=4,20,10,8
8638< This will make the first tab 4 spaces wide, the second 20 spaces,
8639 the third 10 spaces, and all following tabs 8 spaces.
8640
8641 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8642 is set.
8643
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 *'verbose'* *'vbs'*
8645'verbose' 'vbs' number (default 0)
8646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 When bigger than zero, Vim will give messages about what it is doing.
8648 Currently, these messages are given:
8649 >= 1 When the viminfo file is read or written.
8650 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008651 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008652 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 >= 8 Files for which a group of autocommands is executed.
8654 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008655 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 >= 12 Every executed function.
8657 >= 13 When an exception is thrown, caught, finished, or discarded.
8658 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008659 >= 15 Every executed Ex command from a script (truncated at 200
8660 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008661 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662
8663 This option can also be set with the "-V" argument. See |-V|.
8664 This option is also set by the |:verbose| command.
8665
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008666 When the 'verbosefile' option is set then the verbose messages are not
8667 displayed.
8668
8669 *'verbosefile'* *'vfile'*
8670'verbosefile' 'vfile' string (default empty)
8671 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008672 When not empty all messages are written in a file with this name.
8673 When the file exists messages are appended.
8674 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008675 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008676 Setting 'verbosefile' to a new value is like making it empty first.
8677 The difference with |:redir| is that verbose messages are not
8678 displayed when 'verbosefile' is set.
8679
Bram Moolenaar071d4272004-06-13 20:20:40 +00008680 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008681'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 "$VIM/vimfiles/view",
8683 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008684 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008685 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008686 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008687 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 feature}
8689 Name of the directory where to store files for |:mkview|.
8690 This option cannot be set from a |modeline| or in the |sandbox|, for
8691 security reasons.
8692
8693 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008694'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008696 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008698 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008699 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 word save and restore ~
8701 cursor cursor position in file and in window
8702 folds manually created folds, opened/closed folds and local
8703 fold options
8704 options options and mappings local to a window or buffer (not
8705 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008706 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 slash backslashes in file names replaced with forward
8708 slashes
8709 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008710 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008711 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008713 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008715 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716
8717 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008718'viminfo' 'vi' string (Vi default: "", Vim default for
8719 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008720 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8721 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008723 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 feature}
8725 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008726 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8727 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008728 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008729 consisting of a single character identifying the particular parameter,
8730 followed by a number or string which specifies the value of that
8731 parameter. If a particular character is left out, then the default
8732 value is used for that parameter. The following is a list of the
8733 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008735 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 ! When included, save and restore global variables that start
8737 with an uppercase letter, and don't contain a lowercase
8738 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008739 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008740 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008741 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 " Maximum number of lines saved for each register. Old name of
8743 the '<' item, with the disadvantage that you need to put a
8744 backslash before the ", otherwise it will be recognized as the
8745 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008746 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 % When included, save and restore the buffer list. If Vim is
8748 started with a file name argument, the buffer list is not
8749 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008750 buffer list is restored from the viminfo file. Quickfix
8751 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8752 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008753 When followed by a number, the number specifies the maximum
8754 number of buffers that are stored. Without a number all
8755 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008756 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 ' Maximum number of previously edited files for which the marks
8758 are remembered. This parameter must always be included when
8759 'viminfo' is non-empty.
8760 Including this item also means that the |jumplist| and the
8761 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008762 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008764 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 patterns are also saved. When not included, the value of
8766 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008767 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008769 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008770 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 < Maximum number of lines saved for each register. If zero then
8772 registers are not saved. When not included, all lines are
8773 saved. '"' is the old name for this item.
8774 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008775 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008777 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008778 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 c When included, convert the text in the viminfo file from the
8780 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008781 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008782 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 f Whether file marks need to be stored. If zero, file marks ('0
8784 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008785 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008787 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 h Disable the effect of 'hlsearch' when loading the viminfo
8789 file. When not included, it depends on whether ":nohlsearch"
8790 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008791 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008793 the 'n'. Must be at the end of the option! If the
8794 'viminfofile' option is set, that file name overrides the one
8795 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008796 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008797 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 r Removable media. The argument is a string (up to the next
8799 ','). This parameter can be given several times. Each
8800 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008801 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8803 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8804 ignored. Maximum length of each 'r' argument is 50
8805 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008806 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 s Maximum size of an item in Kbyte. If zero then registers are
8808 not saved. Currently only applies to registers. The default
8809 "s10" will exclude registers with more than 10 Kbyte of text.
8810 Also see the '<' item above: line count limit.
8811
8812 Example: >
8813 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8814<
8815 '50 Marks will be remembered for the last 50 files you
8816 edited.
8817 <1000 Contents of registers (up to 1000 lines each) will be
8818 remembered.
8819 s100 Registers with more than 100 Kbyte text are skipped.
8820 :0 Command-line history will not be saved.
8821 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8822 no / Since '/' is not specified, the default will be used,
8823 that is, save all of the search history, and also the
8824 previous search and substitute patterns.
8825 no % The buffer list will not be saved nor read back.
8826 no h 'hlsearch' highlighting will be restored.
8827
8828 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8829 load the contents of the file, this is not done automatically.
8830
8831 This option cannot be set from a |modeline| or in the |sandbox|, for
8832 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008833 NOTE: This option is set to the Vim default value when 'compatible'
8834 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008836 *'viminfofile'* *'vif'*
8837'viminfofile' 'vif' string (default: "")
8838 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008839 {not available when compiled without the |+viminfo|
8840 feature}
8841 When non-empty, overrides the file name used for viminfo.
8842 When equal to "NONE" no viminfo file will be read or written.
8843 This option can be set with the |-i| command line flag. The |--clean|
8844 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008845 This option cannot be set from a |modeline| or in the |sandbox|, for
8846 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008847
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 *'virtualedit'* *'ve'*
8849'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008850 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008851 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 block Allow virtual editing in Visual block mode.
8853 insert Allow virtual editing in Insert mode.
8854 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008855 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008856 none When used as the local value, do not allow virtual
8857 editing even when the global value is set. When used
8858 as the global value, "none" is the same as "".
8859 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008860
Bram Moolenaar071d4272004-06-13 20:20:40 +00008861 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008862 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863 of the line. Useful for selecting a rectangle in Visual mode and
8864 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008865 "onemore" is not the same, it will only allow moving the cursor just
8866 after the last character of the line. This makes some commands more
8867 consistent. Previously the cursor was always past the end of the line
8868 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008869 break some plugins or Vim scripts. For example because |l| can move
8870 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008871 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008872 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008873 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008874 It doesn't make sense to combine "all" with "onemore", but you will
8875 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008876 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008877 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878
8879 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8880'visualbell' 'vb' boolean (default off)
8881 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008882 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008883 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008884 use: >
8885 :set vb t_vb=
8886< If you want a short flash, you can use this on many terminals: >
8887 :set vb t_vb=[?5h$<100>[?5l
8888< Here $<100> specifies the time, you can use a smaller or bigger value
8889 to get a shorter or longer flash.
8890
8891 Note: Vim will limit the bell to once per half a second. This avoids
8892 having to wait for the flashing to finish when there are lots of
8893 bells, e.g. on key repeat. This also happens without 'visualbell'
8894 set.
8895
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8897 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8898 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008899
8900 Note: When the GUI starts, 't_vb' is reset to its default value. You
8901 might want to set it again in your |gvimrc|.
8902
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 Does not work on the Amiga, you always get a screen flash.
8904 Also see 'errorbells'.
8905
8906 *'warn'* *'nowarn'*
8907'warn' boolean (default on)
8908 global
8909 Give a warning message when a shell command is used while the buffer
8910 has been changed.
8911
8912 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8913'weirdinvert' 'wiv' boolean (default off)
8914 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008915 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 It is provided for backwards compatibility with version 4.x.
8917 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8918 vice versa. Has no effect when the GUI is running.
8919
8920 *'whichwrap'* *'ww'*
8921'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8922 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008923 Allow specified keys that move the cursor left/right to move to the
8924 previous/next line when the cursor is on the first/last character in
8925 the line. Concatenate characters to allow this for these keys:
8926 char key mode ~
8927 b <BS> Normal and Visual
8928 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008929 h "h" Normal and Visual (not recommended)
8930 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 < <Left> Normal and Visual
8932 > <Right> Normal and Visual
8933 ~ "~" Normal
8934 [ <Left> Insert and Replace
8935 ] <Right> Insert and Replace
8936 For example: >
8937 :set ww=<,>,[,]
8938< allows wrap only when cursor keys are used.
8939 When the movement keys are used in combination with a delete or change
8940 operator, the <EOL> also counts for a character. This makes "3h"
8941 different from "3dh" when the cursor crosses the end of a line. This
8942 is also true for "x" and "X", because they do the same as "dl" and
8943 "dh". If you use this, you may also want to use the mapping
8944 ":map <BS> X" to make backspace delete the character in front of the
8945 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008946 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008947 line (not an empty line) then it will not move to the next line. This
8948 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 NOTE: This option is set to the Vi default value when 'compatible' is
8950 set and to the Vim default value when 'compatible' is reset.
8951
8952 *'wildchar'* *'wc'*
8953'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8954 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955 Character you have to type to start wildcard expansion in the
8956 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008957 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 The character is not recognized when used inside a macro. See
8959 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008960 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008962 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008963< NOTE: This option is set to the Vi default value when 'compatible' is
8964 set and to the Vim default value when 'compatible' is reset.
8965
8966 *'wildcharm'* *'wcm'*
8967'wildcharm' 'wcm' number (default: none (0))
8968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008970 recognized when used inside a macro. You can find "spare" command-line
8971 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 you'll never actually type 'wildcharm', just use it in mappings that
8973 automatically invoke completion mode, e.g.: >
8974 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008975 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976< Then after typing :ss you can use CTRL-P & CTRL-N.
8977
8978 *'wildignore'* *'wig'*
8979'wildignore' 'wig' string (default "")
8980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 {not available when compiled without the |+wildignore|
8982 feature}
8983 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008984 patterns is ignored when expanding |wildcards|, completing file or
8985 directory names, and influences the result of |expand()|, |glob()| and
8986 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008987 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8988 Also see 'suffixes'.
8989 Example: >
8990 :set wildignore=*.o,*.obj
8991< The use of |:set+=| and |:set-=| is preferred when adding or removing
8992 a pattern from the list. This avoids problems when a future version
8993 uses another default.
8994
Bram Moolenaar94950a92010-12-02 16:01:29 +01008995
Bram Moolenaar81af9252010-12-10 20:35:50 +01008996 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008997'wildignorecase' 'wic' boolean (default off)
8998 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008999 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009000 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009001 Does not apply when the shell is used to expand wildcards, which
9002 happens when there are special characters.
9003
9004
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009006'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008 {not available if compiled without the |+wildmenu|
9009 feature}
9010 When 'wildmenu' is on, command-line completion operates in an enhanced
9011 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9012 the possible matches are shown just above the command line, with the
9013 first match highlighted (overwriting the status line, if there is
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009014 one). This is the behavior without "pum" in 'wildoptions.
9015 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9017 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9018 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009019 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009020 If there are more matches than can fit in the line, a ">" is shown on
9021 the right and/or a "<" is shown on the left. The status line scrolls
9022 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009023 When 'wildoptions' contains "pum", then the completion matches are
9024 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009025 The "wildmenu" mode is abandoned when a key is hit that is not used
9026 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009027 While the "wildmenu" is active, not using the popup menu, the
9028 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029
9030 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9031 <Down> - in filename/menu name completion: move into a
9032 subdirectory or submenu.
9033 <CR> - in menu completion, when the cursor is just after a
9034 dot: move into a submenu.
9035 <Up> - in filename/menu name completion: move up into
9036 parent directory or parent menu.
9037
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009038 When using the popup menu for command line completion, the following
9039 keys have special meanings:
9040 <Down> - select next match (like CTRL-N)
9041 <Left> - in filename/menu name completion: move up into
9042 parent directory or parent menu.
9043 <Right> - in filename/menu name completion: move into a
9044 subdirectory or submenu.
9045 <Up> - select previous match (like CTRL-P)
9046 CTRL-E - end completion, go back to what was there before
9047 selecting a match.
9048 CTRL-N - go to the next entry
9049 CTRL-P - go to the previous entry
9050 CTRL-Y - accept the currently selected match and stop
9051 completion.
9052
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 This makes the menus accessible from the console |console-menus|.
9054
9055 If you prefer the <Left> and <Right> keys to move the cursor instead
9056 of selecting a different match, use this: >
9057 :cnoremap <Left> <Space><BS><Left>
9058 :cnoremap <Right> <Space><BS><Right>
9059<
9060 The "WildMenu" highlighting is used for displaying the current match
9061 |hl-WildMenu|.
9062
9063 *'wildmode'* *'wim'*
9064'wildmode' 'wim' string (Vim default: "full")
9065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009066 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009067 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009068 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069 first part specifies the behavior for the first use of 'wildchar',
9070 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009071
9072 Each part consists of a colon separated list consisting of the
9073 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074 "" Complete only the first match.
9075 "full" Complete the next full match. After the last match,
9076 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009077 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009078 "longest" Complete till longest common string. If this doesn't
9079 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009081 "lastused" When completing buffer names and more than one buffer
9082 matches, sort buffers by time last used (other than
9083 the current buffer).
9084 When there is only a single match, it is fully completed in all cases.
9085
9086 Examples of useful colon-separated values:
9087 "longest:full" Like "longest", but also start 'wildmenu' if it is
9088 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089 "list:full" When more than one match, list all matches and
9090 complete first match.
9091 "list:longest" When more than one match, list all matches and
9092 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009093 "list:lastused" When more than one buffer matches, list all matches
9094 and sort buffers by time last used (other than the
9095 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009096
9097 Examples: >
9098 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009099< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009100 :set wildmode=longest,full
9101< Complete longest common string, then each full match >
9102 :set wildmode=list:full
9103< List all matches and complete each full match >
9104 :set wildmode=list,full
9105< List all matches without completing, then each full match >
9106 :set wildmode=longest,list
9107< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009108 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009109
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009110 *'wildoptions'* *'wop'*
9111'wildoptions' 'wop' string (default "")
9112 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009113 {not available when compiled without the |+wildignore|
9114 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009115 A list of words that change how |cmdline-completion| is done.
9116 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009117 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009118 this value is specified, wildcard expansion will not
9119 be used for completion. The matches will be sorted by
9120 the "best match" rather than alphabetically sorted.
9121 This will find more matches than the wildcard
9122 expansion. Currently fuzzy matching based completion
9123 is not supported for file and directory names and
9124 instead wildcard expansion is used.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009125 pum Display the completion matches using the popupmenu
9126 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009127 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009128 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009129 is displayed per line. Often used tag kinds are:
9130 d #define
9131 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009132
Bram Moolenaar071d4272004-06-13 20:20:40 +00009133 *'winaltkeys'* *'wak'*
9134'winaltkeys' 'wak' string (default "menu")
9135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009136 {only used in Win32, Motif, GTK and Photon GUI}
9137 Some GUI versions allow the access to menu entries by using the ALT
9138 key in combination with a character that appears underlined in the
9139 menu. This conflicts with the use of the ALT key for mappings and
9140 entering special characters. This option tells what to do:
9141 no Don't use ALT keys for menus. ALT key combinations can be
9142 mapped, but there is no automatic handling. This can then be
9143 done with the |:simalt| command.
9144 yes ALT key handling is done by the windowing system. ALT key
9145 combinations cannot be mapped.
9146 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009147 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148 keys can be mapped.
9149 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9150 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009151 This option is not used for <F10>; on Win32 and with GTK <F10> will
9152 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009153
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009154 *'wincolor'* *'wcr'*
9155'wincolor' 'wcr' string (default empty)
9156 local to window
9157 Highlight group name to use for this window instead of the Normal
9158 color |hl-Normal|.
9159
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009160 *'window'* *'wi'*
9161'window' 'wi' number (default screen height - 1)
9162 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009163 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9164 window and the value is smaller than 'lines' minus one. The screen
9165 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009166 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9167 in a much smarter way, taking care of wrapping lines.
9168 When resizing the Vim window, the value is smaller than 1 or more than
9169 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009170 Note: Do not confuse this with the height of the Vim window, use
9171 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009172
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 *'winheight'* *'wh'* *E591*
9174'winheight' 'wh' number (default 1)
9175 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009176 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009177 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009178 focus goes to a window that is smaller, its size is increased, at the
9179 cost of the height of other windows.
9180 Set 'winheight' to a small number for normal editing.
9181 Set it to 999 to make the current window fill most of the screen.
9182 Other windows will be only 'winminheight' high. This has the drawback
9183 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9184 to create only two windows, set the option after startup is done,
9185 using the |VimEnter| event: >
9186 au VimEnter * set winheight=999
9187< Minimum value is 1.
9188 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009189 height of the current window.
9190 'winheight' applies to the current window. Use 'winminheight' to set
9191 the minimal height for other windows.
9192
9193 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9194'winfixheight' 'wfh' boolean (default off)
9195 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009197 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9198 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009199 The height may be changed anyway when running out of room.
9200
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009201 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9202'winfixwidth' 'wfw' boolean (default off)
9203 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009204 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009205 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009206 The width may be changed anyway when running out of room.
9207
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208 *'winminheight'* *'wmh'*
9209'winminheight' 'wmh' number (default 1)
9210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009211 The minimal height of a window, when it's not the current window.
9212 This is a hard minimum, windows will never become smaller.
9213 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9214 status bar) if necessary. They will return to at least one line when
9215 they become active (since the cursor has to have somewhere to go.)
9216 Use 'winheight' to set the minimal height of the current window.
9217 This option is only checked when making a window smaller. Don't use a
9218 large number, it will cause errors when opening more than a few
9219 windows. A value of 0 to 3 is reasonable.
9220
9221 *'winminwidth'* *'wmw'*
9222'winminwidth' 'wmw' number (default 1)
9223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 The minimal width of a window, when it's not the current window.
9225 This is a hard minimum, windows will never become smaller.
9226 When set to zero, windows may be "squashed" to zero columns (i.e. just
9227 a vertical separator) if necessary. They will return to at least one
9228 line when they become active (since the cursor has to have somewhere
9229 to go.)
9230 Use 'winwidth' to set the minimal width of the current window.
9231 This option is only checked when making a window smaller. Don't use a
9232 large number, it will cause errors when opening more than a few
9233 windows. A value of 0 to 12 is reasonable.
9234
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009235 *'winptydll'*
9236'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9237 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009238 {only available when compiled with the |terminal|
9239 feature on MS-Windows}
9240 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009241 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009242 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009243 a fallback.
9244 Environment variables are expanded |:set_env|.
9245 This option cannot be set from a |modeline| or in the |sandbox|, for
9246 security reasons.
9247
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 *'winwidth'* *'wiw'* *E592*
9249'winwidth' 'wiw' number (default 20)
9250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009251 Minimal number of columns for the current window. This is not a hard
9252 minimum, Vim will use fewer columns if there is not enough room. If
9253 the current window is smaller, its size is increased, at the cost of
9254 the width of other windows. Set it to 999 to make the current window
9255 always fill the screen. Set it to a small number for normal editing.
9256 The width is not adjusted after one of the commands to change the
9257 width of the current window.
9258 'winwidth' applies to the current window. Use 'winminwidth' to set
9259 the minimal width for other windows.
9260
9261 *'wrap'* *'nowrap'*
9262'wrap' boolean (default on)
9263 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009264 This option changes how text is displayed. It doesn't change the text
9265 in the buffer, see 'textwidth' for that.
9266 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009267 displaying continues on the next line. When off lines will not wrap
9268 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009269 moved to a part that is not shown, the screen will scroll
9270 horizontally.
9271 The line will be broken in the middle of a word if necessary. See
9272 'linebreak' to get the break at a word boundary.
9273 To make scrolling horizontally a bit more useful, try this: >
9274 :set sidescroll=5
9275 :set listchars+=precedes:<,extends:>
9276< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009277 This option can't be set from a |modeline| when the 'diff' option is
9278 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009279
9280 *'wrapmargin'* *'wm'*
9281'wrapmargin' 'wm' number (default 0)
9282 local to buffer
9283 Number of characters from the right window border where wrapping
9284 starts. When typing text beyond this limit, an <EOL> will be inserted
9285 and inserting continues on the next line.
9286 Options that add a margin, such as 'number' and 'foldcolumn', cause
9287 the text width to be further reduced. This is Vi compatible.
9288 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009289 This option is set to 0 when 'paste' is set and restored when 'paste'
9290 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009291 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009292
9293 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9294'wrapscan' 'ws' boolean (default on) *E384* *E385*
9295 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009296 Searches wrap around the end of the file. Also applies to |]s| and
9297 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009298
9299 *'write'* *'nowrite'*
9300'write' boolean (default on)
9301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009302 Allows writing files. When not set, writing a file is not allowed.
9303 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009304 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009305 argument. Filtering text is still possible, even though this requires
9306 writing a temporary file.
9307
9308 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9309'writeany' 'wa' boolean (default off)
9310 global
9311 Allows writing to any file with no need for "!" override.
9312
9313 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9314'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9315 otherwise)
9316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009317 Make a backup before overwriting a file. The backup is removed after
9318 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009319 also on.
9320 WARNING: Switching this option off means that when Vim fails to write
9321 your buffer correctly and then, for whatever reason, Vim exits, you
9322 lose both the original file and what you were writing. Only reset
9323 this option if your file system is almost full and it makes the write
9324 fail (and make sure not to exit Vim until the write was successful).
9325 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009327 Depending on 'backupcopy' the backup is a new file or the original
9328 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009329 NOTE: This option is set to the default value when 'compatible' is
9330 set.
9331
9332 *'writedelay'* *'wd'*
9333'writedelay' 'wd' number (default 0)
9334 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009335 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009336 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009337 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009338
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009339 *'xtermcodes'* *'noxtermcodes'*
9340'xtermcodes' boolean (default on)
9341 global
9342 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009343 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009344 key codes and number of colors from the terminal. This takes care of
9345 various configuration options of the terminal that cannot be obtained
9346 from the termlib/terminfo entry, see |xterm-codes|.
9347 A side effect may be that t_Co changes and Vim will redraw the
9348 display.
9349
9350
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009351 vim:tw=78:ts=8:noet:ft=help:norl: