blob: 2a2c7ed5c77568b671060ce63c21bb4f02093fcc [file] [log] [blame]
Bram Moolenaar71badf92023-04-22 22:40:14 +01001*options.txt* For Vim version 9.0. Last change: 2023 Apr 12
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...
Bram Moolenaarf1dcd142022-12-31 15:30:45 +000037 The options have the form t_AB, see
38 |terminal-options|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
Bram Moolenaar47003982021-12-05 21:54:04 +000040:se[t]! termcap Idem, but don't use multiple columns.
41
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 *E518* *E519*
43:se[t] {option}? Show value of {option}.
44
45:se[t] {option} Toggle option: set, switch it on.
46 Number option: show value.
47 String option: show value.
48
49:se[t] no{option} Toggle option: Reset, switch it off.
50
Bram Moolenaar00a927d2010-05-14 23:24:24 +020051 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000052:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000054
55 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
56:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020057 current value of 'compatible'.
58:se[t] {option}&vi Reset option to its Vi default value.
59:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010061:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020062 these options are not changed:
63 all terminal options, starting with t_
64 'columns'
65 'cryptmethod'
66 'encoding'
67 'key'
68 'lines'
69 'term'
70 'ttymouse'
71 'ttytype'
72 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
74 *:set-args* *E487* *E521*
75:se[t] {option}={value} or
76:se[t] {option}:{value}
77 Set string or number option to {value}.
78 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010079 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000080 The old value can be inserted by typing 'wildchar' (by
81 default this is a <Tab> or CTRL-E if 'compatible' is
82 set). See |cmdline-completion|.
83 White space between {option} and '=' is allowed and
84 will be ignored. White space between '=' and {value}
85 is not allowed.
86 See |option-backslash| for using white space and
87 backslashes in {value}.
88
89:se[t] {option}+={value} *:set+=*
90 Add the {value} to a number option, or append the
91 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010092 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000093 value was empty.
94 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000095 are removed. When adding a flag that was already
96 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000097 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000098
99:se[t] {option}^={value} *:set^=*
100 Multiply the {value} to a number option, or prepend
101 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100102 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103 value was empty.
104 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105
106:se[t] {option}-={value} *:set-=*
107 Subtract the {value} from a number option, or remove
108 the {value} from a string option, if it is there.
109 If the {value} is not found in a string option, there
110 is no error or warning. When the option is a comma
111 separated list, a comma is deleted, unless the option
112 becomes empty.
113 When the option is a list of flags, {value} must be
114 exactly as they appear in the option. Remove flags
115 one by one to avoid problems.
116 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117
118The {option} arguments to ":set" may be repeated. For example: >
119 :set ai nosi sw=3 ts=3
120If you make an error in one of the arguments, an error message will be given
121and the following arguments will be ignored.
122
123 *:set-verbose*
124When 'verbose' is non-zero, displaying an option value will also tell where it
125was last set. Example: >
126 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200127< shiftwidth=4 ~
128 Last set from modeline line 1 ~
129 cindent ~
130 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000131This is only done when specific option values are requested, not for ":verbose
132set all" or ":verbose set" without an argument.
133When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134When the option was set while executing a function, user command or
135autocommand, the script in which it was defined is reported.
136Note that an option may also have been set as a side effect of setting
137'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200139 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000140 Option was set in a |modeline|.
141 Last set from --cmd argument ~
142 Option was set with command line argument |--cmd| or +.
143 Last set from -c argument ~
144 Option was set with command line argument |-c|, +, |-S| or
145 |-q|.
146 Last set from environment variable ~
147 Option was set from an environment variable, $VIMINIT,
148 $GVIMINIT or $EXINIT.
149 Last set from error handler ~
150 Option was cleared when evaluating it resulted in an error.
151
Bram Moolenaardb84e452010-08-15 13:50:43 +0200152{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153
154 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000155For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156override the value from the termcap. You can then use it in a mapping. If
157the "xx" part contains special characters, use the <t_xx> form: >
158 :set <t_#4>=^[Ot
159This can also be used to translate a special code for a normal key. For
160example, if Alt-b produces <Esc>b, use this: >
161 :set <M-b>=^[b
162(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
163The advantage over a mapping is that it works in all situations.
164
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100165You can define any key codes, e.g.: >
166 :set t_xy=^[foo;
167There is no warning for using a name that isn't recognized. You can map these
168codes as you like: >
169 :map <t_xy> something
170< *E846*
171When a key code is not set, it's like it does not exist. Trying to get its
172value will result in an error: >
173 :set t_kb=
174 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000175< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100176
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000177The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
178security reasons.
179
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182"set all" probably does not fit on the screen, causing Vim to give the
183|more-prompt|.
184
185 *option-backslash*
186To include white space in a string option value it has to be preceded with a
187backslash. To include a backslash you have to use two. Effectively this
188means that the number of backslashes in an option value is halved (rounded
189down).
190A few examples: >
191 :set tags=tags\ /usr/tags results in "tags /usr/tags"
192 :set tags=tags\\,file results in "tags\,file"
193 :set tags=tags\\\ file results in "tags\ file"
194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000195The "|" character separates a ":set" command from a following command. To
196include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197'titlestring' option to "hi|there": >
198 :set titlestring=hi\|there
199This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
200 :set titlestring=hi|set iconstring=there
201
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200202Similarly, in legacy script the double quote character starts a comment. To
203include the '"' in the option value, use '\"' instead. This example sets the
204'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000205 :set titlestring=hi\ \"there\"
206
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200207In |Vim9| script it's simpler, comments start with a '#' character, and only
208when preceded by white space. A backslash is needed less often: >
209 vim9script
210 set titlestring=hi\ "there"
211 set titlestring=hi#there#
212 set titlestring=hi\ \#there#
213
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100214For Win32 backslashes in file names are mostly not removed. More precise: For
215options that expect a file name (those where environment variables are
216expanded) a backslash before a normal file name character is not removed. But
217a backslash before a special character (space, backslash, comma, etc.) is used
218like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219There is one special situation, when the value starts with "\\": >
220 :set dir=\\machine\path results in "\\machine\path"
221 :set dir=\\\\machine\\path results in "\\machine\path"
222 :set dir=\\path\\file results in "\\path\file" (wrong!)
223For the first one the start is kept, but for the second one the backslashes
224are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226result which is probably not what you want. Avoid it.
227
228 *add-option-flags* *remove-option-flags*
229 *E539* *E550* *E551* *E552*
230Some options are a list of flags. When you want to add a flag to such an
231option, without changing the existing ones, you can do it like this: >
232 :set guioptions+=a
233Remove a flag from an option like this: >
234 :set guioptions-=a
235This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000236Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
238doesn't appear.
239
240 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000241Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242environment variable exists the '$' and the following environment variable
243name is replaced with its value. If it does not exist the '$' and the name
244are not modified. Any non-id character (not a letter, digit or '_') may
245follow the environment variable name. That character and what follows is
246appended to the value of the environment variable. Examples: >
247 :set term=$TERM.new
248 :set path=/usr/$INCLUDE,$HOME/include,.
249When adding or removing a string from an option with ":set opt-=val" or ":set
250opt+=val" the expansion is done before the adding or removing.
251
252
253Handling of local options *local-options*
254
255Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100256has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257allows you to set 'list' in one window but not in another. And set
258'shiftwidth' to 3 in one buffer and 4 in another.
259
260The following explains what happens to these local options in specific
261situations. You don't really need to know all of this, since Vim mostly uses
262the option values you would expect. Unfortunately, doing what the user
263expects is a bit complicated...
264
265When splitting a window, the local options are copied to the new window. Thus
266right after the split the contents of the two windows look the same.
267
268When editing a new buffer, its local option values must be initialized. Since
269the local options of the current buffer might be specifically for that buffer,
270these are not used. Instead, for each buffer-local option there also is a
271global value, which is used for new buffers. With ":set" both the local and
272global value is changed. With "setlocal" only the local value is changed,
273thus this value is not used when editing a new buffer.
274
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200275When editing a buffer that has been edited before, the options from the window
276that was last closed are used again. If this buffer has been edited in this
277window, the values from back then are used. Otherwise the values from the
278last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279
280It's possible to set a local window option specifically for a type of buffer.
281When you edit another buffer in the same window, you don't want to keep
282using these local window options. Therefore Vim keeps a global value of the
283local window options, which is used when editing another buffer. Each window
284has its own copy of these values. Thus these are local to the window, but
285global to all buffers in the window. With this you can do: >
286 :e one
287 :set list
288 :e two
289Now the 'list' option will also be set in "two", since with the ":set list"
290command you have also set the global value. >
291 :set nolist
292 :e one
293 :setlocal list
294 :e two
295Now the 'list' option is not set, because ":set nolist" resets the global
296value, ":setlocal list" only changes the local value and ":e two" gets the
297global value. Note that if you do this next: >
298 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200299You will get back the 'list' value as it was the last time you edited "one".
300The options local to a window are remembered for each buffer. This also
301happens when the buffer is not loaded, but they are lost when the buffer is
302wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303
304 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100305:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 current buffer or window. Not all options have a
307 local value. If the option does not have a local
308 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200309 With the "all" argument: display local values for all
310 local options.
311 Without argument: Display local values for all local
312 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000314 local value. For a global/local boolean option, when
315 the global value is being used, "--" is displayed
316 before the option name.
317 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320:setl[ocal] {option}< Set the local value of {option} to its global value by
321 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000322
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100323:se[t] {option}< For |global-local| options: Remove the local value of
324 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000325
326 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100327:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328 option without changing the local value.
329 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200330 With the "all" argument: display global values for all
331 local options.
332 Without argument: display global values for all local
333 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334
335For buffer-local and window-local options:
336 Command global value local value ~
337 :set option=value set set
338 :setlocal option=value - set
339:setglobal option=value set -
340 :set option? - display
341 :setlocal option? - display
342:setglobal option? display -
343
344
345Global options with a local value *global-local*
346
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000347Options are global when you mostly use one value for all buffers and windows.
348For some global options it's useful to sometimes have a different local value.
349You can set the local value with ":setlocal". That buffer or window will then
350use the local value, while other buffers and windows continue using the global
351value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352
353For example, you have two windows, both on C source code. They use the global
354'makeprg' option. If you do this in one of the two windows: >
355 :set makeprg=gmake
356then the other window will switch to the same value. There is no need to set
357the 'makeprg' option in the other C source window too.
358However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000359another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000360files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361 :setlocal makeprg=perlmake
362You can switch back to using the global value by making the local value empty: >
363 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100364This only works for a string option. For a number or boolean option you need
365to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100367Note that for non-boolean and non-number options using "<" copies the global
368value to the local value, it doesn't switch back to using the global value
369(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000370 :set path<
371This will make the local value of 'path' empty, so that the global value is
372used. Thus it does the same as: >
373 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000374Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375":setlocal" on a global option might work differently then.
376
377
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000378 *option-value-function*
379Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000380'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000381a function name or a function reference or a lambda function. When using a
382lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000383>
384 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000385 set opfunc=function('MyOpFunc')
386 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000387 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000388
389Set to a script-local function: >
390 set opfunc=s:MyLocalFunc
391 set opfunc=<SID>MyLocalFunc
392In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
393the script: >
394 set opfunc=MyLocalFunc
395
396Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000397 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000398 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000399
400Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000401 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000402
403Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000404 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000405 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000406
407In Vim9 script, in a compiled function, you can use a lambda, but a
408closured does not work, because the function will be called without the
409context of where it was defined.
410
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000411
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412Setting the filetype
413
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200414:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415 Set the 'filetype' option to {filetype}, but only if
416 not done yet in a sequence of (nested) autocommands.
417 This is short for: >
418 :if !did_filetype()
419 : setlocal filetype={filetype}
420 :endif
421< This command is used in a filetype.vim file to avoid
422 setting the 'filetype' option twice, causing different
423 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200424
425 When the optional FALLBACK argument is present, a
426 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100427 'filetype'. This is to be used for filetype
428 detections that are just a guess. |did_filetype()|
429 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200430
Bram Moolenaard58e9292011-02-09 17:07:58 +0100431 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
433:opt[ions] Open a window for viewing and setting all options.
434 Options are grouped by function.
435 Offers short help for each option. Hit <CR> on the
436 short help to open a help window with more help for
437 the option.
438 Modify the value of the option and hit <CR> on the
439 "set" line to set the new value. For window and
440 buffer specific options, the last accessed window is
441 used to set the option value in, unless this is a help
442 window, in which case the window below help window is
443 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100444 {not available when compiled without the |+eval|
445 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446
447 *$HOME*
448Using "~" is like using "$HOME", but it is only recognized at the start of an
449option and after a space or comma.
450
451On Unix systems "~user" can be used too. It is replaced by the home directory
452of user "user". Example: >
453 :set path=~mool/include,/usr/include,.
454
455On Unix systems the form "${HOME}" can be used too. The name between {} can
456contain non-id characters then. Note that if you want to use this for the
457"gf" command, you need to add the '{' and '}' characters to 'isfname'.
458
459NOTE: expanding environment variables and "~/" is only done with the ":set"
460command, not when assigning a value to an option with ":let".
461
Bram Moolenaarc572da52017-08-27 16:52:01 +0200462 *$HOME-windows*
463On MS-Windows, if $HOME is not defined as an environment variable, then
464at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200465If $HOMEDRIVE is not set then $USERPROFILE is used.
466
467This expanded value is not exported to the environment, this matters when
468running an external command: >
469 :echo system('set | findstr ^HOME=')
470and >
471 :echo luaeval('os.getenv("HOME")')
472should echo nothing (an empty string) despite exists('$HOME') being true.
473When setting $HOME to a non-empty string it will be exported to the
474subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476
477Note the maximum length of an expanded option is limited. How much depends on
478the system, mostly it is something like 256 or 1024 characters.
479
480 *:fix* *:fixdel*
481:fix[del] Set the value of 't_kD':
482 't_kb' is 't_kD' becomes ~
483 CTRL-? CTRL-H
484 not CTRL-? CTRL-?
485
Bram Moolenaar82be4842021-01-11 19:40:15 +0100486 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000487
488 If your delete key terminal code is wrong, but the
489 code for backspace is alright, you can put this in
490 your .vimrc: >
491 :fixdel
492< This works no matter what the actual code for
493 backspace is.
494
495 If the backspace key terminal code is wrong you can
496 use this: >
497 :if &term == "termname"
498 : set t_kb=^V<BS>
499 : fixdel
500 :endif
501< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000502 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503 with your terminal name.
504
505 If your <Delete> key sends a strange key sequence (not
506 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
507 :if &term == "termname"
508 : set t_kD=^V<Delete>
509 :endif
510< Where "^V" is CTRL-V and "<Delete>" is the delete key
511 (don't type eight characters!). Replace "termname"
512 with your terminal name.
513
514 *Linux-backspace*
515 Note about Linux: By default the backspace key
516 produces CTRL-?, which is wrong. You can fix it by
517 putting this line in your rc.local: >
518 echo "keycode 14 = BackSpace" | loadkeys
519<
520 *NetBSD-backspace*
521 Note about NetBSD: If your backspace doesn't produce
522 the right code, try this: >
523 xmodmap -e "keycode 22 = BackSpace"
524< If this works, add this in your .Xmodmap file: >
525 keysym 22 = BackSpace
526< You need to restart for this to take effect.
527
528==============================================================================
5292. Automatically setting options *auto-setting*
530
531Besides changing options with the ":set" command, there are three alternatives
532to set options automatically for one or more files:
533
5341. When starting Vim initializations are read from various places. See
535 |initialization|. Most of them are performed for all editing sessions,
536 and some of them depend on the directory where Vim is started.
537 You can create an initialization file with |:mkvimrc|, |:mkview| and
538 |:mksession|.
5392. If you start editing a new file, the automatic commands are executed.
540 This can be used to set options for files matching a particular pattern and
541 many other things. See |autocommand|.
5423. If you start editing a new file, and the 'modeline' option is on, a
543 number of lines at the beginning and end of the file are checked for
544 modelines. This is explained here.
545
546 *modeline* *vim:* *vi:* *ex:* *E520*
547There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100548 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100550[text{white}] empty or any text followed by at least one blank
551 character (<Space> or <Tab>); "ex:" always requires at
552 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200553{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200554[white] optional white space
555{options} a list of option settings, separated with white space
556 or ':', where each part between ':' is the argument
557 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558
Bram Moolenaar14b69452013-06-29 23:05:20 +0200559Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000560 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200561 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562
563The second form (this is compatible with some versions of Vi):
564
Bram Moolenaarade0d392020-01-21 22:33:58 +0100565 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566
Bram Moolenaarade0d392020-01-21 22:33:58 +0100567[text{white}] empty or any text followed by at least one blank
568 character (<Space> or <Tab>); "ex:" always requires at
569 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200570{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
571[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200572se[t] the string "set " or "se " (note the space); When
573 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200574{options} a list of options, separated with white space, which
575 is the argument for a ":set" command
576: a colon
577[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578
Bram Moolenaar14b69452013-06-29 23:05:20 +0200579Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000580 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200581 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200583The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
584chance that a normal word like "lex:" is caught. There is one exception:
585"vi:" and "vim:" can also be at the start of the line (for compatibility with
586version 3.0). Using "ex:" at the start of the line will be ignored (this
587could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588
Hu Jialun9dcd3492021-08-28 20:42:50 +0200589If the modeline is disabled within a modeline, subsequent modelines will be
590ignored. This is to allow turning off modeline on a per-file basis. This is
591useful when a line looks like a modeline but isn't. For example, it would be
592good to start a YAML file containing strings like "vim:" with
593 # vim: nomodeline ~
594so as to avoid modeline misdetection. Following options on the same line
595after modeline deactivation, if any, are still evaluated (but you would
596normally not have any).
597
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598 *modeline-local*
599The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000600buffer and window that contain the file. Although it's possible to set global
601options from a modeline, this is unusual. If you have two windows open and
602the files in it set the same global option to a different value, the result
603depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000605When editing a file that was already loaded, only the window-local options
606from the modeline are used. Thus if you manually changed a buffer-local
607option after opening the file, it won't be changed if you edit the same buffer
608in another window. But window-local options will be set.
609
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610 *modeline-version*
611If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200612number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613 vim{vers}: version {vers} or later
614 vim<{vers}: version before {vers}
615 vim={vers}: version {vers}
616 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100617{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
618For example, to use a modeline only for Vim 7.0:
619 /* vim700: set foldmethod=marker */ ~
620To use a modeline for Vim after version 7.2:
621 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622There can be no blanks between "vim" and the ":".
623
624
625The number of lines that are checked can be set with the 'modelines' option.
626If 'modeline' is off or 'modelines' is 0 no lines are checked.
627
628Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000629like:
630 /* vi:ts=4: */ ~
631will give an error message for the trailing "*/". This line is OK:
632 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633
634If an error is detected the rest of the line is skipped.
635
636If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000637backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100638 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
639This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
640before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200641 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000643might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200644can be set. For some options a flag is set, so that when the value is used
645the |sandbox| is effective. Some options can only be set from the modeline
646when 'modelineexpr' is set (the default is off).
647
648Still, there is always a small risk that a modeline causes trouble. E.g.,
649when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
650So disable modelines before editing untrusted text. The mail ftplugin does
651this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653Hint: If you would like to do something else than setting an option, you could
654define an autocommand that checks the file for a specific string. For
655example: >
656 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
657And define a function SetVar() that does something with the line containing
658"VAR".
659
660==============================================================================
6613. Options summary *option-summary*
662
663In the list below all the options are mentioned with their full name and with
664an abbreviation if there is one. Both forms may be used.
665
666In this document when a boolean option is "set" that means that ":set option"
667is entered. When an option is "reset", ":set nooption" is used.
668
669For some options there are two default values: The "Vim default", which is
670used when 'compatible' is not set, and the "Vi default", which is used when
671'compatible' is set.
672
673Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000674are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675different value in each window. For example the 'list' option can be set in
676one window and reset in another for the same text, giving both types of view
677at the same time. There are a few options that are specific to a certain
678file. These can have a different value for each file or buffer. For example
679the 'textwidth' option can be 78 for a normal text file and 0 for a C
680program.
681
682 global one option for all buffers and windows
683 local to window each window has its own copy of this option
684 local to buffer each buffer has its own copy of this option
685
686When creating a new window the option values from the currently active window
687are used as a default value for the window-specific options. For the
688buffer-specific options this depends on the 's' and 'S' flags in the
689'cpoptions' option. If 's' is included (which is the default) the values for
690buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000691first entered. If 'S' is present the options are copied each time the buffer
692is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693present, the options are copied from the currently active buffer when the
694buffer is created.
695
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000696Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000698Not all options are supported in all versions. This depends on the supported
699features and sometimes on the system. A remark about this is in curly braces
700below. When an option is not supported it may still be set without getting an
701error, this is called a hidden option. You can't get the value of a hidden
702option though, it is not stored.
703
704To test if option "foo" can be used with ":set" use something like this: >
705 if exists('&foo')
706This also returns true for a hidden option. To test if option "foo" is really
707supported use something like this: >
708 if exists('+foo')
709<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710 *E355*
711A jump table for the options with a short description can be found at |Q_op|.
712
713 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100714'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 {only available when compiled with the |+rightleft|
717 feature}
718 The ASCII code for the first letter of the Hebrew alphabet. The
719 routine that maps the keyboard in Hebrew mode, both in Insert mode
720 (when hkmap is set) and on the command-line (when hitting CTRL-_)
721 outputs the Hebrew characters in the range [aleph..aleph+26].
722 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
723 See |rileft.txt|.
724
725 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
726'allowrevins' 'ari' boolean (default off)
727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 {only available when compiled with the |+rightleft|
729 feature}
730 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
731 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
732 into reverse Insert mode, and don't know how to get out. See
733 'revins'.
734 NOTE: This option is reset when 'compatible' is set.
735
736 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
737'altkeymap' 'akm' boolean (default off)
738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 {only available when compiled with the |+farsi|
740 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100741 This option was for using Farsi, which has been removed. See
742 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743
744 *'ambiwidth'* *'ambw'*
745'ambiwidth' 'ambw' string (default: "single")
746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
748 Tells Vim what to do with characters with East Asian Width Class
749 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
750 letters, Cyrillic letters).
751
752 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000753 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 expected by most users.
755 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200756 *E834* *E835*
757 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100758 contains a character that would be double width. These errors may
759 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200760
761 The values are overruled for characters specified with
762 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763
764 There are a number of CJK fonts for which the width of glyphs for
765 those characters are solely based on how many octets they take in
766 legacy/traditional CJK encodings. In those encodings, Euro,
767 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000768 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000770 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 Vim is running inside a terminal (emulators) that uses a CJK font
772 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
773 this option should be set to "double" to match the width perceived
774 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100775 to be set to "double" under CJK MS-Windows when the system locale is
776 set to one of CJK locales. See Unicode Standard Annex #11
777 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100779 Vim may set this option automatically at startup time when Vim is
780 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200781 escape sequence to request cursor position report. The response can
782 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100783
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
785'antialias' 'anti' boolean (default: off)
786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200788 on macOS}
789 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
791 which can be easier to read at certain sizes on certain displays.
792 Setting this option can sometimes cause problems if 'guifont' is set
793 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100794 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795
796 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
797'autochdir' 'acd' boolean (default off)
798 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200799 {only available when compiled with it, use
800 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000801 When on, Vim will change the current working directory whenever you
802 open a file, switch buffers, delete a buffer or open/close a window.
803 It will change to the directory containing the file which was opened
Bram Moolenaare8008642022-08-19 17:15:35 +0100804 or selected. When a buffer has no name it also has no directory, thus
805 the current directory won't change when navigating to it.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000806 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200808 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
809'autoshelldir' 'asd' boolean (default off)
810 global
811 When on, Vim will change the current working directory whenever you
812 change the directory of the shell running in a terminal window. You
813 need proper setting-up, so whenever the shell's pwd changes an OSC 7
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100814 escape sequence will be emitted. For example, on Linux, you can
815 source /etc/profile.d/vte.sh in your shell profile if you use bash or
816 zsh. For bash this should work (put it in a bash init file): >
817 if [[ -n "$VIM_TERMINAL" ]]; then
818 PROMPT_COMMAND='_vim_sync_PWD'
819 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100820 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100821 }
822 fi
823<
824 Or, in a zsh init file: >
825 if [[ -n "$VIM_TERMINAL" ]]; then
826 autoload -Uz add-zsh-hook
827 add-zsh-hook -Uz chpwd _vim_sync_PWD
828 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100829 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100830 }
831 fi
832<
833 In a fish init file: >
834 if test -n "$VIM_TERMINAL"
835 function _vim_sync_PWD --on-variable=PWD
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100836 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100837 end
838 end
839<
840 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000841 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200842
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
844'arabic' 'arab' boolean (default off)
845 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 {only available when compiled with the |+arabic|
847 feature}
848 This option can be set to start editing Arabic text.
849 Setting this option will:
850 - Set the 'rightleft' option, unless 'termbidi' is set.
851 - Set the 'arabicshape' option, unless 'termbidi' is set.
852 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
853 between typing English and Arabic key mapping.
854 - Set the 'delcombine' option
855 Note that 'encoding' must be "utf-8" for working with Arabic text.
856
857 Resetting this option will:
858 - Reset the 'rightleft' option.
859 - Disable the use of 'keymap' (without changing its value).
860 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200861 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100862 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 Also see |arabic.txt|.
864
865 *'arabicshape'* *'arshape'*
866 *'noarabicshape'* *'noarshape'*
867'arabicshape' 'arshape' boolean (default on)
868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 {only available when compiled with the |+arabic|
870 feature}
871 When on and 'termbidi' is off, the required visual character
872 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200873 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 one which encompasses:
875 a) the changing/morphing of characters based on their location
876 within a word (initial, medial, final and stand-alone).
877 b) the enabling of the ability to compose characters
878 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100879 When disabled the display shows each character's true stand-alone
880 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881 Arabic is a complex language which requires other settings, for
882 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100883 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884
885 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
886'autoindent' 'ai' boolean (default off)
887 local to buffer
888 Copy indent from current line when starting a new line (typing <CR>
889 in Insert mode or when using the "o" or "O" command). If you do not
890 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000891 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
892 to another line has the same effect, unless the 'I' flag is included
893 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000894 When autoindent is on, formatting (with the "gq" command or when you
895 reach 'textwidth' in Insert mode) uses the indentation of the first
896 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 When 'smartindent' or 'cindent' is on the indent is changed in
898 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200899 The 'autoindent' option is reset when the 'paste' option is set and
900 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
902 *'autoread'* *'ar'* *'noautoread'* *'noar'*
903'autoread' 'ar' boolean (default off)
904 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905 When a file has been detected to have been changed outside of Vim and
906 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200907 When the file has been deleted this is not done, so you have the text
908 from before it was deleted. When it appears again then it is read.
909 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 If this option has a local value, use this command to switch back to
911 using the global value: >
912 :set autoread<
913<
914 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
915'autowrite' 'aw' boolean (default off)
916 global
917 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000918 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000919 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
920 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000921 to another file.
922 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000923 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 Note that for some commands the 'autowrite' option is not used, see
925 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200926 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200927 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928
929 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
930'autowriteall' 'awa' boolean (default off)
931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
933 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
934 Setting this option also implies that Vim behaves like 'autowrite' has
935 been set.
936
937 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200938'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 When set to "dark", Vim will try to use colors that look good on a
941 dark background. When set to "light", Vim will try to use colors that
942 look good on a light background. Any other value is illegal.
943 Vim tries to set the default value according to the terminal used.
944 This will not always be correct.
945 Setting this option does not change the background color, it tells Vim
946 what the background color looks like. For changing the background
947 color, see |:hi-normal|.
948
949 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000950 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000951 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100952 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000953 setting 'background' will cause the color scheme to be reloaded. If
954 the color scheme adjusts to the value of 'background' this will work.
955 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100956 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957
958 When setting 'background' to the default value with: >
959 :set background&
960< Vim will guess the value. In the GUI this should work correctly,
961 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200962 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200963 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200965 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200966 color from the terminal. If the returned RGB value is dark/light and
967 'background' is not dark/light, 'background' will be set and the
968 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200969 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100970 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200971
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972 When starting the GUI, the default value for 'background' will be
973 "light". When the value is not set in the .gvimrc, and Vim detects
974 that the background is actually quite dark, 'background' is set to
975 "dark". But this happens only AFTER the .gvimrc file has been read
976 (because the window needs to be opened to find the actual background
977 color). To get around this, force the GUI window to be opened by
978 putting a ":gui" command in the .gvimrc file, before where the value
979 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200980
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100981 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200982 For other systems "dark" is used when 'term' is "linux",
983 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
984 background. Otherwise the default is "light".
985
Bram Moolenaarc572da52017-08-27 16:52:01 +0200986 The |:terminal| command and the |term_start()| function use the
987 'background' value to decide whether the terminal window will start
988 with a white or black background.
989
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 Normally this option would be set in the .vimrc file. Possibly
991 depending on the terminal name. Example: >
992 :if &term == "pcterm"
993 : set background=dark
994 :endif
995< When this option is set, the default settings for the highlight groups
996 will change. To use other settings, place ":highlight" commands AFTER
997 the setting of the 'background' option.
998 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
999 to select the colors for syntax highlighting. After changing this
1000 option, you must load syntax.vim again to see the result. This can be
1001 done with ":syntax on".
1002
1003 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001004'backspace' 'bs' string (default "", set to "indent,eol,start"
1005 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1008 mode. This is a list of items, separated by commas. Each item allows
1009 a way to backspace over something:
1010 value effect ~
1011 indent allow backspacing over autoindent
1012 eol allow backspacing over line breaks (join lines)
1013 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1014 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001015 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1016 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017
Bram Moolenaar46eea442022-03-30 10:51:39 +01001018 When the value is empty, Vi compatible backspacing is used, none of
1019 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020
1021 For backwards compatibility with version 5.4 and earlier:
1022 value effect ~
1023 0 same as ":set backspace=" (Vi compatible)
1024 1 same as ":set backspace=indent,eol"
1025 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001026 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027
1028 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1029 NOTE: This option is set to "" when 'compatible' is set.
1030
1031 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1032'backup' 'bk' boolean (default off)
1033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034 Make a backup before overwriting a file. Leave it around after the
1035 file has been successfully written. If you do not want to keep the
1036 backup file, but you do want a backup while the file is being
1037 written, reset this option and set the 'writebackup' option (this is
1038 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001039 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 |backup-table| for more explanations.
1041 When the 'backupskip' pattern matches, a backup is not made anyway.
1042 When 'patchmode' is set, the backup may be renamed to become the
1043 oldest version of a file.
1044 NOTE: This option is reset when 'compatible' is set.
1045
1046 *'backupcopy'* *'bkc'*
1047'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001048 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001050 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051
1052 The main values are:
1053 "yes" make a copy of the file and overwrite the original one
1054 "no" rename the file and write a new one
1055 "auto" one of the previous, what works best
1056
1057 Extra values that can be combined with the ones above are:
1058 "breaksymlink" always break symlinks when writing
1059 "breakhardlink" always break hardlinks when writing
1060
1061 Making a copy and overwriting the original file:
1062 - Takes extra time to copy the file.
1063 + When the file has special attributes, is a (hard/symbolic) link or
1064 has a resource fork, all this is preserved.
1065 - When the file is a link the backup will have the name of the link,
1066 not of the real file.
1067
1068 Renaming the file and writing a new one:
1069 + It's fast.
1070 - Sometimes not all attributes of the file can be copied to the new
1071 file.
1072 - When the file is a link the new file will not be a link.
1073
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001074 The "auto" value is the middle way: When Vim sees that renaming the
1075 file is possible without side effects (the attributes can be passed on
1076 and the file is not a link) that is used. When problems are expected,
1077 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078
1079 The "breaksymlink" and "breakhardlink" values can be used in
1080 combination with any of "yes", "no" and "auto". When included, they
1081 force Vim to always break either symbolic or hard links by doing
1082 exactly what the "no" option does, renaming the original file to
1083 become the backup and writing a new file in its place. This can be
1084 useful for example in source trees where all the files are symbolic or
1085 hard links and any changes should stay in the local source tree, not
1086 be propagated back to the original source.
1087 *crontab*
1088 One situation where "no" and "auto" will cause problems: A program
1089 that opens a file, invokes Vim to edit that file, and then tests if
1090 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001091 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 example.
1093
1094 When a copy is made, the original file is truncated and then filled
1095 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001096 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001097 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098 group of the backup is set to the group of the original file. If this
1099 fails, the protection bits for the group are made the same as for
1100 others.
1101
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001102 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103 the same attributes of the original file, and the newly written file
1104 is owned by the current user. When the file was a (hard/symbolic)
1105 link, the new file will not! That's why the "auto" value doesn't
1106 rename when the file is a link. The owner and group of the newly
1107 written file will be set to the same ones as the original file, but
1108 the system may refuse to do this. In that case the "auto" value will
1109 again not rename the file.
1110
Bram Moolenaar036986f2017-03-16 17:41:02 +01001111 NOTE: This option is set to the Vi default value when 'compatible' is
1112 set and to the Vim default value when 'compatible' is reset.
1113
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 *'backupdir'* *'bdir'*
1115'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001116 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 for Unix: ".,~/tmp,~/")
1118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119 List of directories for the backup file, separated with commas.
1120 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001121 where this is possible. The directory must exist, Vim will not
1122 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001123 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124 impossible!). Writing may fail because of this.
1125 - A directory "." means to put the backup file in the same directory
1126 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001127 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1128 the backup file relative to where the edited file is. The leading
1129 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130 ("." inside a directory name has no special meaning).
1131 - Spaces after the comma are ignored, other spaces are considered part
1132 of the directory name. To have a space at the start of a directory
1133 name, precede it with a backslash.
1134 - To include a comma in a directory name precede it with a backslash.
1135 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001136 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001137 the backup file name will be built from the complete path to the
1138 file with all path separators changed to percent '%' signs. This
1139 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001140 On Win32, it is also possible to end with "\\". However, When a
1141 separating comma is following, you must use "//", since "\\" will
1142 include the comma in the file name. Therefore it is recommended to
1143 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144 - Environment variables are expanded |:set_env|.
1145 - Careful with '\' characters, type one before a space, type two to
1146 get one in the option (see |option-backslash|), for example: >
1147 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1148< - For backwards compatibility with Vim version 3.0 a '>' at the start
1149 of the option is removed.
1150 See also 'backup' and 'writebackup' options.
1151 If you want to hide your backup files on Unix, consider this value: >
1152 :set backupdir=./.backup,~/.backup,.,/tmp
1153< You must create a ".backup" directory in each directory and in your
1154 home directory for this to work properly.
1155 The use of |:set+=| and |:set-=| is preferred when adding or removing
1156 directories from the list. This avoids problems when a future version
1157 uses another default.
1158 This option cannot be set from a |modeline| or in the |sandbox|, for
1159 security reasons.
1160
1161 *'backupext'* *'bex'* *E589*
1162'backupext' 'bex' string (default "~", for VMS: "_")
1163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 String which is appended to a file name to make the name of the
1165 backup file. The default is quite unusual, because this avoids
1166 accidentally overwriting existing files with a backup file. You might
1167 prefer using ".bak", but make sure that you don't have files with
1168 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001169 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001171 If you like to keep a lot of backups, you could use a BufWritePre
1172 autocommand to change 'backupext' just before writing the file to
1173 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001174 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001175< Use 'backupdir' to put the backup in a different directory.
1176
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001178'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1179 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1180 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 A list of file patterns. When one of the patterns matches with the
1183 name of the file which is written, no backup file is created. Both
1184 the specified file name and the full path name of the file are used.
1185 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1186 Watch out for special characters, see |option-backslash|.
1187 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001188 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001189
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001190 WARNING: Not having a backup file means that when Vim fails to write
1191 your buffer correctly and then, for whatever reason, Vim exits, you
1192 lose both the original file and what you were writing. Only disable
1193 backups if you don't care about losing the file.
1194
Bram Moolenaar02467872007-05-06 13:22:01 +00001195 Note that environment variables are not expanded. If you want to use
1196 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001197 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001198
1199< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001200 backup would be made by renaming the original file crontab won't see
1201 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202
1203 *'balloondelay'* *'bdlay'*
1204'balloondelay' 'bdlay' number (default: 600)
1205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 {only available when compiled with the |+balloon_eval|
1207 feature}
1208 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1209
1210 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1211'ballooneval' 'beval' boolean (default off)
1212 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001214 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001215 Switch on the |balloon-eval| functionality for the GUI.
1216
1217 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1218 *'nobevalterm'*
1219'balloonevalterm' 'bevalterm' boolean (default off)
1220 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001221 {only available when compiled with the
1222 |+balloon_eval_term| feature}
1223 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001225 *'balloonexpr'* *'bexpr'*
1226'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001227 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001228 {only available when compiled with the |+balloon_eval|
1229 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001230 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001231 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1232 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001233
1234 v:beval_bufnr number of the buffer in which balloon is going to show
1235 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001236 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001237 v:beval_lnum line number
1238 v:beval_col column number (byte index)
1239 v:beval_text word under or after the mouse pointer
1240
Bram Moolenaar54775062019-07-31 21:07:14 +02001241 Instead of showing a balloon, which is limited to plain text, consider
1242 using a popup window, see |popup_beval_example|. A popup window can
1243 use highlighting and show a border.
1244
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001245 The evaluation of the expression must not have side effects!
1246 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001247 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001248 return 'Cursor is at line ' .. v:beval_lnum ..
1249 \ ', column ' .. v:beval_col ..
1250 \ ' of file ' .. bufname(v:beval_bufnr) ..
1251 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001252 endfunction
1253 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001254 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001255<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001256 Also see |balloon_show()|, it can be used if the content of the balloon
1257 is to be fetched asynchronously. In that case evaluating
1258 'balloonexpr' should result in an empty string. If you get a balloon
1259 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001260
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001261 NOTE: The balloon is displayed only if the cursor is on a text
1262 character. If the result of evaluating 'balloonexpr' is not empty,
1263 Vim does not try to send a message to an external debugger (Netbeans
1264 or Sun Workshop).
1265
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001266 If the expression starts with s: or |<SID>|, then it is replaced with
1267 the script ID (|local-function|). Example: >
1268 set bexpr=s:MyBalloonExpr()
1269 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001270< Otherwise, the expression is evaluated in the context of the script
1271 where the option was set, thus script-local items are available.
1272
Bram Moolenaar30b65812012-07-12 22:01:11 +02001273 The expression will be evaluated in the |sandbox| when set from a
1274 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001275 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001276
1277 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001278 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001279
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001280 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001281 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001282< When they are supported "\n" characters will start a new line. If the
1283 expression evaluates to a |List| this is equal to using each List item
1284 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001285 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001286
Bram Moolenaar165bc692015-07-21 17:53:25 +02001287 *'belloff'* *'bo'*
1288'belloff' 'bo' string (default "")
1289 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001290 Specifies for which events the bell will not be rung. It is a comma
1291 separated list of items. For each item that is present, the bell
1292 will be silenced. This is most useful to specify specific events in
1293 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001294 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001295
1296 item meaning when present ~
1297 all All events.
1298 backspace When hitting <BS> or <Del> and deleting results in an
1299 error.
1300 cursor Fail to move around using the cursor keys or
1301 <PageUp>/<PageDown> in |Insert-mode|.
1302 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1303 |i_CTRL-X_CTRL-T|.
1304 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1305 |i_CTRL-E|.
1306 ctrlg Unknown Char after <C-G> in Insert mode.
1307 error Other Error occurred (e.g. try to join last line)
1308 (mostly used in |Normal-mode| or |Cmdline-mode|).
1309 esc hitting <Esc> in |Normal-mode|.
1310 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001311 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001312 insertmode Pressing <Esc> in 'insertmode'.
1313 lang Calling the beep module for Lua/Mzscheme/TCL.
1314 mess No output available for |g<|.
1315 showmatch Error occurred for 'showmatch' function.
1316 operator Empty region error |cpo-E|.
1317 register Unknown register after <C-R> in |Insert-mode|.
1318 shell Bell from shell output |:!|.
1319 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001320 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001321 wildmode More matches in |cmdline-completion| available
1322 (depends on the 'wildmode' setting).
1323
Bram Moolenaar036986f2017-03-16 17:41:02 +01001324 This is most useful to fine tune when in Insert mode the bell should
1325 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001326 indicate that an error occurred. It can be silenced by adding the
1327 "error" keyword.
1328
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1330'binary' 'bin' boolean (default off)
1331 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332 This option should be set before editing a binary file. You can also
1333 use the |-b| Vim argument. When this option is switched on a few
1334 options will be changed (also when it already was on):
1335 'textwidth' will be set to 0
1336 'wrapmargin' will be set to 0
1337 'modeline' will be off
1338 'expandtab' will be off
1339 Also, 'fileformat' and 'fileformats' options will not be used, the
1340 file is read and written like 'fileformat' was "unix" (a single <NL>
1341 separates lines).
1342 The 'fileencoding' and 'fileencodings' options will not be used, the
1343 file is read without conversion.
1344 NOTE: When you start editing a(nother) file while the 'bin' option is
1345 on, settings from autocommands may change the settings again (e.g.,
1346 'textwidth'), causing trouble when editing. You might want to set
1347 'bin' again when the file has been loaded.
1348 The previous values of these options are remembered and restored when
1349 'bin' is switched from on to off. Each buffer has its own set of
1350 saved option values.
1351 To edit a file with 'binary' set you can use the |++bin| argument.
1352 This avoids you have to do ":set bin", which would have effect for all
1353 files you edit.
1354 When writing a file the <EOL> for the last line is only written if
1355 there was one in the original file (normally Vim appends an <EOL> to
1356 the last line if there is none; this would make the file longer). See
1357 the 'endofline' option.
1358
1359 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1360'bioskey' 'biosk' boolean (default on)
1361 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001362 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001363 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364
1365 *'bomb'* *'nobomb'*
1366'bomb' boolean (default off)
1367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 When writing a file and the following conditions are met, a BOM (Byte
1369 Order Mark) is prepended to the file:
1370 - this option is on
1371 - the 'binary' option is off
1372 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1373 endian variants.
1374 Some applications use the BOM to recognize the encoding of the file.
1375 Often used for UCS-2 files on MS-Windows. For other applications it
1376 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001377 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1379 check for the presence of the BOM is done and 'bomb' set accordingly.
1380 Unless 'binary' is set, it is removed from the first line, so that you
1381 don't see it when editing. When you don't change the options, the BOM
1382 will be restored when writing the file.
1383
1384 *'breakat'* *'brk'*
1385'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1386 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001387 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 feature}
1389 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001390 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1391 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001393 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001394'breakindent' 'bri' boolean (default off)
1395 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001396 {not available when compiled without the |+linebreak|
1397 feature}
1398 Every wrapped line will continue visually indented (same amount of
1399 space as the beginning of that line), thus preserving horizontal blocks
1400 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001401 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001402
1403 *'breakindentopt'* *'briopt'*
1404'breakindentopt' 'briopt' string (default empty)
1405 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001406 {not available when compiled without the |+linebreak|
1407 feature}
1408 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001409 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001410 min:{n} Minimum text width that will be kept after
1411 applying 'breakindent', even if the resulting
1412 text should normally be narrower. This prevents
1413 text indented almost to the right window border
1414 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001415 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001416 shift:{n} After applying 'breakindent', the wrapped line's
1417 beginning will be shifted by the given number of
1418 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001419 indentation (negative) or emphasizing the line
1420 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001421 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001422 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001423 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001424 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001425 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001426 numbered or bulleted list (using the
1427 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001428 list:-1 Uses the length of a match with 'formatlistpat'
1429 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001430 (default: 0)
1431 column:{n} Indent at column {n}. Will overrule the other
1432 sub-options. Note: an additional indent may be
1433 added for the 'showbreak' setting.
1434 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001435
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001437'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001439 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001441 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001442 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 buffer Use the directory of the related buffer.
1444 current Use the current directory.
1445 {path} Use the specified directory
1446
1447 *'bufhidden'* *'bh'*
1448'bufhidden' 'bh' string (default: "")
1449 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 This option specifies what happens when a buffer is no longer
1451 displayed in a window:
1452 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001453 hide hide the buffer (don't unload it), even if 'hidden' is
1454 not set
1455 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001456 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001457 delete delete the buffer from the buffer list, even if
1458 'hidden' is set; the |:hide| command will also delete
1459 the buffer, making it behave like |:bdelete|
1460 wipe wipe the buffer from the buffer list, even if
1461 'hidden' is set; the |:hide| command will also wipe
1462 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001464 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001465 are lost without a warning. Also, these values may break autocommands
1466 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 This option is used together with 'buftype' and 'swapfile' to specify
1468 special kinds of buffers. See |special-buffers|.
1469
1470 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1471'buflisted' 'bl' boolean (default: on)
1472 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 When this option is set, the buffer shows up in the buffer list. If
1474 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1475 This option is reset by Vim for buffers that are only used to remember
1476 a file name or marks. Vim sets it when starting to edit a buffer.
1477 But not when moving to a buffer with ":buffer".
1478
1479 *'buftype'* *'bt'* *E382*
1480'buftype' 'bt' string (default: "")
1481 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482 The value of this option specifies the type of a buffer:
1483 <empty> normal buffer
1484 nofile buffer which is not related to a file and will not be
1485 written
1486 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001487 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001488 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001490 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 help help buffer (you are not supposed to set this
1492 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001493 terminal buffer for a |terminal| (you are not supposed to set
1494 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001495 prompt buffer where only the last line can be edited, meant
1496 to be used by a plugin, see |prompt-buffer|
1497 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001498 popup buffer used in a popup window, see |popup|.
1499 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500
1501 This option is used together with 'bufhidden' and 'swapfile' to
1502 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001503 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504
1505 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001506 One such effect is that Vim will not check the timestamp of the file,
1507 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508
Bram Moolenaar280f1262006-01-30 00:14:18 +00001509 A "quickfix" buffer is only used for the error list and the location
1510 list. This value is set by the |:cwindow| and |:lwindow| commands and
1511 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512
1513 "nofile" and "nowrite" buffers are similar:
1514 both: The buffer is not to be written to disk, ":w" doesn't
1515 work (":w filename" does work though).
1516 both: The buffer is never considered to be |'modified'|.
1517 There is no warning when the changes will be lost, for
1518 example when you quit Vim.
1519 both: A swap file is only created when using too much memory
1520 (when 'swapfile' has been reset there is never a swap
1521 file).
1522 nofile only: The buffer name is fixed, it is not handled like a
1523 file name. It is not modified in response to a |:cd|
1524 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001525 both: When using ":e bufname" and already editing "bufname"
1526 the buffer is made empty and autocommands are
1527 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001528 *E676*
1529 "acwrite" implies that the buffer name is not related to a file, like
1530 "nofile", but it will be written. Thus, in contrast to "nofile" and
1531 "nowrite", ":w" does work and a modified buffer can't be abandoned
1532 without saving. For writing there must be matching |BufWriteCmd|,
1533 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534
1535 *'casemap'* *'cmp'*
1536'casemap' 'cmp' string (default: "internal,keepascii")
1537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 Specifies details about changing the case of letters. It may contain
1539 these words, separated by a comma:
1540 internal Use internal case mapping functions, the current
1541 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001542 matters when 'encoding' is a Unicode encoding,
1543 "latin1" or "iso-8859-15". When "internal" is
1544 omitted, the towupper() and towlower() system library
1545 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1547 case mapping, the current locale is not effective.
1548 This probably only matters for Turkish.
1549
Bram Moolenaar938ae282023-02-20 20:44:55 +00001550 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001551'cdhome' 'cdh' boolean (default: off)
1552 global
1553 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1554 current working directory to the |$HOME| directory like in Unix.
1555 When off, those commands just print the current directory name.
1556 On Unix this option has no effect.
1557 NOTE: This option is reset when 'compatible' is set.
1558
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 *'cdpath'* *'cd'* *E344* *E346*
1560'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001563 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1564 searched for has a relative path, not an absolute part starting with
1565 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 The 'cdpath' option's value has the same form and semantics as
1567 |'path'|. Also see |file-searching|.
1568 The default value is taken from $CDPATH, with a "," prepended to look
1569 in the current directory first.
1570 If the default value taken from $CDPATH is not what you want, include
1571 a modified version of the following command in your vimrc file to
1572 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001573 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574< This option cannot be set from a |modeline| or in the |sandbox|, for
1575 security reasons.
1576 (parts of 'cdpath' can be passed to the shell to expand file names).
1577
1578 *'cedit'*
1579'cedit' string (Vi default: "", Vim default: CTRL-F)
1580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581 The key used in Command-line Mode to open the command-line window.
1582 The default is CTRL-F when 'compatible' is off.
1583 Only non-printable keys are allowed.
1584 The key can be specified as a single character, but it is difficult to
1585 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001586 :exe "set cedit=\<C-Y>"
1587 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588< |Nvi| also has this option, but it only uses the first character.
1589 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001590 NOTE: This option is set to the Vim default value when 'compatible'
1591 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592
1593 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1594'charconvert' 'ccv' string (default "")
1595 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001596 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 An expression that is used for character encoding conversion. It is
1598 evaluated when a file that is to be read or has been written has a
1599 different encoding from what is desired.
1600 'charconvert' is not used when the internal iconv() function is
1601 supported and is able to do the conversion. Using iconv() is
1602 preferred, because it is much faster.
1603 'charconvert' is not used when reading stdin |--|, because there is no
1604 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001605 The expression must return zero, false or an empty string for success,
1606 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 The possible encoding names encountered are in 'encoding'.
1608 Additionally, names given in 'fileencodings' and 'fileencoding' are
1609 used.
1610 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1611 is done internally by Vim, 'charconvert' is not used for this.
1612 'charconvert' is also used to convert the viminfo file, if the 'c'
1613 flag is present in 'viminfo'. Also used for Unicode conversion.
1614 Example: >
1615 set charconvert=CharConvert()
1616 fun CharConvert()
1617 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001618 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1619 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620 return v:shell_error
1621 endfun
1622< The related Vim variables are:
1623 v:charconvert_from name of the current encoding
1624 v:charconvert_to name of the desired encoding
1625 v:fname_in name of the input file
1626 v:fname_out name of the output file
1627 Note that v:fname_in and v:fname_out will never be the same.
1628 Note that v:charconvert_from and v:charconvert_to may be different
1629 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001630
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001631 The advantage of using a function call without arguments is that it is
1632 faster, see |expr-option-function|.
1633
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 Encryption is not done by Vim when using 'charconvert'. If you want
1635 to encrypt the file after conversion, 'charconvert' should take care
1636 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001637
1638 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1639 replaced with the script ID (|local-function|). Example: >
1640 set charconvert=s:MyConvert()
1641 set charconvert=<SID>SomeConvert()
1642< Otherwise the expression is evaluated in the context of the script
1643 where the option was set, thus script-local items are available.
1644
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 This option cannot be set from a |modeline| or in the |sandbox|, for
1646 security reasons.
1647
1648 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1649'cindent' 'cin' boolean (default off)
1650 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001651 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 that trigger reindenting in insert mode and 'cinoptions' to set your
1653 preferred indent style.
1654 If 'indentexpr' is not empty, it overrules 'cindent'.
1655 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1656 the "=" operator indents using this algorithm rather than calling an
1657 external program.
1658 See |C-indenting|.
1659 When you don't like the way 'cindent' works, try the 'smartindent'
1660 option or 'indentexpr'.
1661 This option is not used when 'paste' is set.
1662 NOTE: This option is reset when 'compatible' is set.
1663
1664 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001665'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 A list of keys that, when typed in Insert mode, cause reindenting of
1668 the current line. Only used if 'cindent' is on and 'indentexpr' is
1669 empty.
1670 For the format of this option see |cinkeys-format|.
1671 See |C-indenting|.
1672
1673 *'cinoptions'* *'cino'*
1674'cinoptions' 'cino' string (default "")
1675 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1677 program. See |cinoptions-values| for the values of this option, and
1678 |C-indenting| for info on C indenting in general.
1679
1680
1681 *'cinwords'* *'cinw'*
1682'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1683 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684 These keywords start an extra indent in the next line when
1685 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1686 an appropriate place (inside {}).
1687 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1688 matter, include the keyword both the uppercase and lowercase:
1689 "if,If,IF".
1690
Tom Praschan3506cf32022-04-07 12:39:08 +01001691 *'cinscopedecls'* *'cinsd'*
1692'cinscopedecls' 'cinsd' string (default "public,protected,private")
1693 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001694 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1695 Useful e.g. for working with the Qt framework that defines additional
1696 scope declarations "signals", "public slots" and "private slots": >
1697 set cinscopedecls+=signals,public\ slots,private\ slots
1698
1699< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1701 for X-windows, "" otherwise)
1702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703 {only in GUI versions or when the |+xterm_clipboard|
1704 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001705 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001706 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001707 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001708 prepend, e.g.: >
1709 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001710< When using the GUI see |'go-A'|.
1711 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001713 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 unnamed When included, Vim will use the clipboard register '*'
1715 for all yank, delete, change and put operations which
1716 would normally go to the unnamed register. When a
1717 register is explicitly specified, it will always be
1718 used regardless of whether "unnamed" is in 'clipboard'
1719 or not. The clipboard register can always be
1720 explicitly accessed using the "* notation. Also see
1721 |gui-clipboard|.
1722
Bram Moolenaar30b65812012-07-12 22:01:11 +02001723 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001724 unnamedplus A variant of the "unnamed" flag which uses the
1725 clipboard register '+' (|quoteplus|) instead of
1726 register '*' for all yank, delete, change and put
1727 operations which would normally go to the unnamed
1728 register. When "unnamed" is also included to the
1729 option, yank operations (but not delete, change or
1730 put) will additionally copy the text into register
1731 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001732 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001733 Availability can be checked with: >
1734 if has('unnamedplus')
1735<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001736 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 autoselect Works like the 'a' flag in 'guioptions': If present,
1738 then whenever Visual mode is started, or the Visual
1739 area extended, Vim tries to become the owner of the
1740 windowing system's global selection or put the
1741 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001742 register "*. See |'go-a'| and |quotestar| for details.
1743 When the GUI is active, the 'a' flag in 'guioptions'
1744 is used, when the GUI is not active, this "autoselect"
1745 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 Also applies to the modeless selection.
1747
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001748 *clipboard-autoselectplus*
1749 autoselectplus Like "autoselect" but using the + register instead of
1750 the * register. Compare to the 'P' flag in
1751 'guioptions'.
1752
1753 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 autoselectml Like "autoselect", but for the modeless selection
1755 only. Compare to the 'A' flag in 'guioptions'.
1756
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001757 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001758 html When the clipboard contains HTML, use this when
1759 pasting. When putting text on the clipboard, mark it
1760 as HTML. This works to copy rendered HTML from
1761 Firefox, paste it as raw HTML in Vim, select the HTML
1762 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001763 You probably want to add this only temporarily,
1764 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001765 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001766
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001767 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 exclude:{pattern}
1769 Defines a pattern that is matched against the name of
1770 the terminal 'term'. If there is a match, no
1771 connection will be made to the X server. This is
1772 useful in this situation:
1773 - Running Vim in a console.
1774 - $DISPLAY is set to start applications on another
1775 display.
1776 - You do not want to connect to the X server in the
1777 console, but do want this in a terminal emulator.
1778 To never connect to the X server use: >
1779 exclude:.*
1780< This has the same effect as using the |-X| argument.
1781 Note that when there is no connection to the X server
1782 the window title won't be restored and the clipboard
1783 cannot be accessed.
1784 The value of 'magic' is ignored, {pattern} is
1785 interpreted as if 'magic' was on.
1786 The rest of the option value will be used for
1787 {pattern}, this must be the last entry.
1788
1789 *'cmdheight'* *'ch'*
1790'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001791 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001792 Number of screen lines to use for the command-line. A larger value
1793 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001794 The value of this option is stored with the tab page, so that each tab
1795 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796
1797 *'cmdwinheight'* *'cwh'*
1798'cmdwinheight' 'cwh' number (default 7)
1799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 Number of screen lines to use for the command-line window. |cmdwin|
1801
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001802 *'colorcolumn'* *'cc'*
1803'colorcolumn' 'cc' string (default "")
1804 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001805 {not available when compiled without the |+syntax|
1806 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001807 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001808 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1809 text. Will make screen redrawing slower.
1810 The screen column can be an absolute number, or a number preceded with
1811 '+' or '-', which is added to or subtracted from 'textwidth'. >
1812
1813 :set cc=+1 " highlight column after 'textwidth'
1814 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1815 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1816<
1817 When 'textwidth' is zero then the items with '-' and '+' are not used.
1818 A maximum of 256 columns are highlighted.
1819
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 *'columns'* *'co'* *E594*
1821'columns' 'co' number (default 80 or terminal width)
1822 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001824 initialization and does not have to be set by hand. Also see
1825 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 When Vim is running in the GUI or in a resizable window, setting this
1827 option will cause the window size to be changed. When you only want
1828 to use the size for the GUI, put the command in your |gvimrc| file.
1829 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001830 number of columns of the display, the display may be messed up. For
1831 the GUI it is always possible and Vim limits the number of columns to
1832 what fits on the screen. You can use this command to get the widest
1833 window possible: >
1834 :set columns=9999
1835< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836
1837 *'comments'* *'com'* *E524* *E525*
1838'comments' 'com' string (default
1839 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1840 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001841 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 |format-comments|. See |option-backslash| about using backslashes to
1843 insert a space.
1844
1845 *'commentstring'* *'cms'* *E537*
1846'commentstring' 'cms' string (default "/*%s*/")
1847 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 {not available when compiled without the |+folding|
1849 feature}
1850 A template for a comment. The "%s" in the value is replaced with the
1851 comment text. Currently only used to add markers for folding, see
1852 |fold-marker|.
1853
1854 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001855'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001856 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 This option has the effect of making Vim either more Vi-compatible, or
1859 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001860
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001862 other options are also changed as a side effect.
1863 NOTE: Setting or resetting this option can have a lot of unexpected
1864 effects: Mappings are interpreted in another way, undo behaves
1865 differently, etc. If you set this option in your vimrc file, you
1866 should probably put it at the very start.
1867
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 By default this option is on and the Vi defaults are used for the
1869 options. This default was chosen for those people who want to use Vim
1870 just like Vi, and don't even (want to) know about the 'compatible'
1871 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001872 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001873 this option is switched off, and all options that have not been
1874 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001875 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001876 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001877 happen for the system-wide vimrc or gvimrc file, nor for a file given
1878 with the |-u| argument). Also see |compatible-default| and
1879 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 You can also set this option with the "-C" argument, and reset it with
1881 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001882 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883
Bram Moolenaar214641f2017-03-05 17:04:09 +01001884 When this option is set, numerous other options are set to make Vim as
1885 Vi-compatible as possible. When this option is unset, various options
1886 are set to make Vim more useful. The table below lists all the
1887 options affected.
1888 The {?} column indicates when the options are affected:
1889 + Means that the option is set to the value given in {set value} when
1890 'compatible' is set.
1891 & Means that the option is set to the value given in {set value} when
1892 'compatible' is set AND is set to its Vim default value when
1893 'compatible' is unset.
1894 - Means the option is NOT changed when setting 'compatible' but IS
1895 set to its Vim default when 'compatible' is unset.
1896 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897
Bram Moolenaar036986f2017-03-16 17:41:02 +01001898 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001899
1900 'allowrevins' + off no CTRL-_ command
1901 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001902 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001903 'arabicshape' + on correct character shapes
1904 'backspace' + "" normal backspace
1905 'backup' + off no backup file
1906 'backupcopy' & Unix: "yes" backup file is a copy
1907 else: "auto" copy or rename backup file
1908 'balloonexpr' + "" text to show in evaluation balloon
1909 'breakindent' + off don't indent when wrapping lines
1910 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001911 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001912 'cindent' + off no C code indentation
1913 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1914 'copyindent' + off don't copy indent structure
1915 'cpoptions' & (all flags) Vi-compatible flags
1916 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001917 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001918 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001919 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001920 'cscopeverbose' + off see |cscopeverbose|
1921 'delcombine' + off unicode: delete whole char combination
1922 'digraph' + off no digraphs
1923 'esckeys' & off no <Esc>-keys in Insert mode
1924 'expandtab' + off tabs not expanded to spaces
1925 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001926 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001927 'formatexpr' + "" use 'formatprg' for auto-formatting
1928 'formatoptions' & "vt" Vi compatible formatting
1929 'gdefault' + off no default 'g' flag for ":s"
1930 'history' & 0 no commandline history
1931 'hkmap' + off no Hebrew keyboard mapping
1932 'hkmapp' + off no phonetic Hebrew keyboard mapping
1933 'hlsearch' + off no highlighting of search matches
1934 'incsearch' + off no incremental searching
1935 'indentexpr' + "" no indenting by expression
1936 'insertmode' + off do not start in Insert mode
1937 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001939 'joinspaces' + on insert 2 spaces after period
1940 'modeline' & off no modelines
1941 'more' & off no pauses in listings
1942 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1943 'numberwidth' & 8 min number of columns for line number
1944 'preserveindent'+ off don't preserve current indent structure
1945 when changing it
1946 'revins' + off no reverse insert
1947 'ruler' + off no ruler
1948 'scrolljump' + 1 no jump scroll
1949 'scrolloff' + 0 no scroll offset
1950 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1951 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001952 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001953 'showcmd' & off command characters not shown
1954 'showmode' & off current mode not shown
1955 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1956 'smartcase' + off no automatic ignore case switch
1957 'smartindent' + off no smart indentation
1958 'smarttab' + off no smart tab size
1959 'softtabstop' + 0 tabs are always 'tabstop' positions
1960 'startofline' + on goto startofline with some commands
1961 'tagcase' & "followic" 'ignorecase' when searching tags file
1962 'tagrelative' & off tag file names are not relative
1963 'termguicolors' + off don't use highlight-(guifg|guibg)
1964 'textauto' & off no automatic textmode detection
1965 'textwidth' + 0 no automatic line wrap
1966 'tildeop' + off tilde is not an operator
1967 'ttimeout' + off no terminal timeout
1968 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001969 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001970 'virtualedit' + "" cursor can only be placed on characters
1971 'whichwrap' & "" left-right movements don't wrap
1972 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001974 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975
1976 *'complete'* *'cpt'* *E535*
1977'complete' 'cpt' string (default: ".,w,b,u,t,i")
1978 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 This option specifies how keyword completion |ins-completion| works
1980 when CTRL-P or CTRL-N are used. It is also used for whole-line
1981 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001982 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001983 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 w scan buffers from other windows
1985 b scan other loaded buffers that are in the buffer list
1986 u scan the unloaded buffers that are in the buffer list
1987 U scan the buffers that are not in the buffer list
1988 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001989 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 k{dict} scan the file {dict}. Several "k" flags can be given,
1991 patterns are valid too. For example: >
1992 :set cpt=k/usr/dict/*,k~/spanish
1993< s scan the files given with the 'thesaurus' option
1994 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1995 are valid too.
1996 i scan current and included files
1997 d scan current and included files for defined name or macro
1998 |i_CTRL-X_CTRL-D|
1999 ] tag completion
2000 t same as "]"
2001
2002 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2003 not executed, this may lead to unexpected completions from some files
2004 (gzipped files for example). Unloaded buffers are not scanned for
2005 whole-line completion.
2006
2007 The default is ".,w,b,u,t,i", which means to scan:
2008 1. the current buffer
2009 2. buffers in other windows
2010 3. other loaded buffers
2011 4. unloaded buffers
2012 5. tags
2013 6. included files
2014
2015 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002016 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2017 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002019 *'completefunc'* *'cfu'*
2020'completefunc' 'cfu' string (default: empty)
2021 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002022 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002023 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002024 This option specifies a function to be used for Insert mode completion
2025 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002026 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002027 invoked and what it should return. The value can be the name of a
2028 function, a |lambda| or a |Funcref|. See |option-value-function| for
2029 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002030 This option cannot be set from a |modeline| or in the |sandbox|, for
2031 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002032
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002033 *'completeslash'* *'csl'*
2034'completeslash' 'csl' string (default: "")
2035 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002036 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002037 When this option is set it overrules 'shellslash' for completion:
2038 - When this option is set to "slash", a forward slash is used for path
2039 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002040 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002041 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002042 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002043 - When this option is empty, same character is used as for
2044 'shellslash'.
2045 For Insert mode completion the buffer-local value is used. For
2046 command line completion the global value is used.
2047
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002048 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002049'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002050 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002051 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002052 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002053
2054 menu Use a popup menu to show the possible completions. The
2055 menu is only shown when there is more than one match and
2056 sufficient colors are available. |ins-completion-menu|
2057
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002058 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002059 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002060 match, e.g., what file it comes from.
2061
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002062 longest Only insert the longest common text of the matches. If
2063 the menu is displayed you can use CTRL-L to add more
2064 characters. Whether case is ignored depends on the kind
2065 of completion. For buffer text the 'ignorecase' option is
2066 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002067
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002068 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002069 completion in the preview window. Only works in
2070 combination with "menu" or "menuone".
2071
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002072 popup Show extra information about the currently selected
2073 completion in a popup window. Only works in combination
2074 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002075 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002076 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002077
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002078 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002079 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002080 |CompleteChanged| autocommand to fetch the info and call
2081 |popup_show()| once the popup has been filled.
2082 See the example at |complete-popuphidden|.
2083 {only works when compiled with the |+textprop| feature}
2084
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002085 noinsert Do not insert any text for a match until the user selects
2086 a match from the menu. Only works in combination with
2087 "menu" or "menuone". No effect if "longest" is present.
2088
2089 noselect Do not select a match in the menu, force the user to
2090 select one from the menu. Only works in combination with
2091 "menu" or "menuone".
2092
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002093
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002094 *'completepopup'* *'cpp'*
2095'completepopup' 'cpp' string (default empty)
2096 global
2097 {not available when compiled without the |+textprop|
2098 or |+quickfix| feature}
2099 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002100 properties of the info popup when it is created. If an info popup
2101 window already exists it is closed, so that the option value is
2102 applied when it is created again.
2103 You can also use |popup_findinfo()| and then set properties for an
2104 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002105
2106
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002107 *'concealcursor'* *'cocu'*
2108'concealcursor' 'cocu' string (default: "")
2109 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002110 {not available when compiled without the |+conceal|
2111 feature}
2112 Sets the modes in which text in the cursor line can also be concealed.
2113 When the current mode is listed then concealing happens just like in
2114 other lines.
2115 n Normal mode
2116 v Visual mode
2117 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002118 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002119
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002120 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002121 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002122 are moving around text is concealed, but when starting to insert text
2123 or selecting a Visual area the concealed text is displayed, so that
2124 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002125 Keep in mind that the cursor position is not always where it's
2126 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002127
2128
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002129 *'conceallevel'* *'cole'*
2130'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002131 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002132 {not available when compiled without the |+conceal|
2133 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002134 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2135 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002136
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002137 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002138 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002139 1 Each block of concealed text is replaced with one
2140 character. If the syntax item does not have a custom
2141 replacement character defined (see |:syn-cchar|) the
2142 character defined in 'listchars' is used (default is a
2143 space).
2144 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002145 2 Concealed text is completely hidden unless it has a
2146 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002147 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002148 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002149
Bram Moolenaara7781e02010-07-19 20:13:22 +02002150 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002151 edit and copy the text. This can be changed with the 'concealcursor'
2152 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002153
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2155'confirm' 'cf' boolean (default off)
2156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 When 'confirm' is on, certain operations that would normally
2158 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2159 instead raise a |dialog| asking if you wish to save the current
2160 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2161 If 'confirm' is off you can still activate confirmation for one
2162 command only (this is most useful in mappings) with the |:confirm|
2163 command.
2164 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2165
2166 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2167'conskey' 'consk' boolean (default off)
2168 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002169 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170
2171 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2172'copyindent' 'ci' boolean (default off)
2173 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 Copy the structure of the existing lines indent when autoindenting a
2175 new line. Normally the new indent is reconstructed by a series of
2176 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2177 in which case only spaces are used). Enabling this option makes the
2178 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002179 existing line. 'expandtab' has no effect on these characters, a Tab
2180 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002182 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 Also see 'preserveindent'.
2184
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002185 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186'cpoptions' 'cpo' string (Vim default: "aABceFs",
2187 Vi default: all flags)
2188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002190 this indicates Vi-compatible behavior. This is used for things where
2191 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 'cpoptions' stands for "compatible-options".
2193 Commas can be added for readability.
2194 To avoid problems with flags that are added in the future, use the
2195 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002196
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 NOTE: This option is set to the Vi default value when 'compatible' is
2198 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002199
2200 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2201 is saved, 'cpoptions' is set to the Vim default, and the saved value
2202 is restored at the end of the script. Changes to the value of
2203 'cpoptions' will be applied to the saved value, but keep in mind that
2204 removing a flag that is not present when 'cpoptions' is changed has no
2205 effect. In the |.vimrc| file the value is not restored, thus using
2206 `vim9script` in the |.vimrc| file results in using the Vim default.
2207
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002208 NOTE: This option is set to the POSIX default value at startup when
2209 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002210 variable exists |posix|. This means Vim tries to behave like the
2211 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212
2213 contains behavior ~
2214 *cpo-a*
2215 a When included, a ":read" command with a file name
2216 argument will set the alternate file name for the
2217 current window.
2218 *cpo-A*
2219 A When included, a ":write" command with a file name
2220 argument will set the alternate file name for the
2221 current window.
2222 *cpo-b*
2223 b "\|" in a ":map" command is recognized as the end of
2224 the map command. The '\' is included in the mapping,
2225 the text after the '|' is interpreted as the next
2226 command. Use a CTRL-V instead of a backslash to
2227 include the '|' in the mapping. Applies to all
2228 mapping, abbreviation, menu and autocmd commands.
2229 See also |map_bar|.
2230 *cpo-B*
2231 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002232 abbreviations, user commands and the "to" part of the
2233 menu commands. Remove this flag to be able to use a
2234 backslash like a CTRL-V. For example, the command
2235 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 'B' included: "\^[" (^[ is a real <Esc>)
2237 'B' excluded: "<Esc>" (5 characters)
2238 ('<' excluded in both cases)
2239 *cpo-c*
2240 c Searching continues at the end of any match at the
2241 cursor position, but not further than the start of the
2242 next line. When not present searching continues
2243 one character from the cursor position. With 'c'
2244 "abababababab" only gets three matches when repeating
2245 "/abab", without 'c' there are five matches.
2246 *cpo-C*
2247 C Do not concatenate sourced lines that start with a
2248 backslash. See |line-continuation|.
2249 *cpo-d*
2250 d Using "./" in the 'tags' option doesn't mean to use
2251 the tags file relative to the current file, but the
2252 tags file in the current directory.
2253 *cpo-D*
2254 D Can't use CTRL-K to enter a digraph after Normal mode
2255 commands with a character argument, like |r|, |f| and
2256 |t|.
2257 *cpo-e*
2258 e When executing a register with ":@r", always add a
2259 <CR> to the last line, also when the register is not
2260 linewise. If this flag is not present, the register
2261 is not linewise and the last line does not end in a
2262 <CR>, then the last line is put on the command-line
2263 and can be edited before hitting <CR>.
2264 *cpo-E*
2265 E It is an error when using "y", "d", "c", "g~", "gu" or
2266 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002267 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 This makes "y0" fail in the first column.
2269 *cpo-f*
2270 f When included, a ":read" command with a file name
2271 argument will set the file name for the current buffer,
2272 if the current buffer doesn't have a file name yet.
2273 *cpo-F*
2274 F When included, a ":write" command with a file name
2275 argument will set the file name for the current
2276 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002277 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 *cpo-g*
2279 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002280 *cpo-H*
2281 H When using "I" on a line with only blanks, insert
2282 before the last blank. Without this flag insert after
2283 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284 *cpo-i*
2285 i When included, interrupting the reading of a file will
2286 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002287 *cpo-I*
2288 I When moving the cursor up or down just after inserting
2289 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 *cpo-j*
2291 j When joining lines, only add two spaces after a '.',
2292 not after '!' or '?'. Also see 'joinspaces'.
2293 *cpo-J*
2294 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002295 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 white space.
2297 *cpo-k*
2298 k Disable the recognition of raw key codes in
2299 mappings, abbreviations, and the "to" part of menu
2300 commands. For example, if <Key> sends ^[OA (where ^[
2301 is <Esc>), the command ":map X ^[OA" results in X
2302 being mapped to:
2303 'k' included: "^[OA" (3 characters)
2304 'k' excluded: "<Key>" (one key code)
2305 Also see the '<' flag below.
2306 *cpo-K*
2307 K Don't wait for a key code to complete when it is
2308 halfway a mapping. This breaks mapping <F1><F1> when
2309 only part of the second <F1> has been read. It
2310 enables cancelling the mapping by typing <F1><Esc>.
2311 *cpo-l*
2312 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002313 literally, only "\]", "\^", "\-" and "\\" are special.
2314 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2316 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002317 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 *cpo-L*
2319 L When the 'list' option is set, 'wrapmargin',
2320 'textwidth', 'softtabstop' and Virtual Replace mode
2321 (see |gR|) count a <Tab> as two characters, instead of
2322 the normal behavior of a <Tab>.
2323 *cpo-m*
2324 m When included, a showmatch will always wait half a
2325 second. When not included, a showmatch will wait half
2326 a second or until a character is typed. |'showmatch'|
2327 *cpo-M*
2328 M When excluded, "%" matching will take backslashes into
2329 account. Thus in "( \( )" and "\( ( \)" the outer
2330 parenthesis match. When included "%" ignores
2331 backslashes, which is Vi compatible.
2332 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002333 n When included, the column used for 'number' and
2334 'relativenumber' will also be used for text of wrapped
2335 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336 *cpo-o*
2337 o Line offset to search command is not remembered for
2338 next search.
2339 *cpo-O*
2340 O Don't complain if a file is being overwritten, even
2341 when it didn't exist when editing it. This is a
2342 protection against a file unexpectedly created by
2343 someone else. Vi didn't complain about this.
2344 *cpo-p*
2345 p Vi compatible Lisp indenting. When not present, a
2346 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002347 *cpo-P*
2348 P When included, a ":write" command that appends to a
2349 file will set the file name for the current buffer, if
2350 the current buffer doesn't have a file name yet and
2351 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002352 *cpo-q*
2353 q When joining multiple lines leave the cursor at the
2354 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355 *cpo-r*
2356 r Redo ("." command) uses "/" to repeat a search
2357 command, instead of the actually used search string.
2358 *cpo-R*
2359 R Remove marks from filtered lines. Without this flag
2360 marks are kept like |:keepmarks| was used.
2361 *cpo-s*
2362 s Set buffer options when entering the buffer for the
2363 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002364 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 set when the buffer is created.
2366 *cpo-S*
2367 S Set buffer options always when entering a buffer
2368 (except 'readonly', 'fileformat', 'filetype' and
2369 'syntax'). This is the (most) Vi compatible setting.
2370 The options are set to the values in the current
2371 buffer. When you change an option and go to another
2372 buffer, the value is copied. Effectively makes the
2373 buffer options global to all buffers.
2374
2375 's' 'S' copy buffer options
2376 no no when buffer created
2377 yes no when buffer first entered (default)
2378 X yes each time when buffer entered (vi comp.)
2379 *cpo-t*
2380 t Search pattern for the tag command is remembered for
2381 "n" command. Otherwise Vim only puts the pattern in
2382 the history for search pattern, but doesn't change the
2383 last used search pattern.
2384 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002385 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 *cpo-v*
2387 v Backspaced characters remain visible on the screen in
2388 Insert mode. Without this flag the characters are
2389 erased from the screen right away. With this flag the
2390 screen newly typed text overwrites backspaced
2391 characters.
2392 *cpo-w*
2393 w When using "cw" on a blank character, only change one
2394 character and not all blanks until the start of the
2395 next word.
2396 *cpo-W*
2397 W Don't overwrite a readonly file. When omitted, ":w!"
2398 overwrites a readonly file, if possible.
2399 *cpo-x*
2400 x <Esc> on the command-line executes the command-line.
2401 The default in Vim is to abandon the command-line,
2402 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002403 *cpo-X*
2404 X When using a count with "R" the replaced text is
2405 deleted only once. Also when repeating "R" with "."
2406 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002408 y A yank command can be redone with ".". Think twice if
2409 you really want to use this, it may break some
2410 plugins, since most people expect "." to only repeat a
2411 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002412 *cpo-Z*
2413 Z When using "w!" while the 'readonly' option is set,
2414 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 *cpo-!*
2416 ! When redoing a filter command, use the last used
2417 external command, whatever it was. Otherwise the last
2418 used -filter- command is used.
2419 *cpo-$*
2420 $ When making a change to one line, don't redisplay the
2421 line, but put a '$' at the end of the changed text.
2422 The changed text will be overwritten when you type the
2423 new text. The line is redisplayed if you type any
2424 command that moves the cursor from the insertion
2425 point.
2426 *cpo-%*
2427 % Vi-compatible matching is done for the "%" command.
2428 Does not recognize "#if", "#endif", etc.
2429 Does not recognize "/*" and "*/".
2430 Parens inside single and double quotes are also
2431 counted, causing a string that contains a paren to
2432 disturb the matching. For example, in a line like
2433 "if (strcmp("foo(", s))" the first paren does not
2434 match the last one. When this flag is not included,
2435 parens inside single and double quotes are treated
2436 specially. When matching a paren outside of quotes,
2437 everything inside quotes is ignored. When matching a
2438 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002439 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002440 This flag is also used for other features, such as
2441 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002442 *cpo--*
2443 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002444 it would go above the first line or below the last
2445 line. Without it the cursor moves to the first or
2446 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002447 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002448 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002449 *cpo-+*
2450 + When included, a ":write file" command will reset the
2451 'modified' flag of the buffer, even though the buffer
2452 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002453 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002454 * Use ":*" in the same way as ":@". When not included,
2455 ":*" is an alias for ":'<,'>", select the Visual area.
2456 *cpo-<*
2457 < Disable the recognition of special key codes in |<>|
2458 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002459 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 ":map X <Tab>" results in X being mapped to:
2461 '<' included: "<Tab>" (5 characters)
2462 '<' excluded: "^I" (^I is a real <Tab>)
2463 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002464 *cpo->*
2465 > When appending to a register, put a line break before
2466 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002467 *cpo-;*
2468 ; When using |,| or |;| to repeat the last |t| search
2469 and the cursor is right in front of the searched
2470 character, the cursor won't move. When not included,
2471 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002472 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002473
2474 POSIX flags. These are not included in the Vi default value, except
2475 when $VIM_POSIX was set on startup. |posix|
2476
2477 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002478 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002479 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002480 *cpo-&*
2481 & When ":preserve" was used keep the swap file when
2482 exiting normally while this buffer is still loaded.
2483 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002484 *cpo-\*
2485 \ Backslash in a [] range in a search pattern is taken
2486 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002487 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2488 '\' excluded: "/[ \-]" finds <Space> and '-'
2489 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002490 *cpo-/*
2491 / When "%" is used as the replacement string in a |:s|
2492 command, use the previous replacement string. |:s%|
2493 *cpo-{*
2494 { The |{| and |}| commands also stop at a "{" character
2495 at the start of a line.
2496 *cpo-.*
2497 . The ":chdir" and ":cd" commands fail if the current
2498 buffer is modified, unless ! is used. Vim doesn't
2499 need this, since it remembers the full path of an
2500 opened file.
2501 *cpo-bar*
2502 | The value of the $LINES and $COLUMNS environment
2503 variables overrule the terminal size values obtained
2504 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002505
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002507 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002508'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002509 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002510 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002511 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002512 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002513 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002514 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002515 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002516 blowfish Blowfish method. Medium strong encryption but it has
2517 an implementation flaw. Requires Vim 7.3 or later,
2518 files can NOT be read by Vim 7.2 and older. This adds
2519 a "seed" to the file, every time you write the file
2520 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002521 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002522 *blowfish2*
2523 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002524 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002525 and older. This adds a "seed" to the file, every time
2526 you write the file the encrypted bytes will be
2527 different. The whole undo file is encrypted, not just
2528 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002529 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002530 *E1197* *E1198* *E1199* *E1200* *E1201*
2531 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2532 Code. Medium strong till strong encryption.
2533 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002534 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002535 It adds a seed and a message authentication code (MAC)
2536 to the file. This needs at least a Vim 8.2.3022 to
2537 read the encrypted file.
2538 Encryption of swap files is not supported, therefore
2539 no swap file will be used when xchacha20 encryption is
2540 enabled.
2541 Encryption of undo files is not yet supported,
2542 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002543 CAREFUL: Files written with this method might have to
2544 be read back with the same version of Vim if the
2545 binary format changes later.
2546 Obsolete, please do no longer use.
2547 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2548 stores the key derivation parameters together with the
2549 encrypted file. Should work better in case the
2550 parameters in the libsodium library ever change.
2551 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002552 might have to be read back with the same version of
2553 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002554
Christian Brabandtaae58342023-04-23 17:50:22 +01002555 You should use "blowfish2", also to re-encrypt older files. The
2556 "xchacha20" method provides better encryption, but it does not work
2557 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002558
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002559 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002560 to the detected method of the file being read. Thus if you write it
2561 without changing 'cryptmethod' the same method will be used.
2562 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002563 explicitly write it, you don't get a warning unless there are other
2564 modifications. Also see |:X|.
2565
2566 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002567 the value "blowfish2". When setting the local value to an empty
2568 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002569
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002570 When a new encryption method is added in a later version of Vim, and
2571 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002572 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002573
2574
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 *'cscopepathcomp'* *'cspc'*
2576'cscopepathcomp' 'cspc' number (default 0)
2577 global
2578 {not available when compiled without the |+cscope|
2579 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 Determines how many components of the path to show in a list of tags.
2581 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002582 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583
2584 *'cscopeprg'* *'csprg'*
2585'cscopeprg' 'csprg' string (default "cscope")
2586 global
2587 {not available when compiled without the |+cscope|
2588 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 Specifies the command to execute cscope. See |cscopeprg|.
2590 This option cannot be set from a |modeline| or in the |sandbox|, for
2591 security reasons.
2592
2593 *'cscopequickfix'* *'csqf'*
2594'cscopequickfix' 'csqf' string (default "")
2595 global
2596 {not available when compiled without the |+cscope|
2597 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 Specifies whether to use quickfix window to show cscope results.
2599 See |cscopequickfix|.
2600
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002601 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002602'cscoperelative' 'csre' boolean (default off)
2603 global
2604 {not available when compiled without the |+cscope|
2605 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002606 In the absence of a prefix (-P) for cscope. setting this option enables
2607 to use the basename of cscope.out path as the prefix.
2608 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002609 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002610
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2612'cscopetag' 'cst' boolean (default off)
2613 global
2614 {not available when compiled without the |+cscope|
2615 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 Use cscope for tag commands. See |cscope-options|.
2617 NOTE: This option is reset when 'compatible' is set.
2618
2619 *'cscopetagorder'* *'csto'*
2620'cscopetagorder' 'csto' number (default 0)
2621 global
2622 {not available when compiled without the |+cscope|
2623 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 Determines the order in which ":cstag" performs a search. See
2625 |cscopetagorder|.
2626 NOTE: This option is set to 0 when 'compatible' is set.
2627
2628 *'cscopeverbose'* *'csverb'*
2629 *'nocscopeverbose'* *'nocsverb'*
2630'cscopeverbose' 'csverb' boolean (default off)
2631 global
2632 {not available when compiled without the |+cscope|
2633 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 Give messages when adding a cscope database. See |cscopeverbose|.
2635 NOTE: This option is reset when 'compatible' is set.
2636
Bram Moolenaar860cae12010-06-05 23:22:07 +02002637 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2638'cursorbind' 'crb' boolean (default off)
2639 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002640 When this option is set, as the cursor in the current
2641 window moves other cursorbound windows (windows that also have
2642 this option set) move their cursors to the corresponding line and
2643 column. This option is useful for viewing the
2644 differences between two versions of a file (see 'diff'); in diff mode,
2645 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002646 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002647
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002648
2649 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2650'cursorcolumn' 'cuc' boolean (default off)
2651 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002652 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002653 feature}
2654 Highlight the screen column of the cursor with CursorColumn
2655 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2656 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002657 If you only want the highlighting in the current window you can use
2658 these autocommands: >
2659 au WinLeave * set nocursorline nocursorcolumn
2660 au WinEnter * set cursorline cursorcolumn
2661<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002662
2663 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2664'cursorline' 'cul' boolean (default off)
2665 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002666 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002667 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002668 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2669 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002670 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002671 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002672
2673
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002674 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002675'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002676 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002677 {not available when compiled without the |+syntax|
2678 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002679 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002680 Valid values:
2681 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002682 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002683 "screenline" Highlight only the screen line of the cursor with
2684 CursorLine |hl-CursorLine|.
2685 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002686 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002687
2688 Special value:
2689 "both" Alias for the values "line,number".
2690
2691 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002692
2693
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 *'debug'*
2695'debug' string (default "")
2696 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002697 These values can be used:
2698 msg Error messages that would otherwise be omitted will be given
2699 anyway.
2700 throw Error messages that would otherwise be omitted will be given
2701 anyway and also throw an exception and set |v:errmsg|.
2702 beep A message will be given when otherwise only a beep would be
2703 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002704 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002705 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2706 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707
2708 *'define'* *'def'*
2709'define' 'def' string (default "^\s*#\s*define")
2710 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002711 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 pattern, just like for the "/" command. This option is used for the
2713 commands like "[i" and "[d" |include-search|. The 'isident' option is
2714 used to recognize the defined name after the match:
2715 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2716 See |option-backslash| about inserting backslashes to include a space
2717 or backslash.
2718 The default value is for C programs. For C++ this value would be
2719 useful, to include const type declarations: >
2720 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002721< You can also use "\ze" just before the name and continue the pattern
2722 to check what is following. E.g. for Javascript, if a function is
2723 defined with "func_name = function(args)": >
2724 ^\s*\ze\i\+\s*=\s*function(
2725< If the function is defined with "func_name : function() {...": >
2726 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002728 To avoid that use `:let` with a single quote string: >
2729 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002730<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
2732 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2733'delcombine' 'deco' boolean (default off)
2734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 If editing Unicode and this option is set, backspace and Normal mode
2736 "x" delete each combining character on its own. When it is off (the
2737 default) the character along with its combining characters are
2738 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002739 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740
2741 This is useful for Arabic, Hebrew and many other languages where one
2742 may have combining characters overtop of base characters, and want
2743 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002744 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745
2746 *'dictionary'* *'dict'*
2747'dictionary' 'dict' string (default "")
2748 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 List of file names, separated by commas, that are used to lookup words
2750 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2751 contain a list of words. This can be one word per line, or several
2752 words per line, separated by non-keyword characters (white space is
2753 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002754
2755 When this option is empty or an entry "spell" is present, and spell
2756 checking is enabled, words in the word lists for the currently active
2757 'spelllang' are used. See |spell|.
2758
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002759 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 after a comma are ignored, otherwise spaces are included in the file
2761 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002762 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 Where to find a list of words?
2764 - On FreeBSD, there is the file "/usr/share/dict/words".
2765 - In the Simtel archive, look in the "msdos/linguist" directory.
2766 - In "miscfiles" of the GNU collection.
2767 The use of |:set+=| and |:set-=| is preferred when adding or removing
2768 directories from the list. This avoids problems when a future version
2769 uses another default.
2770 Backticks cannot be used in this option for security reasons.
2771
2772 *'diff'* *'nodiff'*
2773'diff' boolean (default off)
2774 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 {not available when compiled without the |+diff|
2776 feature}
2777 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002778 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779
2780 *'dex'* *'diffexpr'*
2781'diffexpr' 'dex' string (default "")
2782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 {not available when compiled without the |+diff|
2784 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002785 Expression which is evaluated to obtain a diff file (either ed-style
2786 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 This option cannot be set from a |modeline| or in the |sandbox|, for
2788 security reasons.
2789
2790 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002791'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 {not available when compiled without the |+diff|
2794 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002795 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 All are optional. Items must be separated by a comma.
2797
2798 filler Show filler lines, to keep the text
2799 synchronized with a window that has inserted
2800 lines at the same position. Mostly useful
2801 when windows are side-by-side and 'scrollbind'
2802 is set.
2803
2804 context:{n} Use a context of {n} lines between a change
2805 and a fold that contains unchanged lines.
2806 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002807 When using zero the context is actually one,
2808 since folds require a line in between, also
2809 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 See |fold-diff|.
2811
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002812 iblank Ignore changes where lines are all blank. Adds
2813 the "-B" flag to the "diff" command if
2814 'diffexpr' is empty. Check the documentation
2815 of the "diff" command for what this does
2816 exactly.
2817 NOTE: the diff windows will get out of sync,
2818 because no differences between blank lines are
2819 taken into account.
2820
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 icase Ignore changes in case of text. "a" and "A"
2822 are considered the same. Adds the "-i" flag
2823 to the "diff" command if 'diffexpr' is empty.
2824
2825 iwhite Ignore changes in amount of white space. Adds
2826 the "-b" flag to the "diff" command if
2827 'diffexpr' is empty. Check the documentation
2828 of the "diff" command for what this does
2829 exactly. It should ignore adding trailing
2830 white space, but not leading white space.
2831
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002832 iwhiteall Ignore all white space changes. Adds
2833 the "-w" flag to the "diff" command if
2834 'diffexpr' is empty. Check the documentation
2835 of the "diff" command for what this does
2836 exactly.
2837
2838 iwhiteeol Ignore white space changes at end of line.
2839 Adds the "-Z" flag to the "diff" command if
2840 'diffexpr' is empty. Check the documentation
2841 of the "diff" command for what this does
2842 exactly.
2843
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002844 horizontal Start diff mode with horizontal splits (unless
2845 explicitly specified otherwise).
2846
2847 vertical Start diff mode with vertical splits (unless
2848 explicitly specified otherwise).
2849
Bram Moolenaarc8234772019-11-10 21:00:27 +01002850 closeoff When a window is closed where 'diff' is set
2851 and there is only one window remaining in the
2852 same tab page with 'diff' set, execute
2853 `:diffoff` in that window. This undoes a
2854 `:diffsplit` command.
2855
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002856 hiddenoff Do not use diff mode for a buffer when it
2857 becomes hidden.
2858
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002859 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2860 starting diff mode. Without this 2 is used.
2861
Bram Moolenaar4223d432021-02-10 13:18:17 +01002862 followwrap Follow the 'wrap' option and leave as it is.
2863
Bram Moolenaare828b762018-09-10 17:51:58 +02002864 internal Use the internal diff library. This is
2865 ignored when 'diffexpr' is set. *E960*
2866 When running out of memory when writing a
2867 buffer this item will be ignored for diffs
2868 involving that buffer. Set the 'verbose'
2869 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870
Bram Moolenaare828b762018-09-10 17:51:58 +02002871 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002872 Use the indent heuristic for the internal
2873 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002874
2875 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002876 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002877 algorithms are:
2878 myers the default algorithm
2879 minimal spend extra time to generate the
2880 smallest possible diff
2881 patience patience diff algorithm
2882 histogram histogram diff algorithm
2883
2884 Examples: >
2885 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002887 :set diffopt=internal,filler,foldcolumn:3
2888 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889<
2890 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2891'digraph' 'dg' boolean (default off)
2892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 {not available when compiled without the |+digraphs|
2894 feature}
2895 Enable the entering of digraphs in Insert mode with {char1} <BS>
2896 {char2}. See |digraphs|.
2897 NOTE: This option is reset when 'compatible' is set.
2898
2899 *'directory'* *'dir'*
2900'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002901 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 for Unix: ".,~/tmp,/var/tmp,/tmp")
2903 global
2904 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002905 Recommended value: ".,~/vimswap//" - this will put the swap file next
2906 to the edited file if possible, and in your personal swap directory
2907 otherwise. Make sure "~/vimswap//" is only readable for you.
2908
2909 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 - The swap file will be created in the first directory where this is
2911 possible.
2912 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002913 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 - A directory "." means to put the swap file in the same directory as
2915 the edited file. On Unix, a dot is prepended to the file name, so
2916 it doesn't show in a directory listing. On MS-Windows the "hidden"
2917 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002918 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2919 the swap file relative to where the edited file is. The leading "."
2920 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002921 - For Unix and Win32, if a directory ends in two path separators "//",
2922 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002923 with all path separators replaced by percent '%' signs (including
2924 the colon following the drive letter on Win32). This will ensure
2925 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002926 On Win32, it is also possible to end with "\\". However, When a
2927 separating comma is following, you must use "//", since "\\" will
2928 include the comma in the file name. Therefore it is recommended to
2929 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 - Spaces after the comma are ignored, other spaces are considered part
2931 of the directory name. To have a space at the start of a directory
2932 name, precede it with a backslash.
2933 - To include a comma in a directory name precede it with a backslash.
2934 - A directory name may end in an ':' or '/'.
2935 - Environment variables are expanded |:set_env|.
2936 - Careful with '\' characters, type one before a space, type two to
2937 get one in the option (see |option-backslash|), for example: >
2938 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2939< - For backwards compatibility with Vim version 3.0 a '>' at the start
2940 of the option is removed.
2941 Using "." first in the list is recommended. This means that editing
2942 the same file twice will result in a warning. Using "/tmp" on Unix is
2943 discouraged: When the system crashes you lose the swap file.
2944 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002945 choice than "/tmp". But others on the computer may be able to see the
2946 files, and it can contain a lot of files, your swap files get lost in
2947 the crowd. That is why a "tmp" directory in your home directory is
2948 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 The use of |:set+=| and |:set-=| is preferred when adding or removing
2950 directories from the list. This avoids problems when a future version
2951 uses another default.
2952 This option cannot be set from a |modeline| or in the |sandbox|, for
2953 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954
2955 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002956'display' 'dy' string (default "", set to "truncate" in
2957 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01002959 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 flags:
2961 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002962 in a window will be displayed. "@@@" is put in the
2963 last columns of the last screen line to indicate the
2964 rest of the line is not displayed.
2965 truncate Like "lastline", but "@@@" is displayed in the first
2966 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 uhex Show unprintable characters hexadecimal as <xx>
2968 instead of using ^C and ~C.
2969
Bram Moolenaard0796902016-09-16 20:02:31 +02002970 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002971 doesn't fit is replaced with "@" lines.
2972
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01002973 The "@" character can be changed by setting the "lastline" item in
2974 'fillchars'. The character is highlighted with |hl-NonText|.
2975
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 *'eadirection'* *'ead'*
2977'eadirection' 'ead' string (default "both")
2978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 Tells when the 'equalalways' option applies:
2980 ver vertically, width of windows is not affected
2981 hor horizontally, height of windows is not affected
2982 both width and height of windows is affected
2983
2984 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2985'edcompatible' 'ed' boolean (default off)
2986 global
2987 Makes the 'g' and 'c' flags of the ":substitute" command to be
2988 toggled each time the flag is given. See |complex-change|. See
2989 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002990 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002991 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992
Bram Moolenaar03413f42016-04-12 21:07:15 +02002993 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002994'emoji' 'emo' boolean (default: on)
2995 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002996 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002997 This excludes "text emoji" characters, which are normally displayed as
2998 single width. Unfortunately there is no good specification for this
2999 and it has been determined on trial-and-error basis. Use the
3000 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003001
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003003'encoding' 'enc' string (default for MS-Windows: "utf-8",
3004 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 Sets the character encoding used inside Vim. It applies to text in
3007 the buffers, registers, Strings in expressions, text stored in the
3008 viminfo file, etc. It sets the kind of characters which Vim can work
3009 with. See |encoding-names| for the possible values.
3010
3011 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003012 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003014 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015
Bram Moolenaar865242e2010-07-14 21:12:05 +02003016 This option cannot be set from a |modeline|. It would most likely
3017 corrupt the text.
3018
Bram Moolenaar3df01732017-02-17 22:47:16 +01003019 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3020 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 'encoding', "utf-8" is the natural choice for the environment and
3022 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003023 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 versions, and to avoid changing the encoding of newly created files
3025 without your knowledge (in case 'fileencodings' is empty).
3026
3027 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003028 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 iconv() or as specified with 'charconvert'.
3030
Bram Moolenaar207f0092020-08-30 17:20:20 +02003031 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003032 can use: >
3033 if has("multi_byte_encoding")
3034<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 Normally 'encoding' will be equal to your current locale. This will
3036 be the default if Vim recognizes your environment settings. If
3037 'encoding' is not set to the current locale, 'termencoding' must be
3038 set to convert typed and displayed text. See |encoding-table|.
3039
3040 When you set this option, it fires the |EncodingChanged| autocommand
3041 event so that you can set up fonts if necessary.
3042
3043 When the option is set, the value is converted to lowercase. Thus
3044 you can set it with uppercase values too. Underscores are translated
3045 to '-' signs.
3046 When the encoding is recognized, it is changed to the standard name.
3047 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3048 "iso-8859-2" and "utf8" becomes "utf-8".
3049
3050 Note: "latin1" is also used when the encoding could not be detected.
3051 This only works when editing files in the same encoding! When the
3052 actual character set is not latin1, make sure 'fileencoding' and
3053 'fileencodings' are empty. When conversion is needed, switch to using
3054 utf-8.
3055
3056 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3057 You don't notice this while editing, but it does matter for the
3058 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3059 setting 'encoding' to one of these values instead of utf-8 only has
3060 effect for encoding used for files when 'fileencoding' is empty.
3061
Bram Moolenaar661b1822005-07-28 22:36:45 +00003062 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3063 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003065 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003066'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003068 Indicates that a CTRL-Z character was found at the end of the file
3069 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003071 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003072 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003073 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003074
3075 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3076'endofline' 'eol' boolean (default on)
3077 local to buffer
3078 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003079 is on, or 'fixeol' option is off, no <EOL> will be written for the
3080 last line in the file. This option is automatically set or reset when
3081 starting to edit a new file, depending on whether file has an <EOL>
3082 for the last line in the file. Normally you don't have to set or
3083 reset this option.
3084 When 'binary' is off and 'fixeol' is on the value is not used when
3085 writing the file. When 'binary' is on or 'fixeol' is off it is used
3086 to remember the presence of a <EOL> for the last line in the file, so
3087 that when you write the file the situation from the original file can
3088 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003089 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090
3091 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3092'equalalways' 'ea' boolean (default on)
3093 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003095 splitting or closing a window. This also happens the moment the
3096 option is switched on. When off, splitting a window will reduce the
3097 size of the current window and leave the other windows the same. When
3098 closing a window the extra lines are given to the window next to it
3099 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 When mixing vertically and horizontally split windows, a minimal size
3101 is computed and some windows may be larger if there is room. The
3102 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003103 Changing the height and width of a window can be avoided by setting
3104 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003105 If a window size is specified when creating a new window sizes are
3106 currently not equalized (it's complicated, but may be implemented in
3107 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108
3109 *'equalprg'* *'ep'*
3110'equalprg' 'ep' string (default "")
3111 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003113 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003114 or 'indentexpr'. When Vim was compiled without internal formatting,
3115 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003116 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 about including spaces and backslashes.
3118 This option cannot be set from a |modeline| or in the |sandbox|, for
3119 security reasons.
3120
3121 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3122'errorbells' 'eb' boolean (default off)
3123 global
3124 Ring the bell (beep or screen flash) for error messages. This only
3125 makes a difference for error messages, the bell will be used always
3126 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003127 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003128 screen flash or do nothing. See 'belloff' to finetune when to ring the
3129 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130
3131 *'errorfile'* *'ef'*
3132'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3133 others: "errors.err")
3134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 {not available when compiled without the |+quickfix|
3136 feature}
3137 Name of the errorfile for the QuickFix mode (see |:cf|).
3138 When the "-q" command-line argument is used, 'errorfile' is set to the
3139 following argument. See |-q|.
3140 NOT used for the ":make" command. See 'makeef' for that.
3141 Environment variables are expanded |:set_env|.
3142 See |option-backslash| about including spaces and backslashes.
3143 This option cannot be set from a |modeline| or in the |sandbox|, for
3144 security reasons.
3145
3146 *'errorformat'* *'efm'*
3147'errorformat' 'efm' string (default is very long)
3148 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 {not available when compiled without the |+quickfix|
3150 feature}
3151 Scanf-like description of the format for the lines in the error file
3152 (see |errorformat|).
3153
3154 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3155'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 Function keys that start with an <Esc> are recognized in Insert
3158 mode. When this option is off, the cursor and function keys cannot be
3159 used in Insert mode if they start with an <Esc>. The advantage of
3160 this is that the single <Esc> is recognized immediately, instead of
3161 after one second. Instead of resetting this option, you might want to
3162 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3163 when 'esckeys' is off, you can still map anything, but the cursor keys
3164 won't work by default.
3165 NOTE: This option is set to the Vi default value when 'compatible' is
3166 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003167 NOTE: when this option is off then the |modifyOtherKeys| functionality
3168 is disabled while in Insert mode to avoid ending Insert mode with any
3169 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170
3171 *'eventignore'* *'ei'*
3172'eventignore' 'ei' string (default "")
3173 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003175 When set to "all" or when "all" is one of the items, all autocommand
3176 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003177 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 :set ei=WinEnter,WinLeave
3179<
3180 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3181'expandtab' 'et' boolean (default off)
3182 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003184 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3186 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003187 This option is reset when the 'paste' option is set and restored when
3188 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 NOTE: This option is reset when 'compatible' is set.
3190
3191 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3192'exrc' 'ex' boolean (default off)
3193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003195 directory.
3196
3197 Setting this option is a potential security leak. E.g., consider
3198 unpacking a package or fetching files from github, a .vimrc in there
3199 might be a trojan horse. BETTER NOT SET THIS OPTION!
3200 Instead, define an autocommand in your .vimrc to set options for a
3201 matching directory.
3202
3203 If you do switch this option on you should also consider setting the
3204 'secure' option (see |initialization|).
3205 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 This option cannot be set from a |modeline| or in the |sandbox|, for
3207 security reasons.
3208
3209 *'fileencoding'* *'fenc'* *E213*
3210'fileencoding' 'fenc' string (default: "")
3211 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003213
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003215 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 When 'fileencoding' is empty, the same value as 'encoding' will be
3217 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003218 No error will be given when the value is set, only when it is used,
3219 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003220 Conversion will also be done when 'encoding' and 'fileencoding' are
3221 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3222 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003224 'encoding' is "utf-8" or another Unicode encoding, conversion
3225 is most likely done in a way that the reverse conversion
3226 results in the same text. When 'encoding' is not "utf-8" some
3227 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003228
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 See 'encoding' for the possible values. Additionally, values may be
3230 specified that can be handled by the converter, see
3231 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003232
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 When reading a file 'fileencoding' will be set from 'fileencodings'.
3234 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003235 'fileencoding', use the |++enc| argument. One exception: when
3236 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003237 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003238
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3240 When the option is set, the value is converted to lowercase. Thus
3241 you can set it with uppercase values too. '_' characters are
3242 replaced with '-'. If a name is recognized from the list for
3243 'encoding', it is replaced by the standard name. For example
3244 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003245
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 When this option is set, after starting to edit a file, the 'modified'
3247 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003248
3249 Keep in mind that changing 'fenc' from a modeline happens
3250 AFTER the text has been read, thus it applies to when the file will be
3251 written. If you do set 'fenc' in a modeline, you might want to set
3252 'nomodified' to avoid not being able to ":q".
3253
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 This option can not be changed when 'modifiable' is off.
3255
3256 *'fe'*
3257 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003258 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 old short name was 'fe', which is no longer used.
3260
3261 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003262'fileencodings' 'fencs' string (default: "ucs-bom",
3263 "ucs-bom,utf-8,default,latin1" when
3264 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 This is a list of character encodings considered when starting to edit
3267 an existing file. When a file is read, Vim tries to use the first
3268 mentioned character encoding. If an error is detected, the next one
3269 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003270 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 an empty string, which means the value of 'encoding' is used.
3272 WARNING: Conversion can cause loss of information! When
3273 'encoding' is "utf-8" (or one of the other Unicode variants)
3274 conversion is most likely done in a way that the reverse
3275 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003276 "utf-8" some non-ASCII characters may be lost! You can use
3277 the |++bad| argument to specify what is done with characters
3278 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 For an empty file or a file with only ASCII characters most encodings
3280 will work and the first entry of 'fileencodings' will be used (except
3281 "ucs-bom", which requires the BOM to be present). If you prefer
3282 another encoding use an BufReadPost autocommand event to test if your
3283 preferred encoding is to be used. Example: >
3284 au BufReadPost * if search('\S', 'w') == 0 |
3285 \ set fenc=iso-2022-jp | endif
3286< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3287 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003288 When the |++enc| argument is used then the value of 'fileencodings' is
3289 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003290 Note that 'fileencodings' is not used for a new file, the global value
3291 of 'fileencoding' is used instead. You can set it with: >
3292 :setglobal fenc=iso-8859-2
3293< This means that a non-existing file may get a different encoding than
3294 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 The special value "ucs-bom" can be used to check for a Unicode BOM
3296 (Byte Order Mark) at the start of the file. It must not be preceded
3297 by "utf-8" or another Unicode encoding for this to work properly.
3298 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3299 because Vim cannot detect an error, thus the encoding is always
3300 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003301 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003302 environment. On MS-Windows this is the system encoding. Otherwise
3303 this is the default value for 'encoding'. It is useful when
3304 'encoding' is set to "utf-8" and your environment uses a non-latin1
3305 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003306 When 'encoding' is "utf-8" and a file contains an illegal byte
3307 sequence it won't be recognized as UTF-8. You can use the |8g8|
3308 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 WRONG VALUES: WHAT'S WRONG:
3310 latin1,utf-8 "latin1" will always be used
3311 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3312 file
3313 cp1250,latin1 "cp1250" will always be used
3314 If 'fileencodings' is empty, 'fileencoding' is not modified.
3315 See 'fileencoding' for the possible values.
3316 Setting this option does not have an effect until the next time a file
3317 is read.
3318
3319 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003320'fileformat' 'ff' string (MS-Windows default: "dos",
3321 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 This gives the <EOL> of the current buffer, which is used for
3324 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003325 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 unix <NL>
3327 mac <CR>
3328 When "dos" is used, CTRL-Z at the end of a file is ignored.
3329 See |file-formats| and |file-read|.
3330 For the character encoding of the file see 'fileencoding'.
3331 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003332 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 This option is set automatically when starting to edit a file and
3334 'fileformats' is not empty and 'binary' is off.
3335 When this option is set, after starting to edit a file, the 'modified'
3336 option is set, because the file would be different when written.
3337 This option can not be changed when 'modifiable' is off.
3338 For backwards compatibility: When this option is set to "dos",
3339 'textmode' is set, otherwise 'textmode' is reset.
3340
3341 *'fileformats'* *'ffs'*
3342'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003343 Vim+Vi MS-Windows: "dos,unix",
3344 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 Vi Cygwin: "unix,dos",
3346 Vi others: "")
3347 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 This gives the end-of-line (<EOL>) formats that will be tried when
3349 starting to edit a new buffer and when reading a file into an existing
3350 buffer:
3351 - When empty, the format defined with 'fileformat' will be used
3352 always. It is not set automatically.
3353 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003354 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 'fileformats' name will be used when a file is read into an existing
3356 buffer, no matter what 'fileformat' for that buffer is set to.
3357 - When more than one name is present, separated by commas, automatic
3358 <EOL> detection will be done when reading a file. When starting to
3359 edit a file, a check is done for the <EOL>:
3360 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3361 'fileformat' is set to "dos".
3362 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003363 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003365 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3366 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003367 This means that "mac" is only chosen when:
3368 "unix" is not present or no <NL> is found in the file, and
3369 "dos" is not present or no <CR><NL> is found in the file.
3370 Except: if "unix" was chosen, but there is a <CR> before
3371 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003372 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 4. If 'fileformat' is still not set, the first name from
3374 'fileformats' is used.
3375 When reading a file into an existing buffer, the same is done, but
3376 this happens like 'fileformat' has been set appropriately for that
3377 file only, the option is not changed.
3378 When 'binary' is set, the value of 'fileformats' is not used.
3379
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003380 When Vim starts up with an empty buffer the first item is used. You
3381 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003382
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3384 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3385 done:
3386 - When 'fileformats' is empty, there is no automatic detection. Dos
3387 format will be used.
3388 - When 'fileformats' is set to one or more names, automatic detection
3389 is done. This is based on the first <NL> in the file: If there is a
3390 <CR> in front of it, Dos format is used, otherwise Unix format is
3391 used.
3392 Also see |file-formats|.
3393 For backwards compatibility: When this option is set to an empty
3394 string or one format (no comma is included), 'textauto' is reset,
3395 otherwise 'textauto' is set.
3396 NOTE: This option is set to the Vi default value when 'compatible' is
3397 set and to the Vim default value when 'compatible' is reset.
3398
Bram Moolenaarbf884932013-04-05 22:26:15 +02003399 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3400'fileignorecase' 'fic' boolean (default on for systems where case in file
3401 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003402 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003403 When set case is ignored when using file names and directories.
3404 See 'wildignorecase' for only ignoring case when doing completion.
3405
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 *'filetype'* *'ft'*
3407'filetype' 'ft' string (default: "")
3408 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 When this option is set, the FileType autocommand event is triggered.
3410 All autocommands that match with the value of this option will be
3411 executed. Thus the value of 'filetype' is used in place of the file
3412 name.
3413 Otherwise this option does not always reflect the current file type.
3414 This option is normally set when the file type is detected. To enable
3415 this use the ":filetype on" command. |:filetype|
3416 Setting this option to a different value is most useful in a modeline,
3417 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003418 Example, for in an IDL file:
3419 /* vim: set filetype=idl : */ ~
3420 |FileType| |filetypes|
3421 When a dot appears in the value then this separates two filetype
3422 names. Example:
3423 /* vim: set filetype=c.doxygen : */ ~
3424 This will use the "c" filetype first, then the "doxygen" filetype.
3425 This works both for filetype plugins and for syntax files. More than
3426 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 This option is not copied to another buffer, independent of the 's' or
3428 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003429 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430
3431 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003432'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003433 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003434 {not available when compiled without the |+folding|
3435 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003436 Characters to fill the statuslines, vertical separators and special
3437 lines in the window.
3438 It is a comma-separated list of items. Each item has a name, a colon
3439 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003441 item name default Used for ~
3442 stl ' ' or '^' statusline of the current window
3443 stlnc ' ' or '=' statusline of the non-current windows
3444 vert '|' vertical separators |:vsplit|
3445 fold '-' filling 'foldtext'
3446 foldopen '-' mark the beginning of a fold
3447 foldclose '+' show a closed fold
3448 foldsep '|' open fold middle character
3449 diff '-' deleted lines of the 'diff' option
3450 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003451 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003453 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003454 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 otherwise.
3456
3457 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003458 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459< This is similar to the default, except that these characters will also
3460 be used when there is highlighting.
3461
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003462 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3463 single-byte and multibyte characters are supported. But double-width
3464 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003465
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003467 item name highlight group ~
3468 stl StatusLine |hl-StatusLine|
3469 stlnc StatusLineNC |hl-StatusLineNC|
3470 vert VertSplit |hl-VertSplit|
3471 fold Folded |hl-Folded|
3472 diff DiffDelete |hl-DiffDelete|
3473 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003474 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003476 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3477'fixendofline' 'fixeol' boolean (default on)
3478 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003479 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003480 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003481 preserve the situation from the original file.
3482 When the 'binary' option is set the value of this option doesn't
3483 matter.
3484 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003485 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003486
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003488'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 {only available when compiled with the |+rightleft|
3491 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003492 This option was for using Farsi, which has been removed. See
3493 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494
3495 *'foldclose'* *'fcl'*
3496'foldclose' 'fcl' string (default "")
3497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 {not available when compiled without the |+folding|
3499 feature}
3500 When set to "all", a fold is closed when the cursor isn't in it and
3501 its level is higher than 'foldlevel'. Useful if you want folds to
3502 automatically close when moving out of them.
3503
3504 *'foldcolumn'* *'fdc'*
3505'foldcolumn' 'fdc' number (default 0)
3506 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 {not available when compiled without the |+folding|
3508 feature}
3509 When non-zero, a column with the specified width is shown at the side
3510 of the window which indicates open and closed folds. The maximum
3511 value is 12.
3512 See |folding|.
3513
3514 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3515'foldenable' 'fen' boolean (default on)
3516 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 {not available when compiled without the |+folding|
3518 feature}
3519 When off, all folds are open. This option can be used to quickly
3520 switch between showing all text unfolded and viewing the text with
3521 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003522 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 'foldenable' is off.
3524 This option is set by commands that create a new fold or close a fold.
3525 See |folding|.
3526
3527 *'foldexpr'* *'fde'*
3528'foldexpr' 'fde' string (default: "0")
3529 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003531 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003533 for each line to obtain its fold level. The context is set to the
3534 script where 'foldexpr' was set, script-local items can be accessed.
3535 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003536
Bram Moolenaar30b65812012-07-12 22:01:11 +02003537 The expression will be evaluated in the |sandbox| if set from a
3538 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003539 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003540 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003541
3542 It is not allowed to change text or jump to another window while
3543 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544
3545 *'foldignore'* *'fdi'*
3546'foldignore' 'fdi' string (default: "#")
3547 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 {not available when compiled without the |+folding|
3549 feature}
3550 Used only when 'foldmethod' is "indent". Lines starting with
3551 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003552 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 The default "#" works well for C programs. See |fold-indent|.
3554
3555 *'foldlevel'* *'fdl'*
3556'foldlevel' 'fdl' number (default: 0)
3557 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 {not available when compiled without the |+folding|
3559 feature}
3560 Sets the fold level: Folds with a higher level will be closed.
3561 Setting this option to zero will close all folds. Higher numbers will
3562 close fewer folds.
3563 This option is set by commands like |zm|, |zM| and |zR|.
3564 See |fold-foldlevel|.
3565
3566 *'foldlevelstart'* *'fdls'*
3567'foldlevelstart' 'fdls' number (default: -1)
3568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 {not available when compiled without the |+folding|
3570 feature}
3571 Sets 'foldlevel' when starting to edit another buffer in a window.
3572 Useful to always start editing with all folds closed (value zero),
3573 some folds closed (one) or no folds closed (99).
3574 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003575 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 ignores this option and closes all folds.
3577 It is also done before BufReadPre autocommands, to allow an autocmd to
3578 overrule the 'foldlevel' value for specific files.
3579 When the value is negative, it is not used.
3580
3581 *'foldmarker'* *'fmr'* *E536*
3582'foldmarker' 'fmr' string (default: "{{{,}}}")
3583 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 {not available when compiled without the |+folding|
3585 feature}
3586 The start and end marker used when 'foldmethod' is "marker". There
3587 must be one comma, which separates the start and end marker. The
3588 marker is a literal string (a regular expression would be too slow).
3589 See |fold-marker|.
3590
3591 *'foldmethod'* *'fdm'*
3592'foldmethod' 'fdm' string (default: "manual")
3593 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 {not available when compiled without the |+folding|
3595 feature}
3596 The kind of folding used for the current window. Possible values:
3597 |fold-manual| manual Folds are created manually.
3598 |fold-indent| indent Lines with equal indent form a fold.
3599 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3600 |fold-marker| marker Markers are used to specify folds.
3601 |fold-syntax| syntax Syntax highlighting items specify folds.
3602 |fold-diff| diff Fold text that is not changed.
3603
3604 *'foldminlines'* *'fml'*
3605'foldminlines' 'fml' number (default: 1)
3606 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 {not available when compiled without the |+folding|
3608 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003609 Sets the number of screen lines above which a fold can be displayed
3610 closed. Also for manually closed folds. With the default value of
3611 one a fold can only be closed if it takes up two or more screen lines.
3612 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003613 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 "zc" to close a fold, which is displayed open because it's smaller
3615 than 'foldminlines', a following "zc" may close a containing fold.
3616
3617 *'foldnestmax'* *'fdn'*
3618'foldnestmax' 'fdn' number (default: 20)
3619 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 {not available when compiled without the |+folding|
3621 feature}
3622 Sets the maximum nesting of folds for the "indent" and "syntax"
3623 methods. This avoids that too many folds will be created. Using more
3624 than 20 doesn't work, because the internal limit is 20.
3625
3626 *'foldopen'* *'fdo'*
3627'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3628 search,tag,undo")
3629 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 {not available when compiled without the |+folding|
3631 feature}
3632 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003633 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003635 NOTE: When the command is part of a mapping this option is not used.
3636 Add the |zv| command to the mapping to get the same effect.
3637 (rationale: the mapping may want to control opening folds itself)
3638
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 item commands ~
3640 all any
3641 block "(", "{", "[[", "[{", etc.
3642 hor horizontal movements: "l", "w", "fx", etc.
3643 insert any command in Insert mode
3644 jump far jumps: "G", "gg", etc.
3645 mark jumping to a mark: "'m", CTRL-O, etc.
3646 percent "%"
3647 quickfix ":cn", ":crew", ":make", etc.
3648 search search for a pattern: "/", "n", "*", "gd", etc.
3649 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003650 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 tag jumping to a tag: ":ta", CTRL-T, etc.
3652 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 When a movement command is used for an operator (e.g., "dl" or "y%")
3654 this option is not used. This means the operator will include the
3655 whole closed fold.
3656 Note that vertical movements are not here, because it would make it
3657 very difficult to move onto a closed fold.
3658 In insert mode the folds containing the cursor will always be open
3659 when text is inserted.
3660 To close folds you can re-apply 'foldlevel' with the |zx| command or
3661 set the 'foldclose' option to "all".
3662
3663 *'foldtext'* *'fdt'*
3664'foldtext' 'fdt' string (default: "foldtext()")
3665 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 {not available when compiled without the |+folding|
3667 feature}
3668 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003669 fold. The context is set to the script where 'foldexpr' was set,
3670 script-local items can be accessed. See |fold-foldtext| for the
3671 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672
Bram Moolenaar30b65812012-07-12 22:01:11 +02003673 The expression will be evaluated in the |sandbox| if set from a
3674 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003675 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003676
3677 It is not allowed to change text or jump to another window while
3678 evaluating 'foldtext' |textlock|.
3679
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003680 *'formatexpr'* *'fex'*
3681'formatexpr' 'fex' string (default "")
3682 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003683 {not available when compiled without the |+eval|
3684 feature}
3685 Expression which is evaluated to format a range of lines for the |gq|
3686 operator or automatic formatting (see 'formatoptions'). When this
3687 option is empty 'formatprg' is used.
3688
3689 The |v:lnum| variable holds the first line to be formatted.
3690 The |v:count| variable holds the number of lines to be formatted.
3691 The |v:char| variable holds the character that is going to be
3692 inserted if the expression is being evaluated due to
3693 automatic formatting. This can be empty. Don't insert
3694 it yet!
3695
3696 Example: >
3697 :set formatexpr=mylang#Format()
3698< This will invoke the mylang#Format() function in the
3699 autoload/mylang.vim file in 'runtimepath'. |autoload|
3700
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003701 The advantage of using a function call without arguments is that it is
3702 faster, see |expr-option-function|.
3703
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003704 The expression is also evaluated when 'textwidth' is set and adding
3705 text beyond that limit. This happens under the same conditions as
3706 when internal formatting is used. Make sure the cursor is kept in the
3707 same spot relative to the text then! The |mode()| function will
3708 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003709
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003710 When the expression evaluates to non-zero Vim will fall back to using
3711 the internal format mechanism.
3712
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003713 If the expression starts with s: or |<SID>|, then it is replaced with
3714 the script ID (|local-function|). Example: >
3715 set formatexpr=s:MyFormatExpr()
3716 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003717< Otherwise, the expression is evaluated in the context of the script
3718 where the option was set, thus script-local items are available.
3719
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003720 The expression will be evaluated in the |sandbox| when set from a
3721 modeline, see |sandbox-option|. That stops the option from working,
3722 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003723 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003724 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003725
Bram Moolenaar86b68352004-12-27 21:59:20 +00003726 *'formatlistpat'* *'flp'*
3727'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3728 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003729 A pattern that is used to recognize a list header. This is used for
3730 the "n" flag in 'formatoptions'.
3731 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003732 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003733 while still checking more characters. There must be a character
3734 following the pattern, when it matches the whole line it is handled
3735 like there is no match.
3736 The default recognizes a number, followed by an optional punctuation
3737 character and white space.
3738
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003739 *'formatoptions'* *'fo'*
3740'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3741 local to buffer
3742 This is a sequence of letters which describes how automatic
3743 formatting is to be done. See |fo-table|. When the 'paste' option is
3744 on, no formatting is done (like 'formatoptions' is empty). Commas can
3745 be inserted for readability.
3746 To avoid problems with flags that are added in the future, use the
3747 "+=" and "-=" feature of ":set" |add-option-flags|.
3748 NOTE: This option is set to the Vi default value when 'compatible' is
3749 set and to the Vim default value when 'compatible' is reset.
3750
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 *'formatprg'* *'fp'*
3752'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003753 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003755 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003757 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003758 If the 'formatexpr' option is not empty it will be used instead.
3759 Otherwise, if 'formatprg' option is an empty string, the internal
3760 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003761 Environment variables are expanded |:set_env|. See |option-backslash|
3762 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003763 This option cannot be set from a |modeline| or in the |sandbox|, for
3764 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765
Bram Moolenaard94464e2015-11-02 15:28:18 +01003766 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003767'fsync' 'fs' boolean (default on)
3768 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003769 When on, the library function fsync() will be called after writing a
3770 file. This will flush a file to disk, ensuring that it is safely
3771 written even on filesystems which do metadata-only journaling. This
3772 will force the harddrive to spin up on Linux systems running in laptop
3773 mode, so it may be undesirable in some situations. Be warned that
3774 turning this off increases the chances of data loss after a crash. On
3775 systems without an fsync() implementation, this variable is always
3776 off.
3777 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003778 'fsync' also applies to |writefile()| (unless a flag is used to
3779 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003780 This option cannot be set from a |modeline| or in the |sandbox|, for
3781 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003782
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3784'gdefault' 'gd' boolean (default off)
3785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 When on, the ":substitute" flag 'g' is default on. This means that
3787 all matches in a line are substituted instead of one. When a 'g' flag
3788 is given to a ":substitute" command, this will toggle the substitution
3789 of all or one match. See |complex-change|.
3790
3791 command 'gdefault' on 'gdefault' off ~
3792 :s/// subst. all subst. one
3793 :s///g subst. one subst. all
3794 :s///gg subst. all subst. one
3795
3796 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003797 DEPRECATED: Setting this option may break plugins that are not aware
3798 of this option. Also, many users get confused that adding the /g flag
3799 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003800 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801
3802 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003803'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 Format to recognize for the ":grep" command output.
3806 This is a scanf-like string that uses the same format as the
3807 'errorformat' option: see |errorformat|.
3808
3809 *'grepprg'* *'gp'*
3810'grepprg' 'gp' string (default "grep -n ",
3811 Unix: "grep -n $* /dev/null",
3812 Win32: "findstr /n" or "grep -n",
3813 VMS: "SEARCH/NUMBERS ")
3814 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003815 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 and '#' characters, which are expanded like when used in a command-
3817 line. The placeholder "$*" is allowed to specify where the arguments
3818 will be included. Environment variables are expanded |:set_env|. See
3819 |option-backslash| about including spaces and backslashes.
3820 When your "grep" accepts the "-H" argument, use this to make ":grep"
3821 also work well with a single file: >
3822 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003823< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003824 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3825 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003826 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 apply equally to 'grepprg'.
3828 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3829 otherwise it's "grep -n".
3830 This option cannot be set from a |modeline| or in the |sandbox|, for
3831 security reasons.
3832
3833 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3834'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3835 ve:ver35-Cursor,
3836 o:hor50-Cursor,
3837 i-ci:ver25-Cursor/lCursor,
3838 r-cr:hor20-Cursor/lCursor,
3839 sm:block-Cursor
3840 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003841 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 "n-v-c:block,o:hor50,i-ci:hor15,
3843 r-cr:hor30,sm:block")
3844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003846 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003848 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003849 height of the cursor can be changed. This can be done by specifying a
3850 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003851 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3852 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003854 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 mode-list and an argument-list:
3856 mode-list:argument-list,mode-list:argument-list,..
3857 The mode-list is a dash separated list of these modes:
3858 n Normal mode
3859 v Visual mode
3860 ve Visual mode with 'selection' "exclusive" (same as 'v',
3861 if not specified)
3862 o Operator-pending mode
3863 i Insert mode
3864 r Replace mode
3865 c Command-line Normal (append) mode
3866 ci Command-line Insert mode
3867 cr Command-line Replace mode
3868 sm showmatch in Insert mode
3869 a all modes
3870 The argument-list is a dash separated list of these arguments:
3871 hor{N} horizontal bar, {N} percent of the character height
3872 ver{N} vertical bar, {N} percent of the character width
3873 block block cursor, fills the whole character
3874 [only one of the above three should be present]
3875 blinkwait{N} *cursor-blinking*
3876 blinkon{N}
3877 blinkoff{N}
3878 blink times for cursor: blinkwait is the delay before
3879 the cursor starts blinking, blinkon is the time that
3880 the cursor is shown and blinkoff is the time that the
3881 cursor is not shown. The times are in msec. When one
3882 of the numbers is zero, there is no blinking. The
3883 default is: "blinkwait700-blinkon400-blinkoff250".
3884 These numbers are used for a missing entry. This
3885 means that blinking is enabled by default. To switch
3886 blinking off you can use "blinkon0". The cursor only
3887 blinks when Vim is waiting for input, not while
3888 executing a command.
3889 To make the cursor blink in an xterm, see
3890 |xterm-blink|.
3891 {group-name}
3892 a highlight group name, that sets the color and font
3893 for the cursor
3894 {group-name}/{group-name}
3895 Two highlight group names, the first is used when
3896 no language mappings are used, the other when they
3897 are. |language-mapping|
3898
3899 Examples of parts:
3900 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3901 block cursor with colors from the "nCursor"
3902 highlight group
3903 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3904 In Insert and Command-line Insert mode, use a
3905 30% vertical bar cursor with colors from the
3906 "iCursor" highlight group. Blink a bit
3907 faster.
3908
3909 The 'a' mode is different. It will set the given argument-list for
3910 all modes. It does not reset anything to defaults. This can be used
3911 to do a common setting for all modes. For example, to switch off
3912 blinking: "a:blinkon0"
3913
3914 Examples of cursor highlighting: >
3915 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3916 :highlight Cursor gui=NONE guifg=bg guibg=fg
3917<
3918 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003919 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920'guifont' 'gfn' string (default "")
3921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 {only available when compiled with GUI enabled}
3923 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003924 In its simplest form the value is just one font name.
3925 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926
3927 *'guifontset'* *'gfs'*
3928 *E250* *E252* *E234* *E597* *E598*
3929'guifontset' 'gfs' string (default "")
3930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 {only available when compiled with GUI enabled and
3932 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003933 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 When not empty, specifies two (or more) fonts to be used. The first
3935 one for normal English, the second one for your special language. See
3936 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003937
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3939'guifontwide' 'gfw' string (default "")
3940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 {only available when compiled with GUI enabled}
3942 When not empty, specifies a comma-separated list of fonts to be used
3943 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003944 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003945
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 *'guiheadroom'* *'ghr'*
3947'guiheadroom' 'ghr' number (default 50)
3948 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003949 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 The number of pixels subtracted from the screen height when fitting
3951 the GUI window on the screen. Set this before the GUI is started,
3952 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003953 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 lines will be left for window decorations and other items on the
3955 screen. Set it to a negative value to allow windows taller than the
3956 screen.
3957
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003958 *'guiligatures'* *'gli'* *E1243*
3959'guiligatures' 'gli' string (default "")
3960 global
3961 {only for GTK GUI}
3962 List of ASCII characters that, when combined together, can create more
3963 complex shapes. Each character must be a printable ASCII character
3964 with a value in the 32-127 range.
3965 Example: >
3966 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3967< Changing this option updates screen output immediately. Set it to an
3968 empty string to disable ligatures.
3969
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003971'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3972 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003973 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003974 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003977 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 sequence of letters which describes what components and options of the
3979 GUI should be used.
3980 To avoid problems with flags that are added in the future, use the
3981 "+=" and "-=" feature of ":set" |add-option-flags|.
3982
Bram Moolenaar13568252018-03-16 20:46:58 +01003983 Valid characters are as follows:
3984 *'go-!'*
3985 '!' External commands are executed in a terminal window. Without
3986 this flag the MS-Windows GUI will open a console window to
3987 execute the command. The Unix GUI will simulate a dumb
3988 terminal to list the command output.
3989 The terminal window will be positioned at the bottom, and grow
3990 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003991 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 'a' Autoselect: If present, then whenever VISUAL mode is started,
3993 or the Visual area extended, Vim tries to become the owner of
3994 the windowing system's global selection. This means that the
3995 Visually highlighted text is available for pasting into other
3996 applications as well as into Vim itself. When the Visual mode
3997 ends, possibly due to an operation on the text, or when an
3998 application wants to paste the selection, the highlighted text
3999 is automatically yanked into the "* selection register.
4000 Thus the selection is still available for pasting into other
4001 applications after the VISUAL mode has ended.
4002 If not present, then Vim won't become the owner of the
4003 windowing system's global selection unless explicitly told to
4004 by a yank or delete operation for the "* register.
4005 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004006 *'go-P'*
4007 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004008 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004009 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004010 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 applies to the modeless selection.
4012
4013 'guioptions' autoselect Visual autoselect modeless ~
4014 "" - -
4015 "a" yes yes
4016 "A" - yes
4017 "aA" yes yes
4018
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004019 When using a terminal see the 'clipboard' option.
4020
Bram Moolenaar02467872007-05-06 13:22:01 +00004021 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 'c' Use console dialogs instead of popup dialogs for simple
4023 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004024 *'go-d'*
4025 'd' Use dark theme variant if available. Currently only works for
4026 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004027 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004028 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004029 'guitablabel' can be used to change the text in the labels.
4030 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004031 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004032 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004033 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 'f' Foreground: Don't use fork() to detach the GUI from the shell
4035 where it was started. Use this for programs that wait for the
4036 editor to finish (e.g., an e-mail program). Alternatively you
4037 can use "gvim -f" or ":gui -f" to start the GUI in the
4038 foreground. |gui-fork|
4039 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004040 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004041 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4043 corner of the window. It's black&white on non-GTK, because of
4044 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004045 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004047 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004048 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004050 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004052 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004053 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 'g' Grey menu items: Make menu items that are not active grey. If
4055 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004056 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 't' Include tearoff menu items. Currently only works for Win32,
4058 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004059 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004060 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4061 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004062 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004064 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 'R' Right-hand scrollbar is present when there is a vertically
4066 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004067 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004069 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 'L' Left-hand scrollbar is present when there is a vertically
4071 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004072 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4074 the longest visible line, or on the cursor line if the 'h'
4075 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004076 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 'h' Limit horizontal scrollbar size to the length of the cursor
4078 line. Reduces computations. |gui-horiz-scroll|
4079
4080 And yes, you may even have scrollbars on the left AND the right if
4081 you really want to :-). See |gui-scrollbars| for more information.
4082
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004083 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 'v' Use a vertical button layout for dialogs. When not included,
4085 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004086 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004087 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 'p' Use Pointer callbacks for X11 GUI. This is required for some
4089 window managers. If the cursor is not blinking or hollow at
4090 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004091 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004093 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004094 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004095 *'go-k'*
4096 'k' Keep the GUI window size when adding/removing a scrollbar, or
4097 toolbar, tabline, etc. Instead, the behavior is similar to
4098 when the window is maximized and will adjust 'lines' and
4099 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004100 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004101 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004102
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 *'guipty'* *'noguipty'*
4104'guipty' boolean (default on)
4105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 {only available when compiled with GUI enabled}
4107 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4108 I/O to/from shell commands. See |gui-pty|.
4109
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004110 *'guitablabel'* *'gtl'*
4111'guitablabel' 'gtl' string (default empty)
4112 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004113 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004114 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004115 pages line. When empty and when the result is empty Vim will use a
4116 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004117
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004118 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004119 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004120 The expression will be evaluated in the |sandbox| when set from a
4121 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004122 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004123
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004124 Only used when the GUI tab pages line is displayed. 'e' must be
4125 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4126 used.
4127
Bram Moolenaar57657d82006-04-21 22:12:41 +00004128 *'guitabtooltip'* *'gtt'*
4129'guitabtooltip' 'gtt' string (default empty)
4130 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004131 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004132 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004133 pages line. When empty Vim will use a default tooltip.
4134 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004135 You can include a line break. Simplest method is to use |:let|: >
4136 :let &guitabtooltip = "line one\nline two"
4137<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004138
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004140'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 (others) "$VIMRUNTIME/doc/help.txt")
4142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 Name of the main help file. All distributed help files should be
4144 placed together in one directory. Additionally, all "doc" directories
4145 in 'runtimepath' will be used.
4146 Environment variables are expanded |:set_env|. For example:
4147 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004148 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 spaces and backslashes.
4150 This option cannot be set from a |modeline| or in the |sandbox|, for
4151 security reasons.
4152
4153 *'helpheight'* *'hh'*
4154'helpheight' 'hh' number (default 20)
4155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 Minimal initial height of the help window when it is opened with the
4157 ":help" command. The initial height of the help window is half of the
4158 current window, or (when the 'ea' option is on) the same as other
4159 windows. When the height is less than 'helpheight', the height is
4160 set to 'helpheight'. Set to zero to disable.
4161
4162 *'helplang'* *'hlg'*
4163'helplang' 'hlg' string (default: messages language or empty)
4164 global
4165 {only available when compiled with the |+multi_lang|
4166 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004167 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 for which the desired help can be found. The English help will always
4169 be used as a last resort. You can add "en" to prefer English over
4170 another language, but that will only find tags that exist in that
4171 language and not in the English help.
4172 Example: >
4173 :set helplang=de,it
4174< This will first search German, then Italian and finally English help
4175 files.
4176 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4177 try to find the tag in the current language before using this option.
4178 See |help-translated|.
4179
4180 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4181'hidden' 'hid' boolean (default off)
4182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 When off a buffer is unloaded when it is |abandon|ed. When on a
4184 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4185 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004186
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004188 hidden even if the 'hidden' option is off when these three are true:
4189 - the buffer is modified
4190 - 'autowrite' is off or writing is not possible
4191 - the '!' flag was used
4192 Also see |windows.txt|.
4193
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004194 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 This option is set for one command with ":hide {command}" |:hide|.
4196 WARNING: It's easy to forget that you have changes in hidden buffers.
4197 Think twice when using ":q!" or ":qa!".
4198
4199 *'highlight'* *'hl'*
4200'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004201 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4202 d:Directory,e:ErrorMsg,i:IncSearch,
4203 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004204 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004205 N:CursorLineNr,r:Question,s:StatusLine,
4206 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004207 v:Visual,V:VisualNOS,w:WarningMsg,
4208 W:WildMenu,f:Folded,F:FoldColumn,
4209 A:DiffAdd,C:DiffChange,D:DiffDelete,
4210 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004211 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004212 L:SpellLocal,+:Pmenu,=:PmenuSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004213 [:PmenuKind,]:PmenuKindSel,
4214 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004215 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4216 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004217 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004218 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004221 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004223 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004225 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4226 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 characters from 'showbreak'
4228 |hl-Directory| d directories in CTRL-D listing and other special
4229 things in listings
4230 |hl-ErrorMsg| e error messages
4231 h (obsolete, ignored)
4232 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004233 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4235 |hl-MoreMsg| m |more-prompt|
4236 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004237 |hl-LineNr| n line number for ":number" and ":#" commands, and
4238 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004239 |hl-LineNrAbove| a line number above the cursor for when the
4240 'relativenumber' option is set.
4241 |hl-LineNrBelow| b line number below the cursor for when the
4242 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004243 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4244 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 |hl-Question| r |hit-enter| prompt and yes/no questions
4246 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004247 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4249 |hl-VertSplit| c column used to separate vertically split windows
4250 |hl-Visual| v Visual mode
4251 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4252 Selection" Only X11 Gui's |gui-x11| and
4253 |xterm-clipboard|.
4254 |hl-WarningMsg| w warning messages
4255 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4256 |hl-Folded| f line used for closed folds
4257 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004258 |hl-DiffAdd| A added line in diff mode
4259 |hl-DiffChange| C changed line in diff mode
4260 |hl-DiffDelete| D deleted line in diff mode
4261 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004263 |hl-Conceal| - the placeholders used for concealed characters
4264 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004265 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004266 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004267 |hl-SpellRare| R rare word |spell|
4268 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004269 |hl-Pmenu| + popup menu normal line
4270 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004271 |hl-PmenuKind| [ popup menu "kind" normal line
4272 |hl-PmenuKindSel| ] popup menu "kind" selected line
4273 |hl-PmenuExtra| { popup menu "kind" normal line
4274 |hl-PmenuExtraSel| } popup menu "kind" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004275 |hl-PmenuSbar| x popup menu scrollbar
4276 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277
4278 The display modes are:
4279 r reverse (termcap entry "mr" and "me")
4280 i italic (termcap entry "ZH" and "ZR")
4281 b bold (termcap entry "md" and "me")
4282 s standout (termcap entry "so" and "se")
4283 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004284 c undercurl (termcap entry "Us" and "Ce")
4285 2 double underline (termcap entry "Ds" and "Ce")
4286 d dotted underline (termcap entry "ds" and "Ce")
4287 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004288 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 n no highlighting
4290 - no highlighting
4291 : use a highlight group
4292 The default is used for occasions that are not included.
4293 If you want to change what the display modes do, see |dos-colors|
4294 for an example.
4295 When using the ':' display mode, this must be followed by the name of
4296 a highlight group. A highlight group can be used to define any type
4297 of highlighting, including using color. See |:highlight| on how to
4298 define one. The default uses a different group for each occasion.
4299 See |highlight-default| for the default highlight groups.
4300
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004302'history' 'hi' number (Vim default: 50, Vi default: 0,
4303 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004306 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004308 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 NOTE: This option is set to the Vi default value when 'compatible' is
4310 set and to the Vim default value when 'compatible' is reset.
4311
4312 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4313'hkmap' 'hk' boolean (default off)
4314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 {only available when compiled with the |+rightleft|
4316 feature}
4317 When on, the keyboard is mapped for the Hebrew character set.
4318 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4319 toggle this option. See |rileft.txt|.
4320 NOTE: This option is reset when 'compatible' is set.
4321
4322 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4323'hkmapp' 'hkp' boolean (default off)
4324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 {only available when compiled with the |+rightleft|
4326 feature}
4327 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4328 This is useful if you have a non-Hebrew keyboard.
4329 See |rileft.txt|.
4330 NOTE: This option is reset when 'compatible' is set.
4331
Bram Moolenaar036986f2017-03-16 17:41:02 +01004332 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4333'hlsearch' 'hls' boolean (default off)
4334 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004335 {not available when compiled without the
4336 |+extra_search| feature}
4337 When there is a previous search pattern, highlight all its matches.
4338 The type of highlighting used can be set with the 'l' occasion in the
4339 'highlight' option. This uses the "Search" highlight group by
4340 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004341 are not applied. If the "CurSearch" highlight group is set then the
4342 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004343 See also: 'incsearch' and |:match|.
4344 When you get bored looking at the highlighted matches, you can turn it
4345 off with |:nohlsearch|. This does not change the option value, as
4346 soon as you use a search command, the highlighting comes back.
4347 'redrawtime' specifies the maximum time spent on finding matches.
4348 When the search pattern can match an end-of-line, Vim will try to
4349 highlight all of the matched text. However, this depends on where the
4350 search starts. This will be the first line in the window or the first
4351 line below a closed fold. A match in a previous line which is not
4352 drawn may not continue in a newly drawn line.
4353 You can specify whether the highlight status is restored on startup
4354 with the 'h' flag in 'viminfo' |viminfo-h|.
4355 NOTE: This option is reset when 'compatible' is set.
4356
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 *'icon'* *'noicon'*
4358'icon' boolean (default off, on when title can be restored)
4359 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 When on, the icon text of the window will be set to the value of
4361 'iconstring' (if it is not empty), or to the name of the file
4362 currently being edited. Only the last part of the name is used.
4363 Overridden by the 'iconstring' option.
4364 Only works if the terminal supports setting window icons (currently
4365 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4366 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4367 builtin termcap).
4368 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004369 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004371 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372
4373 *'iconstring'*
4374'iconstring' string (default "")
4375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 When this option is not empty, it will be used for the icon text of
4377 the window. This happens only when the 'icon' option is on.
4378 Only works if the terminal supports setting window icon text
4379 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004380 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 When Vim was compiled with HAVE_X11 defined, the original icon will be
4382 restored if possible |X11|.
4383 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004384 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004386 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 {not available when compiled without the |+statusline| feature}
4388
4389 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4390'ignorecase' 'ic' boolean (default off)
4391 global
4392 Ignore case in search patterns. Also used when searching in the tags
4393 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004394 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 Can be overruled by using "\c" or "\C" in the pattern, see
4396 |/ignorecase|.
4397
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004398 *'imactivatefunc'* *'imaf'*
4399'imactivatefunc' 'imaf' string (default "")
4400 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004401 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004402 activate or deactivate the Input Method. The value can be the name of
4403 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4404 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004405 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004406 The expression will be evaluated in the |sandbox| when set from a
4407 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004408
4409 Example: >
4410 function ImActivateFunc(active)
4411 if a:active
4412 ... do something
4413 else
4414 ... do something
4415 endif
4416 " return value is not used
4417 endfunction
4418 set imactivatefunc=ImActivateFunc
4419<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 *'imactivatekey'* *'imak'*
4421'imactivatekey' 'imak' string (default "")
4422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004424 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 Specifies the key that your Input Method in X-Windows uses for
4426 activation. When this is specified correctly, vim can fully control
4427 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4428 You can't use this option to change the activation key, the option
4429 tells Vim what the key is.
4430 Format:
4431 [MODIFIER_FLAG-]KEY_STRING
4432
4433 These characters can be used for MODIFIER_FLAG (case is ignored):
4434 S Shift key
4435 L Lock key
4436 C Control key
4437 1 Mod1 key
4438 2 Mod2 key
4439 3 Mod3 key
4440 4 Mod4 key
4441 5 Mod5 key
4442 Combinations are allowed, for example "S-C-space" or "SC-space" are
4443 both shift+ctrl+space.
4444 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4445
4446 Example: >
4447 :set imactivatekey=S-space
4448< "S-space" means shift+space. This is the activation key for kinput2 +
4449 canna (Japanese), and ami (Korean).
4450
4451 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4452'imcmdline' 'imc' boolean (default off)
4453 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 When set the Input Method is always on when starting to edit a command
4455 line, unless entering a search pattern (see 'imsearch' for that).
4456 Setting this option is useful when your input method allows entering
4457 English characters directly, e.g., when it's used to type accented
4458 characters with dead keys.
4459
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004460 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 When set the Input Method is never used. This is useful to disable
4464 the IM when it doesn't work properly.
4465 Currently this option is on by default for SGI/IRIX machines. This
4466 may change in later releases.
4467
4468 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004469'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 Specifies whether :lmap or an Input Method (IM) is to be used in
4472 Insert mode. Valid values:
4473 0 :lmap is off and IM is off
4474 1 :lmap is ON and IM is off
4475 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 To always reset the option to zero when leaving Insert mode with <Esc>
4477 this can be used: >
4478 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4479< This makes :lmap and IM turn off automatically when leaving Insert
4480 mode.
4481 Note that this option changes when using CTRL-^ in Insert mode
4482 |i_CTRL-^|.
4483 The value is set to 1 when setting 'keymap' to a valid keymap name.
4484 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004485 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 methods. Use 'imdisable' to disable XIM then.
4487
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004488 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004489 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004490 |+multi_byte_ime| or |global-ime|.
4491
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004493'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 Specifies whether :lmap or an Input Method (IM) is to be used when
4496 entering a search pattern. Valid values:
4497 -1 the value of 'iminsert' is used, makes it look like
4498 'iminsert' is also used when typing a search pattern
4499 0 :lmap is off and IM is off
4500 1 :lmap is ON and IM is off
4501 2 :lmap is off and IM is ON
4502 Note that this option changes when using CTRL-^ in Command-line mode
4503 |c_CTRL-^|.
4504 The value is set to 1 when it is not -1 and setting the 'keymap'
4505 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004506 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 methods. Use 'imdisable' to disable XIM then.
4508
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004509 *'imstatusfunc'* *'imsf'*
4510'imstatusfunc' 'imsf' string (default "")
4511 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004512 This option specifies a function that is called to obtain the status
4513 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004514 The value can be the name of a function, a |lambda| or a |Funcref|.
4515 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004516 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004517
4518 Example: >
4519 function ImStatusFunc()
4520 let is_active = ...do something
4521 return is_active ? 1 : 0
4522 endfunction
4523 set imstatusfunc=ImStatusFunc
4524<
4525 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004526 The expression will be evaluated in the |sandbox| when set from a
4527 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004528
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004529 *'imstyle'* *'imst'*
4530'imstyle' 'imst' number (default 1)
4531 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004532 {only available when compiled with |+xim| and
4533 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004534 This option specifies the input style of Input Method:
4535 0 use on-the-spot style
4536 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004537 See: |xim-input-style|
4538
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004539 For a long time on-the-spot style had been used in the GTK version of
4540 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004541 |single-repeat|, etc. Therefore over-the-spot style becomes the
4542 default now. This should work fine for most people, however if you
4543 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004544 The expression will be evaluated in the |sandbox| when set from a
4545 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004546
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 *'include'* *'inc'*
4548'include' 'inc' string (default "^\s*#\s*include")
4549 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 {not available when compiled without the
4551 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004552 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 pattern, just like for the "/" command (See |pattern|). The default
4554 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004555 "]I", "[d", etc.
4556 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004557 comes after the matched pattern. But if "\zs" appears in the pattern
4558 then the text matched from "\zs" to the end, or until "\ze" if it
4559 appears, is used as the file name. Use this to include characters
4560 that are not in 'isfname', such as a space. You can then use
4561 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004562 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563
4564 *'includeexpr'* *'inex'*
4565'includeexpr' 'inex' string (default "")
4566 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004568 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004570 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004571 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004573 Note the double backslash: the `:set` command first halves them, then
4574 one remains it the value, where "\." matches a dot literally. For
4575 simple character replacements `tr()` avoids the need for escaping: >
4576 :setlocal includeexpr=tr(v:fname,'.','/')
4577<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004579 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 Also used for |<cfile>|.
4581
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004582 If the expression starts with s: or |<SID>|, then it is replaced with
4583 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004584 setlocal includeexpr=s:MyIncludeExpr()
4585 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004586< Otherwise, the expression is evaluated in the context of the script
4587 where the option was set, thus script-local items are available.
4588
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004589 It is more efficient if the value is just a function call without
4590 arguments, see |expr-option-function|.
4591
Bram Moolenaar30b65812012-07-12 22:01:11 +02004592 The expression will be evaluated in the |sandbox| when set from a
4593 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004594 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004595
4596 It is not allowed to change text or jump to another window while
4597 evaluating 'includeexpr' |textlock|.
4598
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004600'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004601 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004604 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004605 While typing a search command, show where the pattern, as it was typed
4606 so far, matches. The matched string is highlighted. If the pattern
4607 is invalid or not found, nothing is shown. The screen will be updated
4608 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004609 Also applies to the pattern in commands: >
4610 :global
4611 :lvimgrep
4612 :lvimgrepadd
4613 :smagic
4614 :snomagic
4615 :sort
4616 :substitute
4617 :vglobal
4618 :vimgrep
4619 :vimgrepadd
4620< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004621 original position when no match is found and when pressing <Esc>. You
4622 still need to finish the search command with <Enter> to move the
4623 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004624 You can use the CTRL-G and CTRL-T keys to move to the next and
4625 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004626 When compiled with the |+reltime| feature Vim only searches for about
4627 half a second. With a complicated pattern and/or a lot of text the
4628 match may not be found. This is to avoid that Vim hangs while you
4629 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004630 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004631 When 'hlsearch' is on, all matched strings are highlighted too while
4632 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004633 If you don't want to turn 'hlsearch' on, but want to highlight all
4634 matches while searching, you can turn on and off 'hlsearch' with
4635 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004636 augroup vimrc-incsearch-highlight
4637 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004638 autocmd CmdlineEnter /,\? :set hlsearch
4639 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004640 augroup END
4641<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004642 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004643 to the command line. If 'ignorecase' and 'smartcase' are set and the
4644 command line has no uppercase characters, the added character is
4645 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004646 CTRL-R CTRL-W can be used to add the word at the end of the current
4647 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 NOTE: This option is reset when 'compatible' is set.
4649
4650 *'indentexpr'* *'inde'*
4651'indentexpr' 'inde' string (default "")
4652 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004653 {not available when compiled without the |+eval|
4654 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 Expression which is evaluated to obtain the proper indent for a line.
4656 It is used when a new line is created, for the |=| operator and
4657 in Insert mode as specified with the 'indentkeys' option.
4658 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004659 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004660 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 When 'paste' is set this option is not used for indenting.
4662 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004663 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004665
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004666 If the expression starts with s: or |<SID>|, then it is replaced with
4667 the script ID (|local-function|). Example: >
4668 set indentexpr=s:MyIndentExpr()
4669 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004670< Otherwise, the expression is evaluated in the context of the script
4671 where the option was set, thus script-local items are available.
4672
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004673 The advantage of using a function call without arguments is that it is
4674 faster, see |expr-option-function|.
4675
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 The expression must return the number of spaces worth of indent. It
4677 can return "-1" to keep the current indent (this means 'autoindent' is
4678 used for the indent).
4679 Functions useful for computing the indent are |indent()|, |cindent()|
4680 and |lispindent()|.
4681 The evaluation of the expression must not have side effects! It must
4682 not change the text, jump to another window, etc. Afterwards the
4683 cursor position is always restored, thus the cursor may be moved.
4684 Normally this option would be set to call a function: >
4685 :set indentexpr=GetMyIndent()
4686< Error messages will be suppressed, unless the 'debug' option contains
4687 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004688 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004689 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690
Bram Moolenaar30b65812012-07-12 22:01:11 +02004691 The expression will be evaluated in the |sandbox| when set from a
4692 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004693 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004694
4695 It is not allowed to change text or jump to another window while
4696 evaluating 'indentexpr' |textlock|.
4697
4698
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004700'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 A list of keys that, when typed in Insert mode, cause reindenting of
4703 the current line. Only happens if 'indentexpr' isn't empty.
4704 The format is identical to 'cinkeys', see |indentkeys-format|.
4705 See |C-indenting| and |indent-expression|.
4706
4707 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4708'infercase' 'inf' boolean (default off)
4709 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004711 'ignorecase' is also on, the case of the match is adjusted depending
4712 on the typed text. If the typed text contains a lowercase letter
4713 where the match has an upper case letter, the completed part is made
4714 lowercase. If the typed text has no lowercase letters and the match
4715 has a lowercase letter where the typed text has an uppercase letter,
4716 and there is a letter before it, the completed part is made uppercase.
4717 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718
4719 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4720'insertmode' 'im' boolean (default off)
4721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 Makes Vim work in a way that Insert mode is the default mode. Useful
4723 if you want to use Vim as a modeless editor. Used for |evim|.
4724 These Insert mode commands will be useful:
4725 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004726 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 this is a mapping, it is executed as if 'insertmode' was off.
4728 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004730 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4731 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732
4733 These items change when 'insertmode' is set:
4734 - when starting to edit of a file, Vim goes to Insert mode.
4735 - <Esc> in Insert mode is a no-op and beeps.
4736 - <Esc> in Normal mode makes Vim go to Insert mode.
4737 - CTRL-L in Insert mode is a command, it is not inserted.
4738 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4739 However, when <Esc> is used inside a mapping, it behaves like
4740 'insertmode' was not set. This was done to be able to use the same
4741 mappings with 'insertmode' set or not set.
4742 When executing commands with |:normal| 'insertmode' is not used.
4743
4744 NOTE: This option is reset when 'compatible' is set.
4745
4746 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004747'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4749 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4750 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4751 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4752 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4753 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 The characters specified by this option are included in file names and
4755 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004756 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 Multi-byte characters 256 and above are always included, only the
4758 characters up to 255 are specified with this option.
4759 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004760 Think twice before adding white space to this option. Although a
4761 space may appear inside a file name, the effect will be that Vim
4762 doesn't know where a file name starts or ends when doing completion.
4763 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764
4765 Note that on systems using a backslash as path separator, Vim tries to
4766 do its best to make it work as you would expect. That is a bit
4767 tricky, since Vi originally used the backslash to escape special
4768 characters. Vim will not remove a backslash in front of a normal file
4769 name character on these systems, but it will on Unix and alikes. The
4770 '&' and '^' are not included by default, because these are special for
4771 cmd.exe.
4772
4773 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004774 Each part can be a single character number or a range. A range is two
4775 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 decimal number between 0 and 255 or the ASCII character itself (does
4777 not work for digits). Example:
4778 "_,-,128-140,#-43" (include '_' and '-' and the range
4779 128 to 140 and '#' to 43)
4780 If a part starts with '^', the following character number or range
4781 will be excluded from the option. The option is interpreted from left
4782 to right. Put the excluded character after the range where it is
4783 included. To include '^' itself use it as the last character of the
4784 option or the end of a range. Example:
4785 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4786 If the character is '@', all characters where isalpha() returns TRUE
4787 are included. Normally these are the characters a to z and A to Z,
4788 plus accented characters. To include '@' itself use "@-@". Examples:
4789 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004790 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 "a-z,A-Z,@-@" All letters plus the '@' character.
4792 A comma can be included by using it where a character number is
4793 expected. Example:
4794 "48-57,,,_" Digits, comma and underscore.
4795 A comma can be excluded by prepending a '^'. Example:
4796 " -~,^,,9" All characters from space to '~', excluding
4797 comma, plus <Tab>.
4798 See |option-backslash| about including spaces and backslashes.
4799
4800 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004801'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 "@,48-57,_,128-167,224-235"
4803 otherwise: "@,48-57,_,192-255")
4804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 The characters given by this option are included in identifiers.
4806 Identifiers are used in recognizing environment variables and after a
4807 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004808 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004809 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004811 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4813
4814 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004815'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 "@,48-57,_,128-167,224-235"
4817 otherwise: "@,48-57,_,192-255"
4818 Vi default: "@,48-57,_")
4819 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004821 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004822 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004823 characters above 255 check the "word" character class (any character
4824 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004825 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 For a help file it is set to all non-blank printable characters except
4827 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4828 command).
4829 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004830 This option also influences syntax highlighting, unless the syntax
4831 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 NOTE: This option is set to the Vi default value when 'compatible' is
4833 set and to the Vim default value when 'compatible' is reset.
4834
4835 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004836'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 "@,~-255"; otherwise: "@,161-255")
4838 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 The characters given by this option are displayed directly on the
4840 screen. It is also used for "\p" in a |pattern|. The characters from
4841 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4842 even when they are not included in 'isprint' or excluded. See
4843 'isfname' for a description of the format of this option.
4844
4845 Non-printable characters are displayed with two characters:
4846 0 - 31 "^@" - "^_"
4847 32 - 126 always single characters
4848 127 "^?"
4849 128 - 159 "~@" - "~_"
4850 160 - 254 "| " - "|~"
4851 255 "~?"
4852 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4853 displayed as <xx>, with the hexadecimal value of the byte.
4854 When 'display' contains "uhex" all unprintable characters are
4855 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004856 The SpecialKey highlighting will be used for unprintable characters.
4857 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858
4859 Multi-byte characters 256 and above are always included, only the
4860 characters up to 255 are specified with this option. When a character
4861 is printable but it is not available in the current font, a
4862 replacement character will be shown.
4863 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4864 There is no option to specify these characters.
4865
4866 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4867'joinspaces' 'js' boolean (default on)
4868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 Insert two spaces after a '.', '?' and '!' with a join command.
4870 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4871 Otherwise only one space is inserted.
4872 NOTE: This option is set when 'compatible' is set.
4873
4874 *'key'*
4875'key' string (default "")
4876 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004877 {only available when compiled with the |+cryptv|
4878 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004880 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 Careful: Do not set the key value by hand, someone might see the typed
4882 key. Use the |:X| command. But you can make 'key' empty: >
4883 :set key=
4884< It is not possible to get the value of this option with ":set key" or
4885 "echo &key". This is to avoid showing it to someone who shouldn't
4886 know. It also means you cannot see it yourself once you have set it,
4887 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004888 You can use "&key" in an expression to detect whether encryption is
4889 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890
4891 *'keymap'* *'kmp'* *E544*
4892'keymap' 'kmp' string (default "")
4893 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 {only available when compiled with the |+keymap|
4895 feature}
4896 Name of a keyboard mapping. See |mbyte-keymap|.
4897 Setting this option to a valid keymap name has the side effect of
4898 setting 'iminsert' to one, so that the keymap becomes effective.
4899 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004900 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901
4902 *'keymodel'* *'km'*
4903'keymodel' 'km' string (default "")
4904 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004905 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 can do. These values can be used:
4907 startsel Using a shifted special key starts selection (either
4908 Select mode or Visual mode, depending on "key" being
4909 present in 'selectmode').
4910 stopsel Using a not-shifted special key stops selection.
4911 Special keys in this context are the cursor keys, <End>, <Home>,
4912 <PageUp> and <PageDown>.
4913 The 'keymodel' option is set by the |:behave| command.
4914
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004915 *'keyprotocol'* *'kpc'*
4916'keyprotocol' 'kpc' string (default: see below)
4917 global
4918 Specifies what keyboard protocol to use depending on the value of
4919 'term'. The supported keyboard protocols names are:
4920 none whatever the terminal uses
4921 mok2 modifyOtherKeys level 2, as supported by xterm
4922 kitty Kitty keyboard protocol, as supported by Kitty
4923
Bram Moolenaara87749e2022-11-30 10:23:17 +00004924 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004925 a pattern that is matched against the 'term' option, a colon and the
4926 protocol name to be used. To illustrate this, the default value would
4927 be set with: >
4928 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
4929
4930< This means that when 'term' contains "kitty, "foot" or "wezterm"
4931 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00004932 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004933
4934 The first match is used, thus if you want to have "kitty" use the
4935 kitty protocol, but "badkitty" not, then you should match "badkitty"
4936 first and use the "none" value: >
4937 set keyprotocol=badkitty:none,kitty:kitty
4938<
4939 The option is used after 'term' has been changed. First the termcap
4940 entries are set, possibly using the builtin list, see |builtin-terms|.
4941 Then this option is inspected and if there is a match and a protocol
4942 is specified the following happens:
4943 none Nothing, the regular t_TE and t_TI values remain
4944
4945 mok2 The t_TE value is changed to:
4946 CSI >4;m disables modifyOtherKeys
4947 The t_TI value is changed to:
4948 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00004949 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004950
4951 kitty The t_TE value is changed to:
4952 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00004953 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004954 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00004955 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004956 CSI ?u request kitty keyboard protocol state
4957 CSI >c request the termresponse
4958
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00004959 If you notice problems, such as characters being displayed that
4960 disappear after `CTRL-L`, you might want to try making this option
4961 empty. Then set the 'term' option to have it take effect: >
4962 set keyprotocol=
4963 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00004964<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004965
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 *'keywordprg'* *'kp'*
4967'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004968 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 Program to use for the |K| command. Environment variables are
4971 expanded |:set_env|. ":help" may be used to access the Vim internal
4972 help. (Note that previously setting the global option to the empty
4973 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004974 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004975 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004976 When "man", "man -s" or an Ex command is used, Vim will automatically
4977 translate a count for the "K" command and pass it as the first
4978 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 See |option-backslash| about including spaces and backslashes.
4980 Example: >
4981 :set keywordprg=man\ -s
4982< This option cannot be set from a |modeline| or in the |sandbox|, for
4983 security reasons.
4984
4985 *'langmap'* *'lmap'* *E357* *E358*
4986'langmap' 'lmap' string (default "")
4987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 {only available when compiled with the |+langmap|
4989 feature}
4990 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004991 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004992 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 care of translating these special characters to the original meaning
4994 of the key. This means you don't have to change the keyboard mode to
4995 be able to execute Normal mode commands.
4996 This is the opposite of the 'keymap' option, where characters are
4997 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004998 Also consider setting 'langremap' to off, to prevent 'langmap' from
4999 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005000 This option cannot be set from a |modeline| or in the |sandbox|, for
5001 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005003 Example (for Greek, in UTF-8): *greek* >
5004 :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 +00005005< Example (exchanges meaning of z and y for commands): >
5006 :set langmap=zy,yz,ZY,YZ
5007<
5008 The 'langmap' option is a list of parts, separated with commas. Each
5009 part can be in one of two forms:
5010 1. A list of pairs. Each pair is a "from" character immediately
5011 followed by the "to" character. Examples: "aA", "aAbBcC".
5012 2. A list of "from" characters, a semi-colon and a list of "to"
5013 characters. Example: "abc;ABC"
5014 Example: "aA,fgh;FGH,cCdDeE"
5015 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005016 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017
5018 This will allow you to activate vim actions without having to switch
5019 back and forth between the languages. Your language characters will
5020 be understood as normal vim English characters (according to the
5021 langmap mappings) in the following cases:
5022 o Normal/Visual mode (commands, buffer/register names, user mappings)
5023 o Insert/Replace Mode: Register names after CTRL-R
5024 o Insert/Replace Mode: Mappings
5025 Characters entered in Command-line mode will NOT be affected by
5026 this option. Note that this option can be changed at any time
5027 allowing to switch between mappings for different languages/encodings.
5028 Use a mapping to avoid having to type it each time!
5029
5030 *'langmenu'* *'lm'*
5031'langmenu' 'lm' string (default "")
5032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 {only available when compiled with the |+menu| and
5034 |+multi_lang| features}
5035 Language to use for menu translation. Tells which file is loaded
5036 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005037 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038< (without the spaces). For example, to always use the Dutch menus, no
5039 matter what $LANG is set to: >
5040 :set langmenu=nl_NL.ISO_8859-1
5041< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005042 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 If your $LANG is set to a non-English language but you do want to use
5044 the English menus: >
5045 :set langmenu=none
5046< This option must be set before loading menus, switching on filetype
5047 detection or syntax highlighting. Once the menus are defined setting
5048 this option has no effect. But you could do this: >
5049 :source $VIMRUNTIME/delmenu.vim
5050 :set langmenu=de_DE.ISO_8859-1
5051 :source $VIMRUNTIME/menu.vim
5052< Warning: This deletes all menus that you defined yourself!
5053
Bram Moolenaard94464e2015-11-02 15:28:18 +01005054 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005055'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005056 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005057 {only available when compiled with the |+langmap|
5058 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005059 This is just like 'langremap' but with the value inverted. It only
5060 exists for backwards compatibility. When setting 'langremap' then
5061 'langnoremap' is set to the inverted value, and the other way around.
5062
5063 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005064'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005065 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005066 {only available when compiled with the |+langmap|
5067 feature}
5068 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005069 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005070 'langmap' disables some of your mappings, try resetting this option.
5071 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005072 that works for you to avoid mappings to break.
5073
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 *'laststatus'* *'ls'*
5075'laststatus' 'ls' number (default 1)
5076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 The value of this option influences when the last window will have a
5078 status line:
5079 0: never
5080 1: only if there are at least two windows
5081 2: always
5082 The screen looks nicer with a status line if you have several
5083 windows, but it takes another screen line. |status-line|
5084
5085 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5086'lazyredraw' 'lz' boolean (default off)
5087 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 When this option is set, the screen will not be redrawn while
5089 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005090 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005092 This may occasionally cause display errors. It is only meant to be set
5093 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005094 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095
5096 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5097'linebreak' 'lbr' boolean (default off)
5098 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005099 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005101 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 than at the last character that fits on the screen. Unlike
5103 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005104 it only affects the way the file is displayed, not its contents.
5105 If 'breakindent' is set, line is visually indented. Then, the value
5106 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005107 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 Note that <Tab> characters after an <EOL> are mostly not displayed
5109 with the right amount of white space.
5110
5111 *'lines'* *E593*
5112'lines' number (default 24 or terminal height)
5113 global
5114 Number of lines of the Vim window.
5115 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005116 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 When Vim is running in the GUI or in a resizable window, setting this
5118 option will cause the window size to be changed. When you only want
5119 to use the size for the GUI, put the command in your |gvimrc| file.
5120 Vim limits the number of lines to what fits on the screen. You can
5121 use this command to get the tallest window possible: >
5122 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005123< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005124 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 When you set this option and Vim is unable to change the physical
5126 number of lines of the display, the display may be messed up.
5127
5128 *'linespace'* *'lsp'*
5129'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131 {only in the GUI}
5132 Number of pixel lines inserted between characters. Useful if the font
5133 uses the full character cell height, making lines touch each other.
5134 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005135 With some fonts there can be too much room between lines (to have
5136 space for ascents and descents). Then it makes sense to set
5137 'linespace' to a negative value. This may cause display problems
5138 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139
5140 *'lisp'* *'nolisp'*
5141'lisp' boolean (default off)
5142 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 Lisp mode: When <Enter> is typed in insert mode set the indent for
5144 the next line to Lisp standards (well, sort of). Also happens with
5145 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5146 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5147 better. Also see 'lispwords'.
5148 The '-' character is included in keyword characters. Redefines the
5149 "=" operator to use this same indentation algorithm rather than
5150 calling an external program if 'equalprg' is empty.
5151 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005153 *'lispoptions'* *'lop'*
5154'lispoptions' 'lop' string (default "")
5155 local to buffer
5156 Comma-separated list of items that influence the Lisp indenting when
5157 enabled with the |'lisp'| option. Currently only one item is
5158 supported:
5159 expr:1 use 'indentexpr' for Lisp indenting when it is set
5160 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5161 Note that when using 'indentexpr' the `=` operator indents all the
5162 lines, otherwise the first line is not indented (Vi-compatible).
5163
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 *'lispwords'* *'lw'*
5165'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005166 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005167 Comma-separated list of words that influence the Lisp indenting when
5168 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169
5170 *'list'* *'nolist'*
5171'list' boolean (default off)
5172 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005173 List mode: By default show tabs as CTRL-I is displayed, display $
5174 after end of line. Useful to see the difference between tabs and
5175 spaces and for trailing blanks. Further changed by the 'listchars'
5176 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005177
5178 The cursor is displayed at the start of the space a Tab character
5179 occupies, not at the end as usual in Normal mode. To get this cursor
5180 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005181 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005182<
5183 Note that list mode will also affect formatting (set with 'textwidth'
5184 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 changing the way tabs are displayed.
5186
5187 *'listchars'* *'lcs'*
5188'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005189 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005190 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005191 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005192 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 eol:c Character to show at the end of each line. When
5194 omitted, there is no extra character at the end of the
5195 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005196 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005197 tab:xy[z] Two or three characters to be used to show a tab.
5198 The third character is optional.
5199
5200 tab:xy The 'x' is always used, then 'y' as many times as will
5201 fit. Thus "tab:>-" displays:
5202 >
5203 >-
5204 >--
5205 etc.
5206
5207 tab:xyz The 'z' is always used, then 'x' is prepended, and
5208 then 'y' is used as many times as will fit. Thus
5209 "tab:<->" displays:
5210 >
5211 <>
5212 <->
5213 <-->
5214 etc.
5215
5216 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005217 *lcs-space*
5218 space:c Character to show for a space. When omitted, spaces
5219 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005220 *lcs-multispace*
5221 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005222 One or more characters to use cyclically to show for
5223 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005224 setting, except for single spaces. When omitted, the
5225 "space" setting is used. For example,
5226 `:set listchars=multispace:---+` shows ten consecutive
5227 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005228 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005229 *lcs-lead*
5230 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005231 leading spaces are blank. Overrides the "space" and
5232 "multispace" settings for leading spaces. You can
5233 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005234 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005235< *lcs-leadmultispace*
5236 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005237 Like the |lcs-multispace| value, but for leading
5238 spaces only. Also overrides |lcs-lead| for leading
5239 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005240 `:set listchars=leadmultispace:---+` shows ten
5241 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005242 ---+---+--XXX ~
5243 Where "XXX" denotes the first non-blank characters in
5244 the line.
5245 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005246 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005247 trailing spaces are blank. Overrides the "space" and
5248 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005249 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250 extends:c Character to show in the last column, when 'wrap' is
5251 off and the line continues beyond the right of the
5252 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005253 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005254 precedes:c Character to show in the first visible column of the
5255 physical line, when there is text preceding the
5256 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005257 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005258 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005259 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005260 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005261 nbsp:c Character to show for a non-breakable space character
5262 (0xA0 (160 decimal) and U+202F). Left blank when
5263 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005265 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005267 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005269 Each character can be specified as hex: >
5270 set listchars=eol:\\x24
5271 set listchars=eol:\\u21b5
5272 set listchars=eol:\\U000021b5
5273< Note that a double backslash is used. The number of hex characters
5274 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5275
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 Examples: >
5277 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005278 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 :set lcs=extends:>,precedes:<
5280< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005281 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5282 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005283 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284
5285 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5286'loadplugins' 'lpl' boolean (default on)
5287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 When on the plugin scripts are loaded when starting up |load-plugins|.
5289 This option can be reset in your |vimrc| file to disable the loading
5290 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005291 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5292 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293
Bram Moolenaard94464e2015-11-02 15:28:18 +01005294 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005295'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005296 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005297 {only available when compiled with the |+lua/dyn|
5298 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005299 Specifies the name of the Lua shared library. The default is
5300 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005301 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005302 This option cannot be set from a |modeline| or in the |sandbox|, for
5303 security reasons.
5304
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005305 *'macatsui'* *'nomacatsui'*
5306'macatsui' boolean (default on)
5307 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005308 {not supported}
5309 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005310
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 *'magic'* *'nomagic'*
5312'magic' boolean (default on)
5313 global
5314 Changes the special characters that can be used in search patterns.
5315 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005316 WARNING: Switching this option off most likely breaks plugins! That
5317 is because many patterns assume it's on and will fail when it's off.
5318 Only switch it off when working with old Vi scripts. In any other
5319 situation write patterns that work when 'magic' is on. Include "\M"
5320 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005321 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5322 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323
5324 *'makeef'* *'mef'*
5325'makeef' 'mef' string (default: "")
5326 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 {not available when compiled without the |+quickfix|
5328 feature}
5329 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5330 and the |:grep| command.
5331 When it is empty, an internally generated temp file will be used.
5332 When "##" is included, it is replaced by a number to make the name
5333 unique. This makes sure that the ":make" command doesn't overwrite an
5334 existing file.
5335 NOT used for the ":cf" command. See 'errorfile' for that.
5336 Environment variables are expanded |:set_env|.
5337 See |option-backslash| about including spaces and backslashes.
5338 This option cannot be set from a |modeline| or in the |sandbox|, for
5339 security reasons.
5340
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005341 *'makeencoding'* *'menc'*
5342'makeencoding' 'menc' string (default "")
5343 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005344 Encoding used for reading the output of external commands. When empty,
5345 encoding is not converted.
5346 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5347 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5348 and `:laddfile`.
5349
5350 This would be mostly useful when you use MS-Windows and set 'encoding'
5351 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5352 'makeencoding' to "char" has the same effect as setting to the system
5353 locale encoding. Example: >
5354 :set encoding=utf-8
5355 :set makeencoding=char " system locale is used
5356<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 *'makeprg'* *'mp'*
5358'makeprg' 'mp' string (default "make", VMS: "MMS")
5359 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005360 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005361 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5362 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005363 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005364 Environment variables are expanded |:set_env|. See |option-backslash|
5365 about including spaces and backslashes.
5366 Note that a '|' must be escaped twice: once for ":set" and once for
5367 the interpretation of a command. When you use a filter called
5368 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 :set makeprg=gmake\ \\\|\ myfilter
5370< The placeholder "$*" can be given (even multiple times) to specify
5371 where the arguments will be included, for example: >
5372 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5373< This option cannot be set from a |modeline| or in the |sandbox|, for
5374 security reasons.
5375
5376 *'matchpairs'* *'mps'*
5377'matchpairs' 'mps' string (default "(:),{:},[:]")
5378 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005380 other.
5381 Only character pairs are allowed that are different, thus you cannot
5382 jump between two double quotes.
5383 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005384 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005385 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 :set mps+=<:>
5387
5388< A more exotic example, to jump between the '=' and ';' in an
5389 assignment, useful for languages like C and Java: >
5390 :au FileType c,cpp,java set mps+==:;
5391
5392< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005393 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394
5395 *'matchtime'* *'mat'*
5396'matchtime' 'mat' number (default 5)
5397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 Tenths of a second to show the matching paren, when 'showmatch' is
5399 set. Note that this is not in milliseconds, like other options that
5400 set a time. This is to be compatible with Nvi.
5401
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005402 *'maxcombine'* *'mco'*
5403'maxcombine' 'mco' number (default 2)
5404 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005405 The maximum number of combining characters supported for displaying.
5406 Only used when 'encoding' is "utf-8".
5407 The default is OK for most languages. Hebrew may require 4.
5408 Maximum value is 6.
5409 Even when this option is set to 2 you can still edit text with more
5410 combining characters, you just can't see them. Use |g8| or |ga|.
5411 See |mbyte-combining|.
5412
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 *'maxfuncdepth'* *'mfd'*
5414'maxfuncdepth' 'mfd' number (default 100)
5415 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005416 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005417 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 Maximum depth of function calls for user functions. This normally
5419 catches endless recursion. When using a recursive function with
5420 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5421 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005422 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005423 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 See also |:function|.
5425
5426 *'maxmapdepth'* *'mmd'* *E223*
5427'maxmapdepth' 'mmd' number (default 1000)
5428 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 Maximum number of times a mapping is done without resulting in a
5430 character to be used. This normally catches endless mappings, like
5431 ":map x y" with ":map y x". It still does not catch ":map g wg",
5432 because the 'w' is used before the next mapping is done. See also
5433 |key-mapping|.
5434
5435 *'maxmem'* *'mm'*
5436'maxmem' 'mm' number (default between 256 to 5120 (system
5437 dependent) or half the amount of memory
5438 available)
5439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5441 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005442 other memory to be freed.
5443 The maximum usable value is about 2000000. Use this to work without a
5444 limit.
5445 The value is ignored when 'swapfile' is off.
5446 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005448 *'maxmempattern'* *'mmp'*
5449'maxmempattern' 'mmp' number (default 1000)
5450 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005451 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005452 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005453 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005454 When Vim runs into the limit it gives an error message and mostly
5455 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005456 Running into the limit often means that the pattern is very
5457 inefficient or too complex. This may already happen with the pattern
5458 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005459 Might also happen on redraw, when syntax rules try to match a complex
5460 text structure.
5461 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5462 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005463
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 *'maxmemtot'* *'mmt'*
5465'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5466 dependent) or half the amount of memory
5467 available)
5468 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005469 Maximum amount of memory in Kbyte to use for all buffers together.
5470 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005471 without a limit.
5472 On 64 bit machines higher values might work. But hey, do you really
5473 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005474 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005475 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005476 Buffers with 'swapfile' off still count to the total amount of memory
5477 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005478 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479
5480 *'menuitems'* *'mis'*
5481'menuitems' 'mis' number (default 25)
5482 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 {not available when compiled without the |+menu|
5484 feature}
5485 Maximum number of items to use in a menu. Used for menus that are
5486 generated from a list of items, e.g., the Buffers menu. Changing this
5487 option has no direct effect, the menu must be refreshed first.
5488
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005489 *'mkspellmem'* *'msm'*
5490'mkspellmem' 'msm' string (default "460000,2000,500")
5491 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005492 {not available when compiled without the |+syntax|
5493 feature}
5494 Parameters for |:mkspell|. This tunes when to start compressing the
5495 word tree. Compression can be slow when there are many words, but
5496 it's needed to avoid running out of memory. The amount of memory used
5497 per word depends very much on how similar the words are, that's why
5498 this tuning is complicated.
5499
5500 There are three numbers, separated by commas:
5501 {start},{inc},{added}
5502
5503 For most languages the uncompressed word tree fits in memory. {start}
5504 gives the amount of memory in Kbyte that can be used before any
5505 compression is done. It should be a bit smaller than the amount of
5506 memory that is available to Vim.
5507
5508 When going over the {start} limit the {inc} number specifies the
5509 amount of memory in Kbyte that can be allocated before another
5510 compression is done. A low number means compression is done after
5511 less words are added, which is slow. A high number means more memory
5512 will be allocated.
5513
5514 After doing compression, {added} times 1024 words can be added before
5515 the {inc} limit is ignored and compression is done when any extra
5516 amount of memory is needed. A low number means there is a smaller
5517 chance of hitting the {inc} limit, less memory is used but it's
5518 slower.
5519
5520 The languages for which these numbers are important are Italian and
5521 Hungarian. The default works for when you have about 512 Mbyte. If
5522 you have 1 Gbyte you could use: >
5523 :set mkspellmem=900000,3000,800
5524< If you have less than 512 Mbyte |:mkspell| may fail for some
5525 languages, no matter what you set 'mkspellmem' to.
5526
Bram Moolenaar07607392019-05-26 19:20:43 +02005527 This option cannot be set from a |modeline| or in the |sandbox|.
5528
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005530'modeline' 'ml' boolean (Vim default: on (off for root),
5531 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005533 If 'modeline' is on 'modelines' gives the number of lines that is
5534 checked for set commands. If 'modeline' is off or 'modelines' is zero
5535 no lines are checked. See |modeline|.
5536
5537 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5538'modelineexpr' 'mle' boolean (default: off)
5539 global
5540 When on allow some options that are an expression to be set in the
5541 modeline. Check the option for whether it is affected by
5542 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005543 This option cannot be set from a |modeline| or in the |sandbox|, for
5544 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005545
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 *'modelines'* *'mls'*
5547'modelines' 'mls' number (default 5)
5548 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 If 'modeline' is on 'modelines' gives the number of lines that is
5550 checked for set commands. If 'modeline' is off or 'modelines' is zero
5551 no lines are checked. See |modeline|.
5552 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5553 set and to the Vim default value when 'compatible' is reset.
5554
5555 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005556 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557'modifiable' 'ma' boolean (default on)
5558 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 When off the buffer contents cannot be changed. The 'fileformat' and
5560 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005561 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562
5563 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5564'modified' 'mod' boolean (default off)
5565 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 When on, the buffer is considered to be modified. This option is set
5567 when:
5568 1. A change was made to the text since it was last written. Using the
5569 |undo| command to go back to the original text will reset the
5570 option. But undoing changes that were made before writing the
5571 buffer will set the option again, since the text is different from
5572 when it was written.
5573 2. 'fileformat' or 'fileencoding' is different from its original
5574 value. The original value is set when the buffer is read or
5575 written. A ":set nomodified" command also resets the original
5576 values to the current values and the 'modified' option will be
5577 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005578 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005579 This option is not set when a change is made to the buffer as the
5580 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5581 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5582 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5584 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005585 Note that the text may actually be the same, e.g. 'modified' is set
5586 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587
5588 *'more'* *'nomore'*
5589'more' boolean (Vim default: on, Vi default: off)
5590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 When on, listings pause when the whole screen is filled. You will get
5592 the |more-prompt|. When this option is off there are no pauses, the
5593 listing continues until finished.
5594 NOTE: This option is set to the Vi default value when 'compatible' is
5595 set and to the Vim default value when 'compatible' is reset.
5596
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005597 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005598'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005599 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005601 Enable the use of the mouse. Works for most terminals (xterm, Win32
5602 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5603 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5604 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005605 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 v Visual mode
5607 i Insert mode
5608 c Command-line mode
5609 h all previous modes when editing a help file
5610 a all previous modes
5611 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005612 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005614< If your terminal can't overrule the mouse events going to the
5615 application, use: >
5616 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005617< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005618 back to Vim using the mouse events.
5619 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5620 "xterm".
5621
5622 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 modeless selection. This doesn't move the text cursor.
5624
5625 See |mouse-using|. Also see |'clipboard'|.
5626
5627 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005628 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 the mouse buttons can still be used by keeping the shift key pressed.
5630 Also see the 'clipboard' option.
5631
5632 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5633'mousefocus' 'mousef' boolean (default off)
5634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 {only works in the GUI}
5636 The window that the mouse pointer is on is automatically activated.
5637 When changing the window layout or window focus in another way, the
5638 mouse pointer is moved to the window with keyboard focus. Off is the
5639 default because it makes using the pull down menus a little goofy, as
5640 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005641 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005642 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643
5644 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5645'mousehide' 'mh' boolean (default on)
5646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 {only works in the GUI}
5648 When on, the mouse pointer is hidden when characters are typed.
5649 The mouse pointer is restored when the mouse is moved.
5650
5651 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005652'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 Sets the model to use for the mouse. The name mostly specifies what
5655 the right mouse button is used for:
5656 extend Right mouse button extends a selection. This works
5657 like in an xterm.
5658 popup Right mouse button pops up a menu. The shifted left
5659 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005660 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 popup_setpos Like "popup", but the cursor will be moved to the
5662 position where the mouse was clicked, and thus the
5663 selected operation will act upon the clicked object.
5664 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005665 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 course, that right clicking outside a selection will
5667 end Visual mode.
5668 Overview of what button does what for each model:
5669 mouse extend popup(_setpos) ~
5670 left click place cursor place cursor
5671 left drag start selection start selection
5672 shift-left search word extend selection
5673 right click extend selection popup menu (place cursor)
5674 right drag extend selection -
5675 middle click paste paste
5676
5677 In the "popup" model the right mouse button produces a pop-up menu.
5678 You need to define this first, see |popup-menu|.
5679
5680 Note that you can further refine the meaning of buttons with mappings.
5681 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5682 selection (because that's handled in the GUI code directly).
5683
5684 The 'mousemodel' option is set by the |:behave| command.
5685
Bram Moolenaar938ae282023-02-20 20:44:55 +00005686 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005687'mousemoveevent' 'mousemev' boolean (default off)
5688 global
5689 {only works in the GUI}
5690 When on, mouse move events are delivered to the input queue and are
5691 available for mapping. The default, off, avoids the mouse movement
5692 overhead except when needed. See |gui-mouse-mapping|.
5693 Warning: Setting this option can make pending mappings to be aborted
5694 when the mouse is moved.
5695 Currently only works in the GUI, may be made to work in a terminal
5696 later.
5697
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005699'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5700 vs:leftright,vd:lrsizing,m:no,
5701 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 {only available when compiled with the |+mouseshape|
5704 feature}
5705 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005706 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 like used for 'guicursor'. Each part consist of a mode/location-list
5708 and an argument-list:
5709 mode-list:shape,mode-list:shape,..
5710 The mode-list is a dash separated list of these modes/locations:
5711 In a normal window: ~
5712 n Normal mode
5713 v Visual mode
5714 ve Visual mode with 'selection' "exclusive" (same as 'v',
5715 if not specified)
5716 o Operator-pending mode
5717 i Insert mode
5718 r Replace mode
5719
5720 Others: ~
5721 c appending to the command-line
5722 ci inserting in the command-line
5723 cr replacing in the command-line
5724 m at the 'Hit ENTER' or 'More' prompts
5725 ml idem, but cursor in the last line
5726 e any mode, pointer below last window
5727 s any mode, pointer on a status line
5728 sd any mode, while dragging a status line
5729 vs any mode, pointer on a vertical separator line
5730 vd any mode, while dragging a vertical separator line
5731 a everywhere
5732
5733 The shape is one of the following:
5734 avail name looks like ~
5735 w x arrow Normal mouse pointer
5736 w x blank no pointer at all (use with care!)
5737 w x beam I-beam
5738 w x updown up-down sizing arrows
5739 w x leftright left-right sizing arrows
5740 w x busy The system's usual busy pointer
5741 w x no The system's usual 'no input' pointer
5742 x udsizing indicates up-down resizing
5743 x lrsizing indicates left-right resizing
5744 x crosshair like a big thin +
5745 x hand1 black hand
5746 x hand2 white hand
5747 x pencil what you write with
5748 x question big ?
5749 x rightup-arrow arrow pointing right-up
5750 w x up-arrow arrow pointing up
5751 x <number> any X11 pointer number (see X11/cursorfont.h)
5752
5753 The "avail" column contains a 'w' if the shape is available for Win32,
5754 x for X11.
5755 Any modes not specified or shapes not available use the normal mouse
5756 pointer.
5757
5758 Example: >
5759 :set mouseshape=s:udsizing,m:no
5760< will make the mouse turn to a sizing arrow over the status lines and
5761 indicate no input when the hit-enter prompt is displayed (since
5762 clicking the mouse has no effect in this state.)
5763
5764 *'mousetime'* *'mouset'*
5765'mousetime' 'mouset' number (default 500)
5766 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005767 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 time in msec between two mouse clicks for the second click to be
5769 recognized as a multi click.
5770
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005771 *'mzschemedll'*
5772'mzschemedll' string (default depends on the build)
5773 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005774 {only available when compiled with the |+mzscheme/dyn|
5775 feature}
5776 Specifies the name of the MzScheme shared library. The default is
5777 DYNAMIC_MZSCH_DLL which was specified at compile time.
5778 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005779 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005780 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005781 This option cannot be set from a |modeline| or in the |sandbox|, for
5782 security reasons.
5783
5784 *'mzschemegcdll'*
5785'mzschemegcdll' string (default depends on the build)
5786 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005787 {only available when compiled with the |+mzscheme/dyn|
5788 feature}
5789 Specifies the name of the MzScheme GC shared library. The default is
5790 DYNAMIC_MZGC_DLL which was specified at compile time.
5791 The value can be equal to 'mzschemedll' if it includes the GC code.
5792 Environment variables are expanded |:set_env|.
5793 This option cannot be set from a |modeline| or in the |sandbox|, for
5794 security reasons.
5795
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005796 *'mzquantum'* *'mzq'*
5797'mzquantum' 'mzq' number (default 100)
5798 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005799 {not available when compiled without the |+mzscheme|
5800 feature}
5801 The number of milliseconds between polls for MzScheme threads.
5802 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005803 NOTE: This option is set to the Vim default value when 'compatible'
5804 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005805
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005807'nrformats' 'nf' string (default "bin,octal,hex",
5808 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810 This defines what bases Vim will consider for numbers when using the
5811 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5812 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005813 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005815 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005816 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005818 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 considered to be hexadecimal. Example: Using CTRL-X on
5820 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005821 bin If included, numbers starting with "0b" or "0B" will be
5822 considered to be binary. Example: Using CTRL-X on
5823 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005824 unsigned If included, numbers are recognized as unsigned. Thus a
5825 leading dash or negative sign won't be considered as part of
5826 the number. Examples:
5827 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5828 (without "unsigned" it would become "9-2021").
5829 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5830 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005831 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5832 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 Numbers which simply begin with a digit in the range 1-9 are always
5834 considered decimal. This also happens for numbers that are not
5835 recognized as octal or hex.
5836
5837 *'number'* *'nu'* *'nonumber'* *'nonu'*
5838'number' 'nu' boolean (default off)
5839 local to window
5840 Print the line number in front of each line. When the 'n' option is
5841 excluded from 'cpoptions' a wrapped line will not use the column of
5842 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005843 The 'numberwidth' option can be used to set the room used for the line
5844 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845 When a long, wrapped line doesn't start with the first character, '-'
5846 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005847 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5848 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005849 *number_relativenumber*
5850 The 'relativenumber' option changes the displayed number to be
5851 relative to the cursor. Together with 'number' there are these
5852 four combinations (cursor in line 3):
5853
Bram Moolenaar3848e002016-03-19 18:42:29 +01005854 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005855 'nornu' 'nornu' 'rnu' 'rnu'
5856
5857 |apple | 1 apple | 2 apple | 2 apple
5858 |pear | 2 pear | 1 pear | 1 pear
5859 |nobody | 3 nobody | 0 nobody |3 nobody
5860 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005862 *'numberwidth'* *'nuw'*
5863'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5864 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005865 {only available when compiled with the |+linebreak|
5866 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005867 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005868 when the 'number' or 'relativenumber' option is set or printing lines
5869 with a line number. Since one space is always between the number and
5870 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005871 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005872 fit the highest line number in the buffer respectively the number of
5873 rows in the window, depending on whether 'number' or 'relativenumber'
5874 is set. Thus with the Vim default of 4 there is room for a line number
5875 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005876 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005877 NOTE: This option is set to the Vi default value when 'compatible' is
5878 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005879
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005880 *'omnifunc'* *'ofu'*
5881'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005882 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005883 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005884 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005885 This option specifies a function to be used for Insert mode omni
5886 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005887 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005888 invoked and what it should return. The value can be the name of a
5889 function, a |lambda| or a |Funcref|. See |option-value-function| for
5890 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005891 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005892 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005893 This option cannot be set from a |modeline| or in the |sandbox|, for
5894 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005895
5896
Bram Moolenaar02467872007-05-06 13:22:01 +00005897 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005898'opendevice' 'odev' boolean (default off)
5899 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005900 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005901 Enable reading and writing from devices. This may get Vim stuck on a
5902 device that can be opened but doesn't actually do the I/O. Therefore
5903 it is off by default.
5904 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5905 result in editing a device.
5906
5907
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005908 *'operatorfunc'* *'opfunc'*
5909'operatorfunc' 'opfunc' string (default: empty)
5910 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005911 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005912 See |:map-operator| for more info and an example. The value can be
5913 the name of a function, a |lambda| or a |Funcref|. See
5914 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005915
5916 This option cannot be set from a |modeline| or in the |sandbox|, for
5917 security reasons.
5918
5919
Bram Moolenaar251e1912011-06-19 05:09:16 +02005920 *'osfiletype'* *'oft'*
5921'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005923 This option was supported on RISC OS, which has been removed.
5924
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005926 *'packpath'* *'pp'*
5927'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005928 Directories used to find packages. See |packages|.
5929
5930
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005932'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 global
5934 Specifies the nroff macros that separate paragraphs. These are pairs
5935 of two letters (see |object-motions|).
5936
5937 *'paste'* *'nopaste'*
5938'paste' boolean (default off)
5939 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005940 Put Vim in Paste mode. This is useful if you want to cut or copy
5941 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 unexpected effects.
5943 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005944 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 knows about pasting and will mostly do the right thing without 'paste'
5946 being set. The same is true for a terminal where Vim handles the
5947 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005948 This option is reset when starting the GUI. Thus if you set it in
5949 your .vimrc it will work in a terminal, but not in the GUI. Setting
5950 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5951 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 When the 'paste' option is switched on (also when it was already on):
5953 - mapping in Insert mode and Command-line mode is disabled
5954 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005956 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005957 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958 - 'revins' is reset
5959 - 'ruler' is reset
5960 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005961 - 'smarttab' is reset
5962 - 'softtabstop' is set to 0
5963 - 'textwidth' is set to 0
5964 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005965 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005968 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005969 - 'indentexpr'
5970 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005971 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972 NOTE: When you start editing another file while the 'paste' option is
5973 on, settings from the modelines or autocommands may change the
5974 settings again, causing trouble when pasting text. You might want to
5975 set the 'paste' option again.
5976 When the 'paste' option is reset the mentioned options are restored to
5977 the value before the moment 'paste' was switched from off to on.
5978 Resetting 'paste' before ever setting it does not have any effect.
5979 Since mapping doesn't work while 'paste' is active, you need to use
5980 the 'pastetoggle' option to toggle the 'paste' option with some key.
5981
5982 *'pastetoggle'* *'pt'*
5983'pastetoggle' 'pt' string (default "")
5984 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 When non-empty, specifies the key sequence that toggles the 'paste'
5986 option. This is like specifying a mapping: >
5987 :map {keys} :set invpaste<CR>
5988< Where {keys} is the value of 'pastetoggle'.
5989 The difference is that it will work even when 'paste' is set.
5990 'pastetoggle' works in Insert mode and Normal mode, but not in
5991 Command-line mode.
5992 Mappings are checked first, thus overrule 'pastetoggle'. However,
5993 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5994 this: >
5995 :map <F10> :set paste<CR>
5996 :map <F11> :set nopaste<CR>
5997 :imap <F10> <C-O>:set paste<CR>
5998 :imap <F11> <nop>
5999 :set pastetoggle=<F11>
6000< This will make <F10> start paste mode and <F11> stop paste mode.
6001 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6002 mode everything is inserted literally, except the 'pastetoggle' key
6003 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006004 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005
6006 *'pex'* *'patchexpr'*
6007'patchexpr' 'pex' string (default "")
6008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 {not available when compiled without the |+diff|
6010 feature}
6011 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006012 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013
Bram Moolenaardbc28022014-07-26 13:40:44 +02006014 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015'patchmode' 'pm' string (default "")
6016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 When non-empty the oldest version of a file is kept. This can be used
6018 to keep the original version of a file if you are changing files in a
6019 source distribution. Only the first time that a file is written a
6020 copy of the original file will be kept. The name of the copy is the
6021 name of the original file with the string in the 'patchmode' option
6022 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006023 ".orig" or ".org". 'backupdir' must not be empty for this to work
6024 (Detail: The backup file is renamed to the patchmode file after the
6025 new file has been successfully written, that's why it must be possible
6026 to write a backup file). If there was no file to be backed up, an
6027 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 When the 'backupskip' pattern matches, a patchmode file is not made.
6029 Using 'patchmode' for compressed files appends the extension at the
6030 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6031 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006032 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006034 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 other systems: ".,,")
6037 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006039 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6040 provided that the file being searched for has a relative path (not
6041 starting with "/", "./" or "../"). The directories in the 'path'
6042 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043 - Use commas to separate directory names: >
6044 :set path=.,/usr/local/include,/usr/include
6045< - Spaces can also be used to separate directory names (for backwards
6046 compatibility with version 3.0). To have a space in a directory
6047 name, precede it with an extra backslash, and escape the space: >
6048 :set path=.,/dir/with\\\ space
6049< - To include a comma in a directory name precede it with an extra
6050 backslash: >
6051 :set path=.,/dir/with\\,comma
6052< - To search relative to the directory of the current file, use: >
6053 :set path=.
6054< - To search in the current directory use an empty string between two
6055 commas: >
6056 :set path=,,
6057< - A directory name may end in a ':' or '/'.
6058 - Environment variables are expanded |:set_env|.
6059 - When using |netrw.vim| URLs can be used. For example, adding
6060 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006061 - Search upwards and downwards in a directory tree using "*", "**" and
6062 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 - Careful with '\' characters, type two to get one in the option: >
6064 :set path=.,c:\\include
6065< Or just use '/' instead: >
6066 :set path=.,c:/include
6067< Don't forget "." or files won't even be found in the same directory as
6068 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006069 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 it is something like 256 or 1024 characters.
6071 You can check if all the include files are found, using the value of
6072 'path', see |:checkpath|.
6073 The use of |:set+=| and |:set-=| is preferred when adding or removing
6074 directories from the list. This avoids problems when a future version
6075 uses another default. To remove the current directory use: >
6076 :set path-=
6077< To add the current directory use: >
6078 :set path+=
6079< To use an environment variable, you probably need to replace the
6080 separator. Here is an example to append $INCL, in which directory
6081 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006082 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083< Replace the ';' with a ':' or whatever separator is used. Note that
6084 this doesn't work when $INCL contains a comma or white space.
6085
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006086 *'perldll'*
6087'perldll' string (default depends on the build)
6088 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006089 {only available when compiled with the |+perl/dyn|
6090 feature}
6091 Specifies the name of the Perl shared library. The default is
6092 DYNAMIC_PERL_DLL, which was specified at compile time.
6093 Environment variables are expanded |:set_env|.
6094 This option cannot be set from a |modeline| or in the |sandbox|, for
6095 security reasons.
6096
Bram Moolenaar071d4272004-06-13 20:20:40 +00006097 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6098'preserveindent' 'pi' boolean (default off)
6099 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 When changing the indent of the current line, preserve as much of the
6101 indent structure as possible. Normally the indent is replaced by a
6102 series of tabs followed by spaces as required (unless |'expandtab'| is
6103 enabled, in which case only spaces are used). Enabling this option
6104 means the indent will preserve as many existing characters as possible
6105 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006106 'expandtab' does not apply to the preserved white space, a Tab remains
6107 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 NOTE: When using ">>" multiple times the resulting indent is a mix of
6109 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006110 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 Also see 'copyindent'.
6112 Use |:retab| to clean up white space.
6113
6114 *'previewheight'* *'pvh'*
6115'previewheight' 'pvh' number (default 12)
6116 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006117 {not available when compiled without the |+quickfix|
6118 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006120 commands. Used for |CTRL-W_}| when no count is given. Not used when
6121 'previewpopup' is set.
6122
6123 *'previewpopup'* *'pvp'*
6124'previewpopup' 'pvp' string (default empty)
6125 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006126 {not available when compiled without the |+textprop|
6127 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006128 When not empty a popup window is used for commands that would open a
6129 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006130 Not used for the insert completion info, add "popup" to
6131 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132
6133 *'previewwindow'* *'nopreviewwindow'*
6134 *'pvw'* *'nopvw'* *E590*
6135'previewwindow' 'pvw' boolean (default off)
6136 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006137 {not available when compiled without the |+quickfix|
6138 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006139 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 set. It's normally not set directly, but by using one of the commands
6141 |:ptag|, |:pedit|, etc.
6142
6143 *'printdevice'* *'pdev'*
6144'printdevice' 'pdev' string (default empty)
6145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 {only available when compiled with the |+printer|
6147 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006148 The name of the printer to be used for |:hardcopy|.
6149 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006150 This option cannot be set from a |modeline| or in the |sandbox|, for
6151 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152
Bram Moolenaar8299df92004-07-10 09:47:34 +00006153 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006154'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 {only available when compiled with the |+printer|
6157 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006158 Sets the character encoding used when printing.
6159 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160
6161 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006162'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 {only available when compiled with the |+printer|
6165 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006166 Expression used to print the PostScript produced with |:hardcopy|.
6167 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006168 This option cannot be set from a |modeline| or in the |sandbox|, for
6169 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170
Bram Moolenaar8299df92004-07-10 09:47:34 +00006171 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172'printfont' 'pfn' string (default "courier")
6173 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 {only available when compiled with the |+printer|
6175 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006176 The name of the font that will be used for |:hardcopy|.
6177 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178
6179 *'printheader'* *'pheader'*
6180'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 {only available when compiled with the |+printer|
6183 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006184 The format of the header produced in |:hardcopy| output.
6185 See |pheader-option|.
6186
6187 *'printmbcharset'* *'pmbcs'*
6188'printmbcharset' 'pmbcs' string (default "")
6189 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006190 {only available when compiled with the |+printer|
6191 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006192 The CJK character set to be used for CJK output from |:hardcopy|.
6193 See |pmbcs-option|.
6194
6195 *'printmbfont'* *'pmbfn'*
6196'printmbfont' 'pmbfn' string (default "")
6197 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006198 {only available when compiled with the |+printer|
6199 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006200 List of font names to be used for CJK output from |:hardcopy|.
6201 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202
6203 *'printoptions'* *'popt'*
6204'printoptions' 'popt' string (default "")
6205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006207 List of items that control the format of the output of |:hardcopy|.
6208 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006210 *'prompt'* *'noprompt'*
6211'prompt' boolean (default on)
6212 global
6213 When on a ":" prompt is used in Ex mode.
6214
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006215 *'pumheight'* *'ph'*
6216'pumheight' 'ph' number (default 0)
6217 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006218 Determines the maximum number of items to show in the popup menu for
6219 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006220 |ins-completion-menu|.
6221
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006222 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006223'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006224 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006225 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006226 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006227
Bram Moolenaard94464e2015-11-02 15:28:18 +01006228 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006229'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006230 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006231 {only available when compiled with the |+python/dyn|
6232 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006233 Specifies the name of the Python 2.x shared library. The default is
6234 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006235 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006236 This option cannot be set from a |modeline| or in the |sandbox|, for
6237 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006238
Bram Moolenaar94073162018-01-31 21:49:05 +01006239 *'pythonhome'*
6240'pythonhome' string (default "")
6241 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006242 {only available when compiled with the |+python/dyn|
6243 feature}
6244 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6245 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6246 which was specified at compile time, will be used for the Python 2.x
6247 home directory.
6248 Environment variables are expanded |:set_env|.
6249 This option cannot be set from a |modeline| or in the |sandbox|, for
6250 security reasons.
6251
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006252 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006253'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006254 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006255 {only available when compiled with the |+python3/dyn|
6256 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006257 Specifies the name of the Python 3 shared library. The default is
6258 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006259 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006260 This option cannot be set from a |modeline| or in the |sandbox|, for
6261 security reasons.
6262
Bram Moolenaar94073162018-01-31 21:49:05 +01006263 *'pythonthreehome'*
6264'pythonthreehome' string (default "")
6265 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006266 {only available when compiled with the |+python3/dyn|
6267 feature}
6268 Specifies the name of the Python 3 home directory. When
6269 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6270 PYTHON3_HOME, which was specified at compile time, will be used for
6271 the Python 3 home directory.
6272 Environment variables are expanded |:set_env|.
6273 This option cannot be set from a |modeline| or in the |sandbox|, for
6274 security reasons.
6275
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006276 *'pyxversion'* *'pyx'*
6277'pyxversion' 'pyx' number (default depends on the build)
6278 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006279 {only available when compiled with the |+python| or
6280 the |+python3| feature}
6281 Specifies the python version used for pyx* functions and commands
6282 |python_x|. The default value is as follows:
6283
6284 Compiled with Default ~
6285 |+python| and |+python3| 0
6286 only |+python| 2
6287 only |+python3| 3
6288
6289 Available values are 0, 2 and 3.
6290 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6291 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6292 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6293 to 2 if Python 2 is available.
6294 See also: |has-pythonx|
6295
6296 If Vim is compiled with only |+python| or |+python3| setting
6297 'pyxversion' has no effect. The pyx* functions and commands are
6298 always the same as the compiled version.
6299
6300 This option cannot be set from a |modeline| or in the |sandbox|, for
6301 security reasons.
6302
Bram Moolenaar858ba062020-05-31 23:11:59 +02006303 *'quickfixtextfunc'* *'qftf'*
6304'quickfixtextfunc' 'qftf' string (default "")
6305 global
6306 {only available when compiled with the |+quickfix|
6307 feature}
6308 This option specifies a function to be used to get the text to display
6309 in the quickfix and location list windows. This can be used to
6310 customize the information displayed in the quickfix or location window
6311 for each entry in the corresponding quickfix or location list. See
6312 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006313 function and an example. The value can be the name of a function, a
6314 |lambda| or a |Funcref|. See |option-value-function| for more
6315 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006316
6317 This option cannot be set from a |modeline| or in the |sandbox|, for
6318 security reasons.
6319
Bram Moolenaar677ee682005-01-27 14:41:15 +00006320 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006321'quoteescape' 'qe' string (default "\")
6322 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006323 The characters that are used to escape quotes in a string. Used for
6324 objects like a', a" and a` |a'|.
6325 When one of the characters in this option is found inside a string,
6326 the following character will be skipped. The default value makes the
6327 text "foo\"bar\\" considered to be one string.
6328
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6330'readonly' 'ro' boolean (default off)
6331 local to buffer
6332 If on, writes fail unless you use a '!'. Protects you from
6333 accidentally overwriting a file. Default on when Vim is started
6334 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006335 When using ":w!" the 'readonly' option is reset for the current
6336 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006337 When using the ":view" command the 'readonly' option is set for the
6338 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006339 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006341 *'redrawtime'* *'rdt'*
6342'redrawtime' 'rdt' number (default 2000)
6343 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006344 {only available when compiled with the |+reltime|
6345 feature}
6346 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006347 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006348 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006349 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006350 matches will be highlighted.
6351 For syntax highlighting the time applies per window. When over the
6352 limit syntax highlighting is disabled until |CTRL-L| is used.
6353 This is used to avoid that Vim hangs when using a very complicated
6354 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006355
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006356 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006357'regexpengine' 're' number (default 0)
6358 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006359 This selects the default regexp engine. |two-engines|
6360 The possible values are:
6361 0 automatic selection
6362 1 old engine
6363 2 NFA engine
6364 Note that when using the NFA engine and the pattern contains something
6365 that is not supported the pattern will not match. This is only useful
6366 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006367 Using automatic selection enables Vim to switch the engine, if the
6368 default engine becomes too costly. E.g., when the NFA engine uses too
6369 many states. This should prevent Vim from hanging on a combination of
6370 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006371
Bram Moolenaar64486672010-05-16 15:46:46 +02006372 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6373'relativenumber' 'rnu' boolean (default off)
6374 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006375 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006376 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006377 precede some vertical motion commands (e.g. j k + -) with, without
6378 having to calculate it yourself. Especially useful in combination with
6379 other commands (e.g. y d c < > gq gw =).
6380 When the 'n' option is excluded from 'cpoptions' a wrapped
6381 line will not use the column of line numbers (this is the default when
6382 'compatible' isn't set).
6383 The 'numberwidth' option can be used to set the room used for the line
6384 number.
6385 When a long, wrapped line doesn't start with the first character, '-'
6386 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006387 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6388 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006389
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006390 The number in front of the cursor line also depends on the value of
6391 'number', see |number_relativenumber| for all combinations of the two
6392 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006393
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 *'remap'* *'noremap'*
6395'remap' boolean (default on)
6396 global
6397 Allows for mappings to work recursively. If you do not want this for
6398 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006399 NOTE: To avoid portability problems with Vim scripts, always keep
6400 this option at the default "on". Only switch it off when working with
6401 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006403 *'renderoptions'* *'rop'*
6404'renderoptions' 'rop' string (default: empty)
6405 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006406 {only available when compiled with GUI and DIRECTX on
6407 MS-Windows}
6408 Select a text renderer and set its options. The options depend on the
6409 renderer.
6410
6411 Syntax: >
6412 set rop=type:{renderer}(,{name}:{value})*
6413<
6414 Currently, only one optional renderer is available.
6415
6416 render behavior ~
6417 directx Vim will draw text using DirectX (DirectWrite). It makes
6418 drawn glyphs more beautiful than default GDI.
6419 It requires 'encoding' is "utf-8", and only works on
6420 MS-Windows Vista or newer version.
6421
6422 Options:
6423 name meaning type value ~
6424 gamma gamma float 1.0 - 2.2 (maybe)
6425 contrast enhancedContrast float (unknown)
6426 level clearTypeLevel float (unknown)
6427 geom pixelGeometry int 0 - 2 (see below)
6428 renmode renderingMode int 0 - 6 (see below)
6429 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006430 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006431
Bram Moolenaar92467d32017-12-05 13:22:16 +01006432 See this URL for detail (except for scrlines):
6433 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006434
6435 For geom: structure of a device pixel.
6436 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6437 1 - DWRITE_PIXEL_GEOMETRY_RGB
6438 2 - DWRITE_PIXEL_GEOMETRY_BGR
6439
6440 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006441 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006442
6443 For renmode: method of rendering glyphs.
6444 0 - DWRITE_RENDERING_MODE_DEFAULT
6445 1 - DWRITE_RENDERING_MODE_ALIASED
6446 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6447 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6448 4 - DWRITE_RENDERING_MODE_NATURAL
6449 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6450 6 - DWRITE_RENDERING_MODE_OUTLINE
6451
6452 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006453 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006454
6455 For taamode: antialiasing mode used for drawing text.
6456 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6457 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6458 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6459 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6460
6461 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006462 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6463
Bram Moolenaara338adc2018-01-31 20:51:47 +01006464 For scrlines:
6465 This was used for optimizing scrolling behavior, however this
6466 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006467
6468 Example: >
6469 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006470 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006471 set rop=type:directx
6472<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006473 If select a raster font (Courier, Terminal or FixedSys which
6474 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006475 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006476
6477 NOTE: It is known that some fonts and options combination
6478 causes trouble on drawing glyphs.
6479
Bram Moolenaar92467d32017-12-05 13:22:16 +01006480 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006481 special made fonts (True-Type fonts which includes only
6482 bitmap glyphs).
6483 - 'taamode:3' will not work with some vector fonts.
6484
6485 NOTE: With this option, you can display colored emoji
6486 (emoticon) in Windows 8.1 or later. To display colored emoji,
6487 there are some conditions which you should notice.
6488
6489 - If your font includes non-colored emoji already, it will
6490 be used.
6491 - If your font doesn't have emoji, the system chooses an
6492 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6493 will be used.
6494 - When this alternative font didn't have fixed width glyph,
6495 emoji might be rendered beyond the bounding box of drawing
6496 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006497
6498 Other render types are currently not supported.
6499
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 *'report'*
6501'report' number (default 2)
6502 global
6503 Threshold for reporting number of lines changed. When the number of
6504 changed lines is more than 'report' a message will be given for most
6505 ":" commands. If you want it always, set 'report' to 0.
6506 For the ":substitute" command the number of substitutions is used
6507 instead of the number of lines.
6508
6509 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6510'restorescreen' 'rs' boolean (default on)
6511 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006512 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 When set, the screen contents is restored when exiting Vim. This also
6514 happens when executing external commands.
6515
6516 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6517 options in your .vimrc. To disable restoring:
6518 set t_ti= t_te=
6519 To enable restoring (for an xterm):
6520 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6521 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6522
6523 *'revins'* *'ri'* *'norevins'* *'nori'*
6524'revins' 'ri' boolean (default off)
6525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 {only available when compiled with the |+rightleft|
6527 feature}
6528 Inserting characters in Insert mode will work backwards. See "typing
6529 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6530 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006531 NOTE: This option is reset when 'compatible' is set.
6532 This option is reset when 'paste' is set and restored when 'paste' is
6533 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534
6535 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6536'rightleft' 'rl' boolean (default off)
6537 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 {only available when compiled with the |+rightleft|
6539 feature}
6540 When on, display orientation becomes right-to-left, i.e., characters
6541 that are stored in the file appear from the right to the left.
6542 Using this option, it is possible to edit files for languages that
6543 are written from the right to the left such as Hebrew and Arabic.
6544 This option is per window, so it is possible to edit mixed files
6545 simultaneously, or to view the same file in both ways (this is
6546 useful whenever you have a mixed text file with both right-to-left
6547 and left-to-right strings so that both sets are displayed properly
6548 in different windows). Also see |rileft.txt|.
6549
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006550 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551'rightleftcmd' 'rlc' string (default "search")
6552 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 {only available when compiled with the |+rightleft|
6554 feature}
6555 Each word in this option enables the command line editing to work in
6556 right-to-left mode for a group of commands:
6557
6558 search "/" and "?" commands
6559
6560 This is useful for languages such as Hebrew, Arabic and Farsi.
6561 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6562
Bram Moolenaard94464e2015-11-02 15:28:18 +01006563 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006564'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006565 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006566 {only available when compiled with the |+ruby/dyn|
6567 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006568 Specifies the name of the Ruby shared library. The default is
6569 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006570 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006571 This option cannot be set from a |modeline| or in the |sandbox|, for
6572 security reasons.
6573
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006575'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006578 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 text in the file is shown on the far right:
6580 Top first line is visible
6581 Bot last line is visible
6582 All first and last line are visible
6583 45% relative position in the file
6584 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006585 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006586 ruler is shown there. Otherwise it is shown in the last line of the
6587 screen. If the statusline is given by 'statusline' (i.e. not empty),
6588 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006590 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 the text column (byte number) and the screen column are shown,
6592 separated with a dash.
6593 For an empty line "0-1" is shown.
6594 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006595 This option is reset when 'paste' is set and restored when 'paste' is
6596 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 If you don't want to see the ruler all the time but want to know where
6598 you are, use "g CTRL-G" |g_CTRL-G|.
6599 NOTE: This option is reset when 'compatible' is set.
6600
6601 *'rulerformat'* *'ruf'*
6602'rulerformat' 'ruf' string (default empty)
6603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 {not available when compiled without the |+statusline|
6605 feature}
6606 When this option is not empty, it determines the content of the ruler
6607 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006608 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006609 This option cannot be set in a modeline when 'modelineexpr' is off.
6610
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 The default ruler width is 17 characters. To make the ruler 15
6612 characters wide, put "%15(" at the start and "%)" at the end.
6613 Example: >
6614 :set rulerformat=%15(%c%V\ %p%%%)
6615<
6616 *'runtimepath'* *'rtp'* *vimfiles*
6617'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006618 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619 $VIM/vimfiles,
6620 $VIMRUNTIME,
6621 $VIM/vimfiles/after,
6622 $HOME/.vim/after"
6623 Amiga: "home:vimfiles,
6624 $VIM/vimfiles,
6625 $VIMRUNTIME,
6626 $VIM/vimfiles/after,
6627 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006628 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 $VIM/vimfiles,
6630 $VIMRUNTIME,
6631 $VIM/vimfiles/after,
6632 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006633 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 $VIMRUNTIME,
6635 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006636 Haiku: "$BE_USER_SETTINGS/vim,
6637 $VIM/vimfiles,
6638 $VIMRUNTIME,
6639 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006640 $BE_USER_SETTINGS/vim/after"
6641 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 $VIM/vimfiles,
6643 $VIMRUNTIME,
6644 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006645 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 This is a list of directories which will be searched for runtime
6648 files:
6649 filetype.vim filetypes by file name |new-filetype|
6650 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006651 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 colors/ color scheme files |:colorscheme|
6653 compiler/ compiler files |:compiler|
6654 doc/ documentation |write-local-help|
6655 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006656 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 indent/ indent scripts |indent-expression|
6658 keymap/ key mapping files |mbyte-keymap|
6659 lang/ menu translations |:menutrans|
6660 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006661 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 plugin/ plugin scripts |write-plugin|
6663 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006664 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 syntax/ syntax files |mysyntaxfile|
6666 tutor/ files for vimtutor |tutor|
6667
6668 And any other file searched for with the |:runtime| command.
6669
6670 The defaults for most systems are setup to search five locations:
6671 1. In your home directory, for your personal preferences.
6672 2. In a system-wide Vim directory, for preferences from the system
6673 administrator.
6674 3. In $VIMRUNTIME, for files distributed with Vim.
6675 *after-directory*
6676 4. In the "after" directory in the system-wide Vim directory. This is
6677 for the system administrator to overrule or add to the distributed
6678 defaults (rarely needed)
6679 5. In the "after" directory in your home directory. This is for
6680 personal preferences to overrule or add to the distributed defaults
6681 or system-wide settings (rarely needed).
6682
Bram Moolenaard0796902016-09-16 20:02:31 +02006683 More entries are added when using |packages|. If it gets very long
6684 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6685 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006686
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6688 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006689 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 wildcards.
6691 See |:runtime|.
6692 Example: >
6693 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6694< This will use the directory "~/vimruntime" first (containing your
6695 personal Vim runtime files), then "/mygroup/vim" (shared between a
6696 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6697 files).
6698 You probably should always include $VIMRUNTIME somewhere, to use the
6699 distributed runtime files. You can put a directory before $VIMRUNTIME
6700 to find files which replace a distributed runtime files. You can put
6701 a directory after $VIMRUNTIME to find files which add to distributed
6702 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006703 When Vim is started with |--clean| the home directory entries are not
6704 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 This option cannot be set from a |modeline| or in the |sandbox|, for
6706 security reasons.
6707
6708 *'scroll'* *'scr'*
6709'scroll' 'scr' number (default: half the window height)
6710 local to window
6711 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6712 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006713 changes. This may happen when enabling the |status-line| or
6714 'tabline' option after setting the 'scroll' option.
6715 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006716 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006717 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718
6719 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6720'scrollbind' 'scb' boolean (default off)
6721 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 See also |scroll-binding|. When this option is set, the current
6723 window scrolls as other scrollbind windows (windows that also have
6724 this option set) scroll. This option is useful for viewing the
6725 differences between two versions of a file, see 'diff'.
6726 See |'scrollopt'| for options that determine how this option should be
6727 interpreted.
6728 This option is mostly reset when splitting a window to edit another
6729 file. This means that ":split | edit file" results in two windows
6730 with scroll-binding, but ":split file" does not.
6731
Bram Moolenaarae20f342019-11-05 21:09:23 +01006732 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6733'scrollfocus' 'scf' boolean (default off)
6734 global
6735 {only for MS-Windows GUI}
6736 When using the scroll wheel and this option is set, the window under
6737 the mouse pointer is scrolled. With this option off the current
6738 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006739 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006740
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 *'scrolljump'* *'sj'*
6742'scrolljump' 'sj' number (default 1)
6743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 Minimal number of lines to scroll when the cursor gets off the
6745 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6746 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006747 When set to a negative number from -1 to -100 this is used as the
6748 percentage of the window height. Thus -50 scrolls half the window
6749 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 NOTE: This option is set to 1 when 'compatible' is set.
6751
6752 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006753'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006754 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 Minimal number of screen lines to keep above and below the cursor.
6756 This will make some context visible around where you are working. If
6757 you set it to a very large value (999) the cursor line will always be
6758 in the middle of the window (except at the start or end of the file or
6759 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006760 After using the local value, go back the global value with one of
6761 these two: >
6762 setlocal scrolloff<
6763 setlocal scrolloff=-1
6764< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 NOTE: This option is set to 0 when 'compatible' is set.
6766
6767 *'scrollopt'* *'sbo'*
6768'scrollopt' 'sbo' string (default "ver,jump")
6769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006770 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006771 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6772 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 The following words are available:
6774 ver Bind vertical scrolling for 'scrollbind' windows
6775 hor Bind horizontal scrolling for 'scrollbind' windows
6776 jump Applies to the offset between two windows for vertical
6777 scrolling. This offset is the difference in the first
6778 displayed line of the bound windows. When moving
6779 around in a window, another 'scrollbind' window may
6780 reach a position before the start or after the end of
6781 the buffer. The offset is not changed though, when
6782 moving back the 'scrollbind' window will try to scroll
6783 to the desired position when possible.
6784 When now making that window the current one, two
6785 things can be done with the relative offset:
6786 1. When "jump" is not included, the relative offset is
6787 adjusted for the scroll position in the new current
6788 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006789 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 2. When "jump" is included, the other windows are
6791 scrolled to keep the same relative offset. When
6792 going back to the other window, it still uses the
6793 same relative offset.
6794 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006795 When 'diff' mode is active there always is vertical scroll binding,
6796 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797
6798 *'sections'* *'sect'*
6799'sections' 'sect' string (default "SHNHH HUnhsh")
6800 global
6801 Specifies the nroff macros that separate sections. These are pairs of
6802 two letters (See |object-motions|). The default makes a section start
6803 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6804
6805 *'secure'* *'nosecure'* *E523*
6806'secure' boolean (default off)
6807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 When on, ":autocmd", shell and write commands are not allowed in
6809 ".vimrc" and ".exrc" in the current directory and map commands are
6810 displayed. Switch it off only if you know that you will not run into
6811 problems, or when the 'exrc' option is off. On Unix this option is
6812 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006813 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 'secure' at the end of your ~/.vimrc then.
6815 This option cannot be set from a |modeline| or in the |sandbox|, for
6816 security reasons.
6817
6818 *'selection'* *'sel'*
6819'selection' 'sel' string (default "inclusive")
6820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 This option defines the behavior of the selection. It is only used
6822 in Visual and Select mode.
6823 Possible values:
6824 value past line inclusive ~
6825 old no yes
6826 inclusive yes yes
6827 exclusive yes no
6828 "past line" means that the cursor is allowed to be positioned one
6829 character past the line.
6830 "inclusive" means that the last character of the selection is included
6831 in an operation. For example, when "x" is used to delete the
6832 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006833 When "old" is used and 'virtualedit' allows the cursor to move past
6834 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 Note that when "exclusive" is used and selecting from the end
6836 backwards, you cannot include the last character of a line, when
6837 starting in Normal mode and 'virtualedit' empty.
6838
6839 The 'selection' option is set by the |:behave| command.
6840
6841 *'selectmode'* *'slm'*
6842'selectmode' 'slm' string (default "")
6843 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006844 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 Select mode instead of Visual mode, when a selection is started.
6846 Possible values:
6847 mouse when using the mouse
6848 key when using shifted special keys
6849 cmd when using "v", "V" or CTRL-V
6850 See |Select-mode|.
6851 The 'selectmode' option is set by the |:behave| command.
6852
6853 *'sessionoptions'* *'ssop'*
6854'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006855 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006857 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 feature}
6859 Changes the effect of the |:mksession| command. It is a comma
6860 separated list of words. Each word enables saving and restoring
6861 something:
6862 word save and restore ~
6863 blank empty windows
6864 buffers hidden and unloaded buffers, not just those in windows
6865 curdir the current directory
6866 folds manually created folds, opened/closed folds and local
6867 fold options
6868 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006869 and contain at least one lowercase letter. Only
6870 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 help the help window
6872 localoptions options and mappings local to a window or buffer (not
6873 global values for local options)
6874 options all options and mappings (also global values for local
6875 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006876 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 resize size of the Vim window: 'lines' and 'columns'
6878 sesdir the directory in which the session file is located
6879 will become the current directory (useful with
6880 projects accessed over a network from different
6881 systems)
6882 slash backslashes in file names replaced with forward
6883 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006884 tabpages all tab pages; without this only the current tab page
6885 is restored, so that you can make a session for each
6886 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006887 terminal include terminal windows where the command can be
6888 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 unix with Unix end-of-line format (single <NL>), even when
6890 on Windows or DOS
6891 winpos position of the whole Vim window
6892 winsize window sizes
6893
6894 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006895 When neither "curdir" nor "sesdir" is included, file names are stored
6896 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006897 If you leave out "options" many things won't work well after restoring
6898 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 "slash" and "unix" are useful on Windows when sharing session files
6900 with Unix. The Unix version of Vim cannot source dos format scripts,
6901 but the Windows version of Vim can source unix format scripts.
6902
6903 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006904'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 global
6906 Name of the shell to use for ! and :! commands. When changing the
6907 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6908 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006909 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 See |option-backslash| about including spaces and backslashes.
6911 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006912
Bram Moolenaara2baa732022-02-04 16:09:54 +00006913 In |restricted-mode| shell commands will not be possible. This mode
6914 is used if the value of $SHELL ends in "false" or "nologin".
6915
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006916 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006917 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6919< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006920 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006922 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006924 Example with escaped space (Vim will do this when initializing the
6925 option from $SHELL): >
6926 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006927< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006928 backslashes are consumed by `:set`.
6929
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 Under MS-Windows, when the executable ends in ".com" it must be
6931 included. Thus setting the shell to "command.com" or "4dos.com"
6932 works, but "command" and "4dos" do not work for all commands (e.g.,
6933 filtering).
6934 For unknown reasons, when using "4dos.com" the current directory is
6935 changed to "C:\". To avoid this set 'shell' like this: >
6936 :set shell=command.com\ /c\ 4dos
6937< This option cannot be set from a |modeline| or in the |sandbox|, for
6938 security reasons.
6939
6940 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006941'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006942 Win32, when 'shell' contains "powershell":
6943 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006944 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006947 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6948 For MS-Windows, the default is set according to the value of 'shell',
6949 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006950 On Unix it can have more than one flag. Each white space separated
6951 part is passed as an argument to the shell command.
6952 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006953 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 This option cannot be set from a |modeline| or in the |sandbox|, for
6955 security reasons.
6956
6957 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006958'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6959 "2>&1| tee", or
6960 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 {not available when compiled without the |+quickfix|
6963 feature}
6964 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006965 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 including spaces and backslashes.
6967 The name of the temporary file can be represented by "%s" if necessary
6968 (the file name is appended automatically if no %s appears in the value
6969 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006970 For the Amiga the default is ">". For MS-Windows using powershell the
6971 default is "2>&1 | Out-File -Encoding default", otherwise the default
6972 is ">%s 2>&1". The output is directly saved in a file and not echoed
6973 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006974 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 in a file and echoed to the screen. If the 'shell' option is "csh" or
6976 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006977 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006978 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6979 means that stderr is also included. Before using the 'shell' option a
6980 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006981 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6982 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 The initialization of this option is done after reading the ".vimrc"
6984 and the other initializations, so that when the 'shell' option is set
6985 there, the 'shellpipe' option changes automatically, unless it was
6986 explicitly set before.
6987 When 'shellpipe' is set to an empty string, no redirection of the
6988 ":make" output will be done. This is useful if you use a 'makeprg'
6989 that writes to 'makeef' by itself. If you want no piping, but do
6990 want to include the 'makeef', set 'shellpipe' to a single space.
6991 Don't forget to precede the space with a backslash: ":set sp=\ ".
6992 In the future pipes may be used for filtering and this option will
6993 become obsolete (at least for Unix).
6994 This option cannot be set from a |modeline| or in the |sandbox|, for
6995 security reasons.
6996
6997 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006998'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 Quoting character(s), put around the command passed to the shell, for
7001 the "!" and ":!" commands. The redirection is kept outside of the
7002 quoting. See 'shellxquote' to include the redirection. It's
7003 probably not useful to set both options.
7004 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007005 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007006 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007 This option cannot be set from a |modeline| or in the |sandbox|, for
7008 security reasons.
7009
7010 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007011'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7012 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 String to be used to put the output of a filter command in a temporary
7015 file. See also |:!|. See |option-backslash| about including spaces
7016 and backslashes.
7017 The name of the temporary file can be represented by "%s" if necessary
7018 (the file name is appended automatically if no %s appears in the value
7019 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007020 The default is ">". For Unix, if the 'shell' option is "csh" or
7021 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007022 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007023 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7024 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007025 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7026 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007027 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7028 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 The initialization of this option is done after reading the ".vimrc"
7030 and the other initializations, so that when the 'shell' option is set
7031 there, the 'shellredir' option changes automatically unless it was
7032 explicitly set before.
7033 In the future pipes may be used for filtering and this option will
7034 become obsolete (at least for Unix).
7035 This option cannot be set from a |modeline| or in the |sandbox|, for
7036 security reasons.
7037
7038 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7039'shellslash' 'ssl' boolean (default off)
7040 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007041 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007043 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007044 powershell.exe. Backward slashes can still be typed, but they are
7045 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 Note that setting or resetting this option has no effect for some
7047 existing file names, thus this option needs to be set before opening
7048 any file for best results. This might change in the future.
7049 'shellslash' only works when a backslash can be used as a path
7050 separator. To test if this is so use: >
7051 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007052< Also see 'completeslash'.
7053
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007054 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7055'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7056 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007057 When on, use temp files for shell commands. When off use a pipe.
7058 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007059 Currently a pipe is only supported on Unix and MS-Windows 2K and
7060 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007061 :if has("filterpipe")
7062< The advantage of using a pipe is that nobody can read the temp file
7063 and the 'shell' command does not need to support redirection.
7064 The advantage of using a temp file is that the file type and encoding
7065 can be detected.
7066 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7067 |FilterWritePost| autocommands event are not triggered when
7068 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007069 The `system()` function does not respect this option and always uses
7070 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007071 NOTE: This option is set to the Vim default value when 'compatible'
7072 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007073
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 *'shelltype'* *'st'*
7075'shelltype' 'st' number (default 0)
7076 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007077 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 On the Amiga this option influences the way how the commands work
7079 which use a shell.
7080 0 and 1: always use the shell
7081 2 and 3: use the shell only to filter lines
7082 4 and 5: use shell only for ':sh' command
7083 When not using the shell, the command is executed directly.
7084
7085 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7086 1 and 3: use "shell cmd" to start external commands
7087
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007088 *'shellxescape'* *'sxe'*
7089'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007090 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007091 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007092 When 'shellxquote' is set to "(" then the characters listed in this
7093 option will be escaped with a '^' character. This makes it possible
7094 to execute most external commands with cmd.exe.
7095
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 *'shellxquote'* *'sxq'*
7097'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007098 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007099 for Win32, when 'shell' is
7100 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007101 for Win32, when 'shell' contains "sh"
7102 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 for Unix, when using system(): "\"")
7104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 Quoting character(s), put around the command passed to the shell, for
7106 the "!" and ":!" commands. Includes the redirection. See
7107 'shellquote' to exclude the redirection. It's probably not useful
7108 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007109 When the value is '(' then ')' is appended. When the value is '"('
7110 then ')"' is appended.
7111 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007112 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007113 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7114 pwsh.exe which automatically strips off the first and last quote on a
7115 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7116 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007117 'shell', to reduce the need to set this option by the user. See
7118 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 This option cannot be set from a |modeline| or in the |sandbox|, for
7120 security reasons.
7121
7122 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7123'shiftround' 'sr' boolean (default off)
7124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 Round indent to multiple of 'shiftwidth'. Applies to > and <
7126 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7127 a multiple of 'shiftwidth' (this is Vi compatible).
7128 NOTE: This option is reset when 'compatible' is set.
7129
7130 *'shiftwidth'* *'sw'*
7131'shiftwidth' 'sw' number (default 8)
7132 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007133 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007135 When zero the 'ts' value will be used. Use the |shiftwidth()|
7136 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137
7138 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007139'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7140 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007141 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 This option helps to avoid all the |hit-enter| prompts caused by file
7143 messages, for example with CTRL-G, and to avoid some other messages.
7144 It is a list of flags:
7145 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007146 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7147 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7148 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7149 m use "[+]" instead of "[Modified]" *shm-m*
7150 n use "[New]" instead of "[New File]" *shm-n*
7151 r use "[RO]" instead of "[readonly]" *shm-r*
7152 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007154 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7155 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007156 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007157 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007159 o overwrite message for writing a file with subsequent *shm-o*
7160 message for reading a file (useful for ":wn" or when
7161 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007162 O message for reading a file overwrites any previous *shm-O*
7163 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007164 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7165 "search hit TOP, continuing at BOTTOM" messages; when using
7166 the search count do not show "W" after the count message (see
7167 S below)
7168 t truncate file message at the start if it is too long *shm-t*
7169 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007170 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007171 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007172 long to fit on the command line; "..." will appear in the
7173 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007174 W don't give "written" or "[w]" when writing a file *shm-W*
7175 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007176 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007177 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007178 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007179 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007180 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7181 match", "Pattern not found", "Back at original", etc.
7182 C don't give messages while scanning for ins-completion *shm-C*
7183 items, for instance "scanning tags"
7184 q use "recording" instead of "recording @a" *shm-q*
7185 F don't give the file info when editing a file, like *shm-F*
7186 `:silent` was used for the command; note that this also
7187 affects messages from autocommands
Bram Moolenaar938ae282023-02-20 20:44:55 +00007188 S do not show search count message when searching, e.g. *shm-S*
7189 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190
7191 This gives you the opportunity to avoid that a change between buffers
7192 requires you to hit <Enter>, but still gives as useful a message as
7193 possible for the space available. To get the whole message that you
7194 would have got with 'shm' empty, use ":file!"
7195 Useful values:
7196 shm= No abbreviation of message.
7197 shm=a Abbreviation, but no loss of information.
7198 shm=at Abbreviation, and truncate message when necessary.
7199
7200 NOTE: This option is set to the Vi default value when 'compatible' is
7201 set and to the Vim default value when 'compatible' is reset.
7202
7203 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7204'shortname' 'sn' boolean (default off)
7205 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 Filenames are assumed to be 8 characters plus one extension of 3
7207 characters. Multiple dots in file names are not allowed. When this
7208 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007209 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007211 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212
7213 *'showbreak'* *'sbr'* *E595*
7214'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007215 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007216 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 feature}
7218 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007219 values are "> " or "+++ ": >
7220 :set showbreak=>\
7221< Note the backslash to escape the trailing space. It's easier like
7222 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007223 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007224< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 comma (in a future version the comma might be used to separate the
7226 part that is shown at the end and at the start of a line).
7227 The characters are highlighted according to the '@' flag in
7228 'highlight'.
7229 Note that tabs after the showbreak will be displayed differently.
7230 If you want the 'showbreak' to appear in between line numbers, add the
7231 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007232 A window-local value overrules a global value. If the global value is
7233 set and you want no value in the current window use NONE: >
7234 :setlocal showbreak=NONE
7235<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007237'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7238 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007240 Show (partial) command in the last line of the screen. Set this
7241 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 In Visual mode the size of the selected area is shown:
7243 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007244 If the number of bytes is different it is also displayed: "2-6"
7245 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007247 - When selecting a block, the size in screen characters:
7248 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007249 This information can be displayed in an alternative location using the
7250 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251 NOTE: This option is set to the Vi default value when 'compatible' is
7252 set and to the Vim default value when 'compatible' is reset.
7253
Luuk van Baalba936f62022-12-15 13:15:39 +00007254 *'showcmdloc'* *'sloc'*
7255'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007256 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007257 This option can be used to display the (partially) entered command in
7258 another location. Possible values are:
7259 last Last line of the screen (default).
7260 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007261 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007262 Setting this option to "statusline" or "tabline" means that these will
7263 be redrawn whenever the command changes, which can be on every key
7264 pressed.
7265 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7266 place the text. Without a custom 'statusline' or 'tabline' it will be
7267 displayed in a convenient location.
7268
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7270'showfulltag' 'sft' boolean (default off)
7271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 When completing a word in insert mode (see |ins-completion|) from the
7273 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007274 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 matched a C function, you can see a template for what arguments are
7276 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007277 Note that this doesn't work well together with having "longest" in
7278 'completeopt', because the completion from the search pattern may not
7279 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280
7281 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7282'showmatch' 'sm' boolean (default off)
7283 global
7284 When a bracket is inserted, briefly jump to the matching one. The
7285 jump is only done if the match can be seen on the screen. The time to
7286 show the match can be set with 'matchtime'.
7287 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007288 seen or not).
7289 This option is reset when 'paste' is set and restored when 'paste' is
7290 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291 When the 'm' flag is not included in 'cpoptions', typing a character
7292 will immediately move the cursor back to where it belongs.
7293 See the "sm" field in 'guicursor' for setting the cursor shape and
7294 blinking when showing the match.
7295 The 'matchpairs' option can be used to specify the characters to show
7296 matches for. 'rightleft' and 'revins' are used to look for opposite
7297 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007298 Also see the matchparen plugin for highlighting the match when moving
7299 around |pi_paren.txt|.
7300 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301
7302 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7303'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7304 global
7305 If in Insert, Replace or Visual mode put a message on the last line.
7306 Use the 'M' flag in 'highlight' to set the type of highlighting for
7307 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007308 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 doesn't mean XIM is really active, especially when 'imactivatekey' is
7310 not set.
7311 NOTE: This option is set to the Vi default value when 'compatible' is
7312 set and to the Vim default value when 'compatible' is reset.
7313
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007314 *'showtabline'* *'stal'*
7315'showtabline' 'stal' number (default 1)
7316 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007317 The value of this option specifies when the line with tab page labels
7318 will be displayed:
7319 0: never
7320 1: only if there are at least two tab pages
7321 2: always
7322 This is both for the GUI and non-GUI implementation of the tab pages
7323 line.
7324 See |tab-page| for more information about tab pages.
7325
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 *'sidescroll'* *'ss'*
7327'sidescroll' 'ss' number (default 0)
7328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 The minimal number of columns to scroll horizontally. Used only when
7330 the 'wrap' option is off and the cursor is moved off of the screen.
7331 When it is zero the cursor will be put in the middle of the screen.
7332 When using a slow terminal set it to a large number or 0. When using
7333 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7334 commands.
7335
7336 *'sidescrolloff'* *'siso'*
7337'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007338 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007340 right of the cursor if 'nowrap' is set. Setting this option to a
7341 value greater than 0 while having |'sidescroll'| also at a non-zero
7342 value makes some context visible in the line you are scrolling in
7343 horizontally (except at beginning of the line). Setting this option
7344 to a large value (like 999) has the effect of keeping the cursor
7345 horizontally centered in the window, as long as one does not come too
7346 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007347 After using the local value, go back the global value with one of
7348 these two: >
7349 setlocal sidescrolloff<
7350 setlocal sidescrolloff=-1
7351< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352
7353 Example: Try this together with 'sidescroll' and 'listchars' as
7354 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007355 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356
7357 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7358 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007359<
7360 *'signcolumn'* *'scl'*
7361'signcolumn' 'scl' string (default "auto")
7362 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007363 {not available when compiled without the |+signs|
7364 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007365 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007366 "auto" only when there is a sign to display
7367 "no" never
7368 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007369 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007370 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371
7372
7373 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7374'smartcase' 'scs' boolean (default off)
7375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 Override the 'ignorecase' option if the search pattern contains upper
7377 case characters. Only used when the search pattern is typed and
7378 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007379 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7381 recalling the search pattern from history and hitting <Enter>.
7382 NOTE: This option is reset when 'compatible' is set.
7383
7384 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7385'smartindent' 'si' boolean (default off)
7386 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 Do smart autoindenting when starting a new line. Works for C-like
7388 programs, but can also be used for other languages. 'cindent' does
7389 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007390 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007391 setting 'si' has no effect. 'indentexpr' is a more advanced
7392 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 Normally 'autoindent' should also be on when using 'smartindent'.
7394 An indent is automatically inserted:
7395 - After a line ending in '{'.
7396 - After a line starting with a keyword from 'cinwords'.
7397 - Before a line starting with '}' (only with the "O" command).
7398 When typing '}' as the first character in a new line, that line is
7399 given the same indent as the matching '{'.
7400 When typing '#' as the first character in a new line, the indent for
7401 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007402 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7404 When using the ">>" command, lines starting with '#' are not shifted
7405 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007406 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007407 This option is reset when 'paste' is set and restored when 'paste' is
7408 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409
7410 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7411'smarttab' 'sta' boolean (default off)
7412 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007414 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7415 <BS> will delete a 'shiftwidth' worth of space at the start of the
7416 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007417 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007418 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7419 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007420 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007422 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007423 This option is reset when 'paste' is set and restored when 'paste' is
7424 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425 NOTE: This option is reset when 'compatible' is set.
7426
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007427 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7428'smoothscroll' 'sms' boolean (default off)
7429 local to window
7430 Scrolling works with screen lines. When 'wrap' is set and the first
7431 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007432 above the window. "<<<" is displayed at the start of the first line,
7433 highlighted with |hl-NonText|.
7434 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
7435 and scrolling with the mouse.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007436
Bram Moolenaar071d4272004-06-13 20:20:40 +00007437 *'softtabstop'* *'sts'*
7438'softtabstop' 'sts' number (default 0)
7439 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 Number of spaces that a <Tab> counts for while performing editing
7441 operations, like inserting a <Tab> or using <BS>. It "feels" like
7442 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7443 used. This is useful to keep the 'ts' setting at its standard value
7444 of 8, while being able to edit like it is set to 'sts'. However,
7445 commands like "x" still work on the actual characters.
7446 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007447 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007448 'softtabstop' is set to 0 when the 'paste' option is set and restored
7449 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7451 spaces is minimized by using <Tab>s.
7452 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7453 set.
7454 NOTE: This option is set to 0 when 'compatible' is set.
7455
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007456 If Vim is compiled with the |+vartabs| feature then the value of
7457 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7458 anything other than an empty string.
7459
Bram Moolenaar217ad922005-03-20 22:37:15 +00007460 *'spell'* *'nospell'*
7461'spell' boolean (default off)
7462 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007463 {not available when compiled without the |+syntax|
7464 feature}
7465 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007466 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007467
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007468 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007469'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007470 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007471 {not available when compiled without the |+syntax|
7472 feature}
7473 Pattern to locate the end of a sentence. The following word will be
7474 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007475 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007476 When this check is not wanted make this option empty.
7477 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007478 Be careful with special characters, see |option-backslash| about
7479 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007480 To set this option automatically depending on the language, see
7481 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007482
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007483 *'spellfile'* *'spf'*
7484'spellfile' 'spf' string (default empty)
7485 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007486 {not available when compiled without the |+syntax|
7487 feature}
7488 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007489 commands. It must end in ".{encoding}.add". You need to include the
7490 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007491 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007492 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007493 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007494 |zg| and |zw| commands can be used to access each. This allows using
7495 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007496 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007497 you: Using the first directory in 'runtimepath' that is writable. If
7498 there is no "spell" directory yet it will be created. For the file
7499 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007500 ignoring the region.
7501 The resulting ".spl" file will be used for spell checking, it does not
7502 have to appear in 'spelllang'.
7503 Normally one file is used for all regions, but you can add the region
7504 name if you want to. However, it will then only be used when
7505 'spellfile' is set to it, for entries in 'spelllang' only files
7506 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007507 This option cannot be set from a |modeline| or in the |sandbox|, for
7508 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007509
Bram Moolenaar217ad922005-03-20 22:37:15 +00007510 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007511'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007512 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007513 {not available when compiled without the |+syntax|
7514 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007515 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007516 on spellchecking will be done for these languages. Example: >
7517 set spelllang=en_us,nl,medical
7518< This means US English, Dutch and medical words are recognized. Words
7519 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007520 The word list name must consist of alphanumeric characters, a dash or
7521 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007522 recommended to separate the two letter language name from a
7523 specification. Thus "en-rare" is used for rare English words.
7524 A region name must come last and have the form "_xx", where "xx" is
7525 the two-letter, lower case region name. You can use more than one
7526 region by listing them: "en_us,en_ca" supports both US and Canadian
7527 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007528 Britain. (Note: currently en_au and en_nz dictionaries are older than
7529 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007530 If the name "cjk" is included East Asian characters are excluded from
7531 spell checking. This is useful when editing text that also has Asian
7532 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007533 Note that the "medical" dictionary does not exist, it is just an
7534 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007535 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007536 As a special case the name of a .spl file can be given as-is. The
7537 first "_xx" in the name is removed and used as the region name
7538 (_xx is an underscore, two letters and followed by a non-letter).
7539 This is mainly for testing purposes. You must make sure the correct
7540 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007541 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007542 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7543 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007544 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007545
Bram Moolenaar98692072006-02-04 00:57:42 +00007546 If the |spellfile.vim| plugin is active and you use a language name
7547 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7548 will ask you if you want to download the file.
7549
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007550 After this option has been set successfully, Vim will source the files
7551 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007552 up to the first character that is not an ASCII letter or number and
7553 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007554
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007555 *'spelloptions'* *'spo'*
7556'spelloptions' 'spo' string (default "")
7557 local to buffer
7558 {not available when compiled without the |+syntax|
7559 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007560 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007561 camel When a word is CamelCased, assume "Cased" is a
7562 separate word: every upper-case character in a word
7563 that comes after a lower case character indicates the
7564 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007565
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007566 *'spellsuggest'* *'sps'*
7567'spellsuggest' 'sps' string (default "best")
7568 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007569 {not available when compiled without the |+syntax|
7570 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007571 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007572 the |spellsuggest()| function. This is a comma-separated list of
7573 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007574
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007575 best Internal method that works best for English. Finds
7576 changes like "fast" and uses a bit of sound-a-like
7577 scoring to improve the ordering.
7578
7579 double Internal method that uses two methods and mixes the
7580 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007581 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007582 word. That only works when the language specifies
7583 sound folding. Can be slow and doesn't always give
7584 better results.
7585
7586 fast Internal method that only checks for simple changes:
7587 character inserts/deletes/swaps. Works well for
7588 simple typing mistakes.
7589
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007590 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007591 Not used for |spellsuggest()|. The number of
7592 suggestions is never more than the value of 'lines'
7593 minus two.
7594
Bram Moolenaar585ee072022-01-29 11:22:17 +00007595 timeout:{millisec} Limit the time searching for suggestions to
7596 {millisec} milli seconds. Applies to the following
7597 methods. When omitted the limit is 5000. When
7598 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007599 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007600
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007601 file:{filename} Read file {filename}, which must have two columns,
7602 separated by a slash. The first column contains the
7603 bad word, the second column the suggested good word.
7604 Example:
7605 theribal/terrible ~
7606 Use this for common mistakes that do not appear at the
7607 top of the suggestion list with the internal methods.
7608 Lines without a slash are ignored, use this for
7609 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007610 The word in the second column must be correct,
7611 otherwise it will not be used. Add the word to an
7612 ".add" file if it is currently flagged as a spelling
7613 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007614 The file is used for all languages.
7615
7616 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007617 trouble with spaces. Best is to call a function
7618 without arguments, see |expr-option-function|.
7619 |v:val| holds the badly spelled word. The expression
7620 must evaluate to a List of Lists, each with a
7621 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007622 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007623 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007624 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007625 internal methods use. A lower score is better.
7626 This may invoke |spellsuggest()| if you temporarily
7627 set 'spellsuggest' to exclude the "expr:" part.
7628 Errors are silently ignored, unless you set the
7629 'verbose' option to a non-zero value.
7630
7631 Only one of "best", "double" or "fast" may be used. The others may
7632 appear several times in any order. Example: >
7633 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7634<
7635 This option cannot be set from a |modeline| or in the |sandbox|, for
7636 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007637
7638
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7640'splitbelow' 'sb' boolean (default off)
7641 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 When on, splitting a window will put the new window below the current
7643 one. |:split|
7644
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007645 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007646'splitkeep' 'spk' string (default "cursor")
7647 global
7648 The value of this option determines the scroll behavior when opening,
7649 closing or resizing horizontal splits.
7650
7651 Possible values are:
7652 cursor Keep the same relative cursor position.
7653 screen Keep the text on the same screen line.
7654 topline Keep the topline the same.
7655
7656 For the "screen" and "topline" values, the cursor position will be
7657 changed when necessary. In this case, the jumplist will be populated
7658 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007659 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007660
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7662'splitright' 'spr' boolean (default off)
7663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 When on, splitting a window will put the new window right of the
7665 current one. |:vsplit|
7666
7667 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7668'startofline' 'sol' boolean (default on)
7669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007671 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007672 (if possible). This applies to the commands:
7673 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7674 - "d", "<<" and ">>" with a linewise operator
7675 - "%" with a count
7676 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7677 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 In case of buffer changing commands the cursor is placed at the column
7679 where it was the last time the buffer was edited.
7680 NOTE: This option is set when 'compatible' is set.
7681
Bram Moolenaar00654022011-02-25 14:42:19 +01007682 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007684 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685 {not available when compiled without the |+statusline|
7686 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007687 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 Also see |status-line|.
7689
7690 The option consists of printf style '%' items interspersed with
7691 normal text. Each status line item is of the form:
7692 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007693 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007694 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695
Bram Moolenaar238a5642006-02-21 22:12:05 +00007696 When the option starts with "%!" then it is used as an expression,
7697 evaluated and the result is used as the option value. Example: >
7698 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007699< The *g:statusline_winid* variable will be set to the |window-ID| of the
7700 window that the status line belongs to.
7701 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007702 Note that the "%!" expression is evaluated in the context of the
7703 current window and buffer, while %{} items are evaluated in the
7704 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007705
7706 When there is error while evaluating the option then it will be made
7707 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007708 When the result contains unprintable characters the result is
7709 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007710
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 Note that the only effect of 'ruler' when this option is set (and
7712 'laststatus' is 2) is controlling the output of |CTRL-G|.
7713
7714 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007715 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007717 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 minwid Minimum width of the item, padding as set by '-' & '0'.
7719 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007720 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721 on the left for text items. Numeric items will be
7722 shifted down to maxwid-2 digits followed by '>'number
7723 where number is the amount of missing digits, much like
7724 an exponential notation.
7725 item A one letter code as described below.
7726
7727 Following is a description of the possible statusline items. The
7728 second character in "item" is the type:
7729 N for number
7730 S for string
7731 F for flags as described below
7732 - not applicable
7733
7734 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007735 f S Path to the file in the buffer, as typed or relative to current
7736 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 F S Full path to the file in the buffer.
7738 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007739 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007741 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007743 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007745 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007747 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007749 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7751 being used: "<keymap>"
7752 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007753 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007754 B N As above, in hexadecimal.
7755 o N Byte number in file of byte under cursor, first byte is 1.
7756 Mnemonic: Offset from start of file (with one added)
7757 {not available when compiled without |+byte_offset| feature}
7758 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007759 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 l N Line number.
7761 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007762 c N Column number (byte index).
7763 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007764 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 p N Percentage through file in lines as in |CTRL-G|.
7766 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007767 percentage described for 'ruler'. Always 3 in length, unless
7768 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007769 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007770 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007772 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007773 Note that there is no '%' before the closing '}'. The
7774 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007775 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007776 {% - This is almost same as { except the result of the expression is
7777 re-evaluated as a statusline format string. Thus if the
7778 return value of expr contains % items they will get expanded.
7779 The expression can contain the } character, the end of
7780 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007781 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007782 func! Stl_filename() abort
7783 return "%t"
7784 endfunc
7785< `stl=%{Stl_filename()}` results in `"%t"`
7786 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007787 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 ( - Start of item group. Can be used for setting the width and
7789 alignment of a section. Must be followed by %) somewhere.
7790 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007791 T N For 'tabline': start of tab page N label. Use %T after the last
7792 label. This information is used for mouse clicks.
7793 X N For 'tabline': start of close tab N label. Use %X after the
7794 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7795 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 < - Where to truncate line if too long. Default is at the start.
7797 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007798 = - Separation point between alignment sections. Each section will
7799 be separated by an equal number of spaces. With one %= what
7800 comes after it will be right-aligned. With two %= there is a
7801 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007803 # - Set highlight group. The name must follow and then a # again.
7804 Thus use %#HLname# for highlight group HLname. The same
7805 highlighting is used, also for the statusline of non-current
7806 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007808 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007809 The difference between User{N} and StatusLine will be applied to
7810 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 The number N must be between 1 and 9. See |hl-User1..9|
7812
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007813 When displaying a flag, Vim removes the leading comma, if any, when
7814 that flag comes right after plaintext. This will make a nice display
7815 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816
Bram Moolenaar582fd852005-03-28 20:58:01 +00007817 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 not set) and a minwid is not set for the group, the whole group will
7819 become empty. This will make a group like the following disappear
7820 completely from the statusline when none of the flags are set. >
7821 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007822< Beware that an expression is evaluated each and every time the status
7823 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007824 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007825 While evaluating %{} the current buffer and current window will be set
7826 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007827 currently being drawn. The expression will evaluate in this context.
7828 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7829 real current buffer and "g:actual_curwin" to the |window-ID| of the
7830 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007831
Bram Moolenaar30b65812012-07-12 22:01:11 +02007832 The 'statusline' option will be evaluated in the |sandbox| if set from
7833 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007834 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007835
7836 It is not allowed to change text or jump to another window while
7837 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838
7839 If the statusline is not updated when you want it (e.g., after setting
7840 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007841 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007843 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007844 Otherwise the result is taken as flag text and applied to the rules
7845 described above.
7846
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007847 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007849 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850
7851 Examples:
7852 Emulate standard status line with 'ruler' set >
7853 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7854< Similar, but add ASCII value of char under the cursor (like "ga") >
7855 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7856< Display byte count and byte value, modified flag in red. >
7857 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7858 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7859< Display a ,GZ flag if a compressed file is loaded >
7860 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7861< In the |:autocmd|'s: >
7862 :let b:gzflag = 1
7863< And: >
7864 :unlet b:gzflag
7865< And define this function: >
7866 :function VarExists(var, val)
7867 : if exists(a:var) | return a:val | else | return '' | endif
7868 :endfunction
7869<
7870 *'suffixes'* *'su'*
7871'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 Files with these suffixes get a lower priority when multiple files
7874 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007875 suffixes. Spaces after the comma are ignored. A dot is also seen as
7876 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 separator, precede it with a backslash (see |option-backslash| about
7878 including spaces and backslashes).
7879 See 'wildignore' for completely ignoring files.
7880 The use of |:set+=| and |:set-=| is preferred when adding or removing
7881 suffixes from the list. This avoids problems when a future version
7882 uses another default.
7883
7884 *'suffixesadd'* *'sua'*
7885'suffixesadd' 'sua' string (default "")
7886 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007887 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 file for the "gf", "[I", etc. commands. Example: >
7889 :set suffixesadd=.java
7890<
7891 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7892'swapfile' 'swf' boolean (default on)
7893 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007894 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007895 swapfile is not wanted for a specific buffer. For example, with
7896 confidential information that even root must not be able to access.
7897 Careful: All text will be in memory:
7898 - Don't use this for big files.
7899 - Recovery will be impossible!
7900 A swapfile will only be present when |'updatecount'| is non-zero and
7901 'swapfile' is set.
7902 When 'swapfile' is reset, the swap file for the current buffer is
7903 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7904 non-zero, a swap file is immediately created.
7905 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007906 If you want to open a new buffer without creating a swap file for it,
7907 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007908 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909
7910 This option is used together with 'bufhidden' and 'buftype' to
7911 specify special kinds of buffers. See |special-buffers|.
7912
7913 *'swapsync'* *'sws'*
7914'swapsync' 'sws' string (default "fsync")
7915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007917 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 When this option is empty parts of the swap file may be in memory and
7919 not written to disk. When the system crashes you may lose more work.
7920 On Unix the system does a sync now and then without Vim asking for it,
7921 so the disadvantage of setting this option off is small. On some
7922 systems the swap file will not be written at all. For a unix system
7923 setting it to "sync" will use the sync() call instead of the default
7924 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007925 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926
7927 *'switchbuf'* *'swb'*
7928'switchbuf' 'swb' string (default "")
7929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007931 Mostly for |quickfix| commands some values are also used for other
7932 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007933 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 useopen If included, jump to the first open window that
7935 contains the specified buffer (if there is one).
7936 Otherwise: Do not examine other windows.
7937 This setting is checked with |quickfix| commands, when
7938 jumping to errors (":cc", ":cn", "cp", etc.). It is
7939 also used in all buffer related split commands, for
7940 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007941 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007942 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007944 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007945 Otherwise: do not split, use current window (when used
7946 in the quickfix window: the previously used window or
7947 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007948 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007949 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007950 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007951 uselast If included, jump to the previously used window when
7952 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007954 *'synmaxcol'* *'smc'*
7955'synmaxcol' 'smc' number (default 3000)
7956 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007957 {not available when compiled without the |+syntax|
7958 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007959 Maximum column in which to search for syntax items. In long lines the
7960 text after this column is not highlighted and following lines may not
7961 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007962 This helps to avoid very slow redrawing for an XML file that is one
7963 long line.
7964 Set to zero to remove the limit.
7965
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 *'syntax'* *'syn'*
7967'syntax' 'syn' string (default empty)
7968 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 {not available when compiled without the |+syntax|
7970 feature}
7971 When this option is set, the syntax with this name is loaded, unless
7972 syntax highlighting has been switched off with ":syntax off".
7973 Otherwise this option does not always reflect the current syntax (the
7974 b:current_syntax variable does).
7975 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007976 not automatically recognized. Example, in an IDL file:
7977 /* vim: set syntax=idl : */ ~
7978 When a dot appears in the value then this separates two filetype
7979 names. Example:
7980 /* vim: set syntax=c.doxygen : */ ~
7981 This will use the "c" syntax first, then the "doxygen" syntax.
7982 Note that the second one must be prepared to be loaded as an addition,
7983 otherwise it will be skipped. More than one dot may appear.
7984 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 :set syntax=OFF
7986< To switch syntax highlighting on according to the current value of the
7987 'filetype' option: >
7988 :set syntax=ON
7989< What actually happens when setting the 'syntax' option is that the
7990 Syntax autocommand event is triggered with the value as argument.
7991 This option is not copied to another buffer, independent of the 's' or
7992 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007993 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007995 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007996'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007997 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007998 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007999 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008000 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008001
8002 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008003 option and only when there is no GUI tab line. When 'e' is in
8004 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008005 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008006
8007 The value is evaluated like with 'statusline'. You can use
8008 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008009 the text to be displayed. Use "%1T" for the first label, "%2T" for
8010 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008011
Bram Moolenaare12bab32019-01-08 22:02:56 +01008012 When changing something that is used in 'tabline' that does not
8013 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008014 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008015
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008016 Keep in mind that only one of the tab pages is the current one, others
8017 are invisible and you can't jump to their windows.
8018
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008019
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008020 *'tabpagemax'* *'tpm'*
8021'tabpagemax' 'tpm' number (default 10)
8022 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008023 Maximum number of tab pages to be opened by the |-p| command line
8024 argument or the ":tab all" command. |tabpage|
8025
8026
8027 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028'tabstop' 'ts' number (default 8)
8029 local to buffer
8030 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008031 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032
8033 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008034 appear wrong in many places, e.g., when printing it.
8035 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036
8037 There are four main ways to use tabs in Vim:
8038 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8039 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008040 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 behave like a tab appears every 4 (or 3) characters.
8042 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
8043 'expandtab'. This way you will always insert spaces. The
8044 formatting will never be messed up when 'tabstop' is changed.
8045 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008046 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 works when using Vim to edit the file.
8048 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
8049 'noexpandtab'. This should then work (for initial indents only)
8050 for any tabstop setting that people use. It might be nice to have
8051 tabs after the first non-blank inserted as spaces if you do this
8052 though. Otherwise aligned comments will be wrong when 'tabstop' is
8053 changed.
8054
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008055 If Vim is compiled with the |+vartabs| feature then the value of
8056 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8057 than an empty string.
8058
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8060'tagbsearch' 'tbs' boolean (default on)
8061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008063 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 searching makes searching for a tag a LOT faster, but a linear search
8065 will find more tags if the tags file wasn't properly sorted.
8066 Vim normally assumes that your tags files are sorted, or indicate that
8067 they are not sorted. Only when this is not the case does the
8068 'tagbsearch' option need to be switched off.
8069
8070 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008071 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 certain files, or retry all files with a linear search. When
8073 'tagbsearch' is off, only a linear search is done.
8074
8075 Linear searching is done anyway, for one file, when Vim finds a line
8076 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008077 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078< [The whitespace before and after the '0' must be a single <Tab>]
8079
8080 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008081 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 instead of a normal tag name, a retry is done with a linear search.
8083 Tags in unsorted tags files, and matches with different case will only
8084 be found in the retry.
8085
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008086 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008087 linear search can be avoided when case is ignored. Use a value of '2'
8088 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8089 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008090 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8091 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8092 used for this as well. Note that case must be folded to uppercase for
8093 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008094
8095 By default, tag searches are case-sensitive. Case is ignored when
8096 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8097 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008098 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8099 'tagcase' is "smart", and the pattern contains only lowercase
8100 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008101
8102 When 'tagbsearch' is off, tags searching is slower when a full match
8103 exists, but faster when no full match exists. Tags in unsorted tags
8104 files may only be found with 'tagbsearch' off.
8105 When the tags file is not sorted, or sorted in a wrong way (not on
8106 ASCII byte value), 'tagbsearch' should be off, or the line given above
8107 must be included in the tags file.
8108 This option doesn't affect commands that find all matching tags (e.g.,
8109 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008111 *'tagcase'* *'tc'*
8112'tagcase' 'tc' string (default "followic")
8113 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008114 This option specifies how case is handled when searching the tags
8115 file:
8116 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008117 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008118 ignore Ignore case
8119 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008120 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008121 NOTE: This option is set to the Vi default value when 'compatible' is
8122 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008123
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008124 *'tagfunc'* *'tfu'*
8125'tagfunc' 'tfu' string (default: empty)
8126 local to buffer
8127 {not available when compiled without the |+eval|
8128 feature}
8129 This option specifies a function to be used to perform tag searches.
8130 The function gets the tag pattern and should return a List of matching
8131 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008132 function and an example. The value can be the name of a function, a
8133 |lambda| or a |Funcref|. See |option-value-function| for more
8134 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008135
Bram Moolenaar071d4272004-06-13 20:20:40 +00008136 *'taglength'* *'tl'*
8137'taglength' 'tl' number (default 0)
8138 global
8139 If non-zero, tags are significant up to this number of characters.
8140
8141 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8142'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8143 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008144 If on and using a tags file in another directory, file names in that
8145 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 NOTE: This option is set to the Vi default value when 'compatible' is
8147 set and to the Vim default value when 'compatible' is reset.
8148
8149 *'tags'* *'tag'* *E433*
8150'tags' 'tag' string (default "./tags,tags", when compiled with
8151 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8152 global or local to buffer |global-local|
8153 Filenames for the tag command, separated by spaces or commas. To
8154 include a space or comma in a file name, precede it with a backslash
8155 (see |option-backslash| about including spaces and backslashes).
8156 When a file name starts with "./", the '.' is replaced with the path
8157 of the current file. But only when the 'd' flag is not included in
8158 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8159 |tags-option|.
8160 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008161 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8162 find all files named "tags" below "/lib". The filename itself cannot
8163 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008164 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008165 The |tagfiles()| function can be used to get a list of the file names
8166 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8168 files are also supported. They are automatically recognized. The
8169 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8170 differences are ignored (MS-Windows). |emacs-tags|
8171 The use of |:set+=| and |:set-=| is preferred when adding or removing
8172 file names from the list. This avoids problems when a future version
8173 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174
8175 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8176'tagstack' 'tgst' boolean (default on)
8177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 When on, the |tagstack| is used normally. When off, a ":tag" or
8179 ":tselect" command with an argument will not push the tag onto the
8180 tagstack. A following ":tag" without an argument, a ":pop" command or
8181 any other command that uses the tagstack will use the unmodified
8182 tagstack, but does change the pointer to the active entry.
8183 Resetting this option is useful when using a ":tag" command in a
8184 mapping which should not change the tagstack.
8185
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008186 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008187'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008188 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008189 {only available when compiled with the |+tcl/dyn|
8190 feature}
8191 Specifies the name of the Tcl shared library. The default is
8192 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008193 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008194 This option cannot be set from a |modeline| or in the |sandbox|, for
8195 security reasons.
8196
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 *'term'* *E529* *E530* *E531*
8198'term' string (default is $TERM, if that fails:
8199 in the GUI: "builtin_gui"
8200 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008201 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203 on Unix: "ansi"
8204 on VMS: "ansi"
8205 on Win 32: "win32")
8206 global
8207 Name of the terminal. Used for choosing the terminal control
8208 characters. Environment variables are expanded |:set_env|.
8209 For example: >
8210 :set term=$TERM
8211< See |termcap|.
8212
8213 *'termbidi'* *'tbidi'*
8214 *'notermbidi'* *'notbidi'*
8215'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 {only available when compiled with the |+arabic|
8218 feature}
8219 The terminal is in charge of Bi-directionality of text (as specified
8220 by Unicode). The terminal is also expected to do the required shaping
8221 that some languages (such as Arabic) require.
8222 Setting this option implies that 'rightleft' will not be set when
8223 'arabic' is set and the value of 'arabicshape' will be ignored.
8224 Note that setting 'termbidi' has the immediate effect that
8225 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8226 This option is reset when the GUI is started.
8227 For further details see |arabic.txt|.
8228
8229 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008230'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 Encoding used for the terminal. This specifies what character
8233 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008234 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008235 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008236 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008237 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8239 Any attempts to set a different value will be rejected, and an error
8240 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008241 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 because the Win32 system always passes Unicode characters.
8243 When empty, the same encoding is used as for the 'encoding' option.
8244 This is the normal value.
8245 Not all combinations for 'termencoding' and 'encoding' are valid. See
8246 |encoding-table|.
8247 The value for this option must be supported by internal conversions or
8248 iconv(). When this is not possible no conversion will be done and you
8249 will probably experience problems with non-ASCII characters.
8250 Example: You are working with the locale set to euc-jp (Japanese) and
8251 want to edit a UTF-8 file: >
8252 :let &termencoding = &encoding
8253 :set encoding=utf-8
8254< You need to do this when your system has no locale support for UTF-8.
8255
Bram Moolenaar938ae282023-02-20 20:44:55 +00008256 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008257'termguicolors' 'tgc' boolean (default off)
8258 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008259 {not available when compiled without the
8260 |+termguicolors| feature}
8261 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008262 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008263
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008264 Requires a ISO-8613-3 compatible terminal. If setting this option
8265 does not work (produces a colorless UI) reading |xterm-true-color|
8266 might help.
8267
8268 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8269 is required. Use this check to find out: >
8270 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008271< This requires Vim to be built with the |+vtp| feature.
8272
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008273 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008274
8275 When using Vim with Windows Terminal, the background of Windows
8276 Terminal is normally filled with the Vim background color. Setting
8277 'termguicolors' and the guibg of the Normal highlight group to NONE
8278 will make the background transparent: >
8279 :hi Normal guibg=NONE
8280<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008281 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008282
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008283 *'termwinkey'* *'twk'*
8284'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008285 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008286 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008287 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008288 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008289 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008290< The string must be one key stroke but can be multiple bytes.
8291 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008292 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008293 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008294
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008295 *'termwinscroll'* *'twsl'*
8296'termwinscroll' 'twsl' number (default 10000)
8297 local to buffer
8298 {not available when compiled without the
8299 |+terminal| feature}
8300 Number of scrollback lines to keep. When going over this limit the
8301 first 10% of the scrollback lines are deleted. This is just to reduce
8302 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008303 Also used as a limit for text sent to the terminal in one write,
8304 multiplied by the number of columns times 3 (average number of bytes
8305 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008306
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008307 *'termwinsize'* *'tws'*
8308'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008309 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008310 Size used when opening the |terminal| window. Format:
8311 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008312 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008313 - When set with a "x" (e.g., "24x80") the terminal size is not
8314 adjusted to the window size. If the window is smaller only the
8315 top-left part is displayed.
8316 - When set with a "*" (e.g., "10*50") the terminal size follows the
8317 window size, but will not be smaller than the specified rows and/or
8318 columns.
8319 - When rows is zero then use the height of the window.
8320 - When columns is zero then use the width of the window.
8321 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008322 - Can be overruled in the |term_start()| options with "term_rows" and
8323 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008324
8325 Examples:
8326 "30x0" uses 30 rows and the current window width.
8327 "20*0" uses at least 20 rows and the current window width.
8328 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008329 Note that the command running in the terminal window may still change
8330 the size of the terminal. In that case the Vim window will be
8331 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008332
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008333 *'termwintype'* *'twt'*
8334'termwintype' 'twt' string (default "")
8335 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008336 {only available when compiled with the |terminal|
8337 feature on MS-Windows}
8338 Specify the virtual console (pty) used when opening the terminal
8339 window.
8340
8341 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008342 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008343 "winpty" use winpty, fail if not supported
8344 "conpty" use |ConPTY|, fail if not supported
8345
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008346 |ConPTY| support depends on the platform. Windows 10 October 2018
8347 Update is the first version that supports ConPTY, however it is still
8348 considered unstable. ConPTY might become stable in the next release
8349 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008350 supported then you cannot open a terminal window.
8351
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352 *'terse'* *'noterse'*
8353'terse' boolean (default off)
8354 global
8355 When set: Add 's' flag to 'shortmess' option (this makes the message
8356 for a search that hits the start or end of the file not being
8357 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8358 shortens a lot of messages}
8359
8360 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8361'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8362 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 This option is obsolete. Use 'fileformats'.
8364 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8365 set to the default value for the current system. When 'textauto' is
8366 reset, 'fileformats' is made empty.
8367 NOTE: This option is set to the Vi default value when 'compatible' is
8368 set and to the Vim default value when 'compatible' is reset.
8369
8370 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008371'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 others: default off)
8373 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374 This option is obsolete. Use 'fileformat'.
8375 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8376 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8377 "unix".
8378
8379 *'textwidth'* *'tw'*
8380'textwidth' 'tw' number (default 0)
8381 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 Maximum width of text that is being inserted. A longer line will be
8383 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008384 this.
8385 'textwidth' is set to 0 when the 'paste' option is set and restored
8386 when 'paste' is reset.
8387 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008389 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 NOTE: This option is set to 0 when 'compatible' is set.
8391
8392 *'thesaurus'* *'tsr'*
8393'thesaurus' 'tsr' string (default "")
8394 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008396 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8397 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008398
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008399 This option is not used if 'thesaurusfunc' is set, either for the
8400 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008401
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008402 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008404 name. See |option-backslash| about using backslashes. The use of
8405 |:set+=| and |:set-=| is preferred when adding or removing directories
8406 from the list. This avoids problems when a future version uses
8407 another default. Backticks cannot be used in this option for security
8408 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008410 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008411'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008412 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008413 {not available when compiled without the |+eval|
8414 feature}
8415 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008416 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008417 The value can be the name of a function, a |lambda| or a |Funcref|.
8418 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008419
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008420 This option cannot be set from a |modeline| or in the |sandbox|, for
8421 security reasons.
8422
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8424'tildeop' 'top' boolean (default off)
8425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 When on: The tilde command "~" behaves like an operator.
8427 NOTE: This option is reset when 'compatible' is set.
8428
8429 *'timeout'* *'to'* *'notimeout'* *'noto'*
8430'timeout' 'to' boolean (default on)
8431 global
8432 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008433'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 These two options together determine the behavior when part of a
8436 mapped key sequence or keyboard code has been received:
8437
8438 'timeout' 'ttimeout' action ~
8439 off off do not time out
8440 on on or off time out on :mappings and key codes
8441 off on time out on key codes
8442
8443 If both options are off, Vim will wait until either the complete
8444 mapping or key sequence has been received, or it is clear that there
8445 is no mapping or key sequence for the received characters. For
8446 example: if you have mapped "vl" and Vim has received 'v', the next
8447 character is needed to see if the 'v' is followed by an 'l'.
8448 When one of the options is on, Vim will wait for about 1 second for
8449 the next character to arrive. After that the already received
8450 characters are interpreted as single characters. The waiting time can
8451 be changed with the 'timeoutlen' option.
8452 On slow terminals or very busy systems timing out may cause
8453 malfunctioning cursor keys. If both options are off, Vim waits
8454 forever after an entered <Esc> if there are key codes that start
8455 with <Esc>. You will have to type <Esc> twice. If you do not have
8456 problems with key codes, but would like to have :mapped key
8457 sequences not timing out in 1 second, set the 'ttimeout' option and
8458 reset the 'timeout' option.
8459
8460 NOTE: 'ttimeout' is reset when 'compatible' is set.
8461
8462 *'timeoutlen'* *'tm'*
8463'timeoutlen' 'tm' number (default 1000)
8464 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008465
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008467'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469 The time in milliseconds that is waited for a key code or mapped key
8470 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8471 when part of a command has been typed.
8472 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8473 different timeout value for key codes is desired set 'ttimeoutlen' to
8474 a non-negative number.
8475
8476 ttimeoutlen mapping delay key code delay ~
8477 < 0 'timeoutlen' 'timeoutlen'
8478 >= 0 'timeoutlen' 'ttimeoutlen'
8479
8480 The timeout only happens when the 'timeout' and 'ttimeout' options
8481 tell so. A useful setting would be >
8482 :set timeout timeoutlen=3000 ttimeoutlen=100
8483< (time out on mapping after three seconds, time out on key codes after
8484 a tenth of a second).
8485
8486 *'title'* *'notitle'*
8487'title' boolean (default off, on when title can be restored)
8488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 When on, the title of the window will be set to the value of
8490 'titlestring' (if it is not empty), or to:
8491 filename [+=-] (path) - VIM
8492 Where:
8493 filename the name of the file being edited
8494 - indicates the file cannot be modified, 'ma' off
8495 + indicates the file was modified
8496 = indicates the file is read-only
8497 =+ indicates the file is read-only and modified
8498 (path) is the path of the file being edited
8499 - VIM the server name |v:servername| or "VIM"
8500 Only works if the terminal supports setting window titles
8501 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008502 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8504 *X11*
8505 When Vim was compiled with HAVE_X11 defined, the original title will
8506 be restored if possible. The output of ":version" will include "+X11"
8507 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8508 works for the icon name |'icon'|.
8509 But: When Vim was started with the |-X| argument, restoring the title
8510 will not work (except in the GUI).
8511 If the title cannot be restored, it is set to the value of 'titleold'.
8512 You might want to restore the title outside of Vim then.
8513 When using an xterm from a remote machine you can use this command:
8514 rsh machine_name xterm -display $DISPLAY &
8515 then the WINDOWID environment variable should be inherited and the
8516 title of the window should change back to what it should be after
8517 exiting Vim.
8518
8519 *'titlelen'*
8520'titlelen' number (default 85)
8521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008523 title. When the title is longer, only the end of the path name is
8524 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525 Using a percentage makes this adapt to the width of the window. But
8526 it won't work perfectly, because the actual number of characters
8527 available also depends on the font used and other things in the title
8528 bar. When 'titlelen' is zero the full path is used. Otherwise,
8529 values from 1 to 30000 percent can be used.
8530 'titlelen' is also used for the 'titlestring' option.
8531
8532 *'titleold'*
8533'titleold' string (default "Thanks for flying Vim")
8534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 This option will be used for the window title when exiting Vim if the
8536 original title cannot be restored. Only happens if 'title' is on or
8537 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008538 This option cannot be set from a |modeline| or in the |sandbox|, for
8539 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 *'titlestring'*
8541'titlestring' string (default "")
8542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008543 When this option is not empty, it will be used for the title of the
8544 window. This happens only when the 'title' option is on.
8545 Only works if the terminal supports setting window titles (currently
8546 Amiga console, Win32 console, all GUI versions and terminals with a
8547 non-empty 't_ts' option).
8548 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008549 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008550
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 When this option contains printf-style '%' items, they will be
8552 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008553 This option cannot be set in a modeline when 'modelineexpr' is off.
8554
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008556 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008557 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8558< The value of 'titlelen' is used to align items in the middle or right
8559 of the available space.
8560 Some people prefer to have the file name first: >
8561 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8562< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008563 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 separating space only when needed.
8565 NOTE: Use of special characters in 'titlestring' may cause the display
8566 to be garbled (e.g., when it contains a CR or NL character).
8567 {not available when compiled without the |+statusline| feature}
8568
8569 *'toolbar'* *'tb'*
8570'toolbar' 'tb' string (default "icons,tooltips")
8571 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008572 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008573 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 possible values are:
8575 icons Toolbar buttons are shown with icons.
8576 text Toolbar buttons shown with text.
8577 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008578 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 tooltips Tooltips are active for toolbar buttons.
8580 Tooltips refer to the popup help text which appears after the mouse
8581 cursor is placed over a toolbar button for a brief moment.
8582
8583 If you want the toolbar to be shown with icons as well as text, do the
8584 following: >
8585 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008586< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587 will show icons if both are requested.
8588
8589 If none of the strings specified in 'toolbar' are valid or if
8590 'toolbar' is empty, this option is ignored. If you want to disable
8591 the toolbar, you need to set the 'guioptions' option. For example: >
8592 :set guioptions-=T
8593< Also see |gui-toolbar|.
8594
8595 *'toolbariconsize'* *'tbis'*
8596'toolbariconsize' 'tbis' string (default "small")
8597 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008598 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008600 tiny Use tiny icons.
8601 small Use small icons (default).
8602 medium Use medium-sized icons.
8603 large Use large icons.
8604 huge Use even larger icons.
8605 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008607 the current theme. Common dimensions are giant=48x48, huge=32x32,
8608 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609
8610 If 'toolbariconsize' is empty, the global default size as determined
8611 by user preferences or the current theme is used.
8612
8613 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8614'ttybuiltin' 'tbi' boolean (default on)
8615 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 When on, the builtin termcaps are searched before the external ones.
8617 When off the builtin termcaps are searched after the external ones.
8618 When this option is changed, you should set the 'term' option next for
8619 the change to take effect, for example: >
8620 :set notbi term=$TERM
8621< See also |termcap|.
8622 Rationale: The default for this option is "on", because the builtin
8623 termcap entries are generally better (many systems contain faulty
8624 xterm entries...).
8625
8626 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008627'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 Indicates a fast terminal connection. More characters will be sent to
8630 the screen for redrawing, instead of using insert/delete line
8631 commands. Improves smoothness of redrawing when there are multiple
8632 windows and the terminal does not support a scrolling region.
8633 Also enables the extra writing of characters at the end of each screen
8634 line for lines that wrap. This helps when using copy/paste with the
8635 mouse in an xterm and other terminals.
8636
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008637 The default used to be set only for some terminal names, but these
8638 days nearly all terminals are fast, therefore the default is now "on".
8639 If you have a slow connection you may want to set this option off,
8640 e.g. depending on the host name: >
8641 if hostname() =~ 'faraway'
8642 set nottyfast
8643 endif
8644<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 *'ttymouse'* *'ttym'*
8646'ttymouse' 'ttym' string (default depends on 'term')
8647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008648 {only in Unix and VMS, doesn't work in the GUI; not
8649 available when compiled without |+mouse|}
8650 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008651 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008652 *xterm-mouse*
8653 xterm xterm-like mouse handling. The mouse generates
8654 "<Esc>[Mscr", where "scr" is three bytes:
8655 "s" = button state
8656 "c" = column plus 33
8657 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008658 This only works up to 223 columns! See "dec",
8659 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008660 xterm2 Works like "xterm", but with the xterm reporting the
8661 mouse position while the mouse is dragged. This works
8662 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008663 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 work. See below for how Vim detects this
8665 automatically.
8666 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008667 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008669 for the row and column. No other mouse events are
8670 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 *dec-mouse*
8672 dec DEC terminal mouse handling. The mouse generates a
8673 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008674 This is also available for an Xterm, if it was
8675 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 *jsbterm-mouse*
8677 jsbterm JSB term mouse handling.
8678 *pterm-mouse*
8679 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008680 *urxvt-mouse*
8681 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008682 The mouse works only if the terminal supports this
8683 encoding style, but it does not have 223 columns limit
8684 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008685 *sgr-mouse*
8686 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008687 mouse reporting. The mouse works even in columns
8688 beyond 223. This option is backward compatible with
8689 "xterm2" because it can also decode "xterm2" style
8690 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691
8692 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008693 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8694 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8696 recognized, if enabled at compile time. DEC terminal mouse codes
8697 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008698 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8699 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008701 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8702 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8703 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008704 If the terminfo/termcap entry "XM" exists and the first number is
8705 "1006" then 'ttymouse' will be set to "sgr". This works for many
8706 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008707 Additionally, if vim is compiled with the |+termresponse| feature and
8708 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008709 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008711 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8712 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8713 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008714 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8715 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 :set t_RV=
8717<
8718 *'ttyscroll'* *'tsl'*
8719'ttyscroll' 'tsl' number (default 999)
8720 global
8721 Maximum number of lines to scroll the screen. If there are more lines
8722 to scroll the window is redrawn. For terminals where scrolling is
8723 very slow and redrawing is not slow this can be set to a small number,
8724 e.g., 3, to speed up displaying.
8725
8726 *'ttytype'* *'tty'*
8727'ttytype' 'tty' string (default from $TERM)
8728 global
8729 Alias for 'term', see above.
8730
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008731 *'undodir'* *'udir'*
8732'undodir' 'udir' string (default ".")
8733 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008734 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008735 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008736 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008737 "." means using the directory of the file. The undo file name for
8738 "file.txt" is ".file.txt.un~".
8739 For other directories the file name is the full path of the edited
8740 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008741 When writing: The first directory that exists is used. "." always
8742 works, no directories after "." will be used for writing.
8743 When reading all entries are tried to find an undo file. The first
8744 undo file that exists is used. When it cannot be read an error is
8745 given, no further entry is used.
8746 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008747 This option cannot be set from a |modeline| or in the |sandbox|, for
8748 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008749
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008750 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008751'undofile' 'udf' boolean (default off)
8752 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008753 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008754 When on, Vim automatically saves undo history to an undo file when
8755 writing a buffer to a file, and restores undo history from the same
8756 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008757 The directory where the undo file is stored is specified by 'undodir'.
8758 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008759 The undo file is not read when 'undoreload' causes the buffer from
8760 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008761 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008762 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008763
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008765'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008766 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008768 is kept in memory, higher numbers will cause more memory to be used.
8769 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8771 itself: >
8772 set ul=0
8773< But you can also get Vi compatibility by including the 'u' flag in
8774 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008775 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008776 Set to -1 for no undo at all. You might want to do this only for the
8777 current buffer: >
8778 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008780
8781 The local value is set to -123456 when the global value is to be used.
8782
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008783 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008785 *'undoreload'* *'ur'*
8786'undoreload' 'ur' number (default 10000)
8787 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008788 Save the whole buffer for undo when reloading it. This applies to the
8789 ":e!" command and reloading for when the buffer changed outside of
8790 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008791 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008792 of lines is smaller than the value of this option.
8793 Set this option to zero to disable undo for a reload.
8794
8795 When saving undo for a reload, any undo file is not read.
8796
8797 Note that this causes the whole buffer to be stored in memory. Set
8798 this option to a lower value if you run out of memory.
8799
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 *'updatecount'* *'uc'*
8801'updatecount' 'uc' number (default: 200)
8802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 After typing this many characters the swap file will be written to
8804 disk. When zero, no swap file will be created at all (see chapter on
8805 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8806 Vim with the "-n" option, see |startup|. When editing in readonly
8807 mode this option will be initialized to 10000.
8808 The swapfile can be disabled per buffer with |'swapfile'|.
8809 When 'updatecount' is set from zero to non-zero, swap files are
8810 created for all buffers that have 'swapfile' set. When 'updatecount'
8811 is set to zero, existing swap files are not deleted.
8812 Also see |'swapsync'|.
8813 This option has no meaning in buffers where |'buftype'| is "nofile"
8814 or "nowrite".
8815
8816 *'updatetime'* *'ut'*
8817'updatetime' 'ut' number (default 4000)
8818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 If this many milliseconds nothing is typed the swap file will be
8820 written to disk (see |crash-recovery|). Also used for the
8821 |CursorHold| autocommand event.
8822
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008823 *'varsofttabstop'* *'vsts'*
8824'varsofttabstop' 'vsts' string (default "")
8825 local to buffer
8826 {only available when compiled with the |+vartabs|
8827 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008828 A list of the number of spaces that a <Tab> counts for while editing,
8829 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8830 width <Tab>s are being inserted, while in fact a mixture of spaces
8831 and <Tab>s is used. Tab widths are separated with commas, with the
8832 final value applying to all subsequent tabs.
8833
8834 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008835 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008836 to use the following: >
8837 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008838< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8839 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008840
8841 Note that the value of |'softtabstop'| will be ignored while
8842 'varsofttabstop' is set.
8843
8844 *'vartabstop'* *'vts'*
8845'vartabstop' 'vts' string (default "")
8846 local to buffer
8847 {only available when compiled with the |+vartabs|
8848 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008849 A list of the number of spaces that a <Tab> in the file counts for,
8850 separated by commas. Each value corresponds to one tab, with the
8851 final value applying to all subsequent tabs. For example: >
8852 :set vartabstop=4,20,10,8
8853< This will make the first tab 4 spaces wide, the second 20 spaces,
8854 the third 10 spaces, and all following tabs 8 spaces.
8855
8856 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8857 is set.
8858
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 *'verbose'* *'vbs'*
8860'verbose' 'vbs' number (default 0)
8861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008862 When bigger than zero, Vim will give messages about what it is doing.
8863 Currently, these messages are given:
8864 >= 1 When the viminfo file is read or written.
8865 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008866 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008867 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008868 >= 8 Files for which a group of autocommands is executed.
8869 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008870 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 >= 12 Every executed function.
8872 >= 13 When an exception is thrown, caught, finished, or discarded.
8873 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008874 >= 15 Every executed Ex command from a script (truncated at 200
8875 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008876 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877
8878 This option can also be set with the "-V" argument. See |-V|.
8879 This option is also set by the |:verbose| command.
8880
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008881 When the 'verbosefile' option is set then the verbose messages are not
8882 displayed.
8883
8884 *'verbosefile'* *'vfile'*
8885'verbosefile' 'vfile' string (default empty)
8886 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008887 When not empty all messages are written in a file with this name.
8888 When the file exists messages are appended.
8889 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008890 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008891 Setting 'verbosefile' to a new value is like making it empty first.
8892 The difference with |:redir| is that verbose messages are not
8893 displayed when 'verbosefile' is set.
8894
Bram Moolenaar071d4272004-06-13 20:20:40 +00008895 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008896'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008897 "$VIM/vimfiles/view",
8898 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008899 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008900 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008902 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 feature}
8904 Name of the directory where to store files for |:mkview|.
8905 This option cannot be set from a |modeline| or in the |sandbox|, for
8906 security reasons.
8907
8908 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008909'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008911 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008912 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008913 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008914 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 word save and restore ~
8916 cursor cursor position in file and in window
8917 folds manually created folds, opened/closed folds and local
8918 fold options
8919 options options and mappings local to a window or buffer (not
8920 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008921 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922 slash backslashes in file names replaced with forward
8923 slashes
8924 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008925 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008926 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008927
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008928 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008930 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931
8932 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008933'viminfo' 'vi' string (Vi default: "", Vim default for
8934 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008935 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8936 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008938 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 feature}
8940 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008941 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8942 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008943 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008944 consisting of a single character identifying the particular parameter,
8945 followed by a number or string which specifies the value of that
8946 parameter. If a particular character is left out, then the default
8947 value is used for that parameter. The following is a list of the
8948 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008950 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008951 ! When included, save and restore global variables that start
8952 with an uppercase letter, and don't contain a lowercase
8953 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008954 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008955 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008956 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 " Maximum number of lines saved for each register. Old name of
8958 the '<' item, with the disadvantage that you need to put a
8959 backslash before the ", otherwise it will be recognized as the
8960 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008961 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008962 % When included, save and restore the buffer list. If Vim is
8963 started with a file name argument, the buffer list is not
8964 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008965 buffer list is restored from the viminfo file. Quickfix
8966 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8967 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008968 When followed by a number, the number specifies the maximum
8969 number of buffers that are stored. Without a number all
8970 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008971 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 ' Maximum number of previously edited files for which the marks
8973 are remembered. This parameter must always be included when
8974 'viminfo' is non-empty.
8975 Including this item also means that the |jumplist| and the
8976 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008977 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008978 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008979 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 patterns are also saved. When not included, the value of
8981 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008982 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008984 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008985 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008986 < Maximum number of lines saved for each register. If zero then
8987 registers are not saved. When not included, all lines are
8988 saved. '"' is the old name for this item.
8989 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008990 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008992 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008993 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008994 c When included, convert the text in the viminfo file from the
8995 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008996 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008997 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008998 f Whether file marks need to be stored. If zero, file marks ('0
8999 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009000 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009002 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003 h Disable the effect of 'hlsearch' when loading the viminfo
9004 file. When not included, it depends on whether ":nohlsearch"
9005 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009006 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009008 the 'n'. Must be at the end of the option! If the
9009 'viminfofile' option is set, that file name overrides the one
9010 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009011 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009012 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 r Removable media. The argument is a string (up to the next
9014 ','). This parameter can be given several times. Each
9015 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009016 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9018 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9019 ignored. Maximum length of each 'r' argument is 50
9020 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009021 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 s Maximum size of an item in Kbyte. If zero then registers are
9023 not saved. Currently only applies to registers. The default
9024 "s10" will exclude registers with more than 10 Kbyte of text.
9025 Also see the '<' item above: line count limit.
9026
9027 Example: >
9028 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9029<
9030 '50 Marks will be remembered for the last 50 files you
9031 edited.
9032 <1000 Contents of registers (up to 1000 lines each) will be
9033 remembered.
9034 s100 Registers with more than 100 Kbyte text are skipped.
9035 :0 Command-line history will not be saved.
9036 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9037 no / Since '/' is not specified, the default will be used,
9038 that is, save all of the search history, and also the
9039 previous search and substitute patterns.
9040 no % The buffer list will not be saved nor read back.
9041 no h 'hlsearch' highlighting will be restored.
9042
9043 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9044 load the contents of the file, this is not done automatically.
9045
9046 This option cannot be set from a |modeline| or in the |sandbox|, for
9047 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009048 NOTE: This option is set to the Vim default value when 'compatible'
9049 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009051 *'viminfofile'* *'vif'*
9052'viminfofile' 'vif' string (default: "")
9053 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009054 {not available when compiled without the |+viminfo|
9055 feature}
9056 When non-empty, overrides the file name used for viminfo.
9057 When equal to "NONE" no viminfo file will be read or written.
9058 This option can be set with the |-i| command line flag. The |--clean|
9059 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009060 This option cannot be set from a |modeline| or in the |sandbox|, for
9061 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009062
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 *'virtualedit'* *'ve'*
9064'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009065 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009066 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009067 block Allow virtual editing in Visual block mode.
9068 insert Allow virtual editing in Insert mode.
9069 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009070 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009071 none When used as the local value, do not allow virtual
9072 editing even when the global value is set. When used
9073 as the global value, "none" is the same as "".
9074 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009075
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009077 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009078 of the line. Useful for selecting a rectangle in Visual mode and
9079 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009080 "onemore" is not the same, it will only allow moving the cursor just
9081 after the last character of the line. This makes some commands more
9082 consistent. Previously the cursor was always past the end of the line
9083 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009084 break some plugins or Vim scripts. For example because |l| can move
9085 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009086 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009087 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009088 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009089 It doesn't make sense to combine "all" with "onemore", but you will
9090 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009091 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009092 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009093
9094 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9095'visualbell' 'vb' boolean (default off)
9096 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009097 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009098 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009099 use: >
9100 :set vb t_vb=
9101< If you want a short flash, you can use this on many terminals: >
9102 :set vb t_vb=[?5h$<100>[?5l
9103< Here $<100> specifies the time, you can use a smaller or bigger value
9104 to get a shorter or longer flash.
9105
9106 Note: Vim will limit the bell to once per half a second. This avoids
9107 having to wait for the flashing to finish when there are lots of
9108 bells, e.g. on key repeat. This also happens without 'visualbell'
9109 set.
9110
Bram Moolenaar071d4272004-06-13 20:20:40 +00009111 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9112 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9113 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009114
9115 Note: When the GUI starts, 't_vb' is reset to its default value. You
9116 might want to set it again in your |gvimrc|.
9117
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118 Does not work on the Amiga, you always get a screen flash.
9119 Also see 'errorbells'.
9120
9121 *'warn'* *'nowarn'*
9122'warn' boolean (default on)
9123 global
9124 Give a warning message when a shell command is used while the buffer
9125 has been changed.
9126
9127 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9128'weirdinvert' 'wiv' boolean (default off)
9129 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009130 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009131 It is provided for backwards compatibility with version 4.x.
9132 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9133 vice versa. Has no effect when the GUI is running.
9134
9135 *'whichwrap'* *'ww'*
9136'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138 Allow specified keys that move the cursor left/right to move to the
9139 previous/next line when the cursor is on the first/last character in
9140 the line. Concatenate characters to allow this for these keys:
9141 char key mode ~
9142 b <BS> Normal and Visual
9143 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009144 h "h" Normal and Visual (not recommended)
9145 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146 < <Left> Normal and Visual
9147 > <Right> Normal and Visual
9148 ~ "~" Normal
9149 [ <Left> Insert and Replace
9150 ] <Right> Insert and Replace
9151 For example: >
9152 :set ww=<,>,[,]
9153< allows wrap only when cursor keys are used.
9154 When the movement keys are used in combination with a delete or change
9155 operator, the <EOL> also counts for a character. This makes "3h"
9156 different from "3dh" when the cursor crosses the end of a line. This
9157 is also true for "x" and "X", because they do the same as "dl" and
9158 "dh". If you use this, you may also want to use the mapping
9159 ":map <BS> X" to make backspace delete the character in front of the
9160 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009161 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009162 line (not an empty line) then it will not move to the next line. This
9163 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009164 NOTE: This option is set to the Vi default value when 'compatible' is
9165 set and to the Vim default value when 'compatible' is reset.
9166
9167 *'wildchar'* *'wc'*
9168'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170 Character you have to type to start wildcard expansion in the
9171 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009172 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 The character is not recognized when used inside a macro. See
9174 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009175 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009176 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009177 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009178< NOTE: This option is set to the Vi default value when 'compatible' is
9179 set and to the Vim default value when 'compatible' is reset.
9180
9181 *'wildcharm'* *'wcm'*
9182'wildcharm' 'wcm' number (default: none (0))
9183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009184 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009185 recognized when used inside a macro. You can find "spare" command-line
9186 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187 you'll never actually type 'wildcharm', just use it in mappings that
9188 automatically invoke completion mode, e.g.: >
9189 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009190 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009191< Then after typing :ss you can use CTRL-P & CTRL-N.
9192
9193 *'wildignore'* *'wig'*
9194'wildignore' 'wig' string (default "")
9195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009197 patterns is ignored when expanding |wildcards|, completing file or
9198 directory names, and influences the result of |expand()|, |glob()| and
9199 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009200 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9201 Also see 'suffixes'.
9202 Example: >
9203 :set wildignore=*.o,*.obj
9204< The use of |:set+=| and |:set-=| is preferred when adding or removing
9205 a pattern from the list. This avoids problems when a future version
9206 uses another default.
9207
Bram Moolenaar94950a92010-12-02 16:01:29 +01009208
Bram Moolenaar81af9252010-12-10 20:35:50 +01009209 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009210'wildignorecase' 'wic' boolean (default off)
9211 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009212 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009213 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009214 Does not apply when the shell is used to expand wildcards, which
9215 happens when there are special characters.
9216
9217
Bram Moolenaar071d4272004-06-13 20:20:40 +00009218 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009219'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 When 'wildmenu' is on, command-line completion operates in an enhanced
9222 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009223 the possible matches are shown.
9224 When 'wildoptions' contains "pum", then the completion matches are
9225 shown in a popup menu. Otherwise they are displayed just above the
9226 command line, with the first match highlighted (overwriting the status
9227 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009228 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009229 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9230 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9231 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009232 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009233 If there are more matches than can fit in the line, a ">" is shown on
9234 the right and/or a "<" is shown on the left. The status line scrolls
9235 as needed.
9236 The "wildmenu" mode is abandoned when a key is hit that is not used
9237 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009238 While the "wildmenu" is active, not using the popup menu, the
9239 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240
9241 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9242 <Down> - in filename/menu name completion: move into a
9243 subdirectory or submenu.
9244 <CR> - in menu completion, when the cursor is just after a
9245 dot: move into a submenu.
9246 <Up> - in filename/menu name completion: move up into
9247 parent directory or parent menu.
9248
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009249 When using the popup menu for command line completion, the following
9250 keys have special meanings:
9251 <Down> - select next match (like CTRL-N)
9252 <Left> - in filename/menu name completion: move up into
9253 parent directory or parent menu.
9254 <Right> - in filename/menu name completion: move into a
9255 subdirectory or submenu.
9256 <Up> - select previous match (like CTRL-P)
9257 CTRL-E - end completion, go back to what was there before
9258 selecting a match.
9259 CTRL-N - go to the next entry
9260 CTRL-P - go to the previous entry
9261 CTRL-Y - accept the currently selected match and stop
9262 completion.
9263
Bram Moolenaar071d4272004-06-13 20:20:40 +00009264 This makes the menus accessible from the console |console-menus|.
9265
9266 If you prefer the <Left> and <Right> keys to move the cursor instead
9267 of selecting a different match, use this: >
9268 :cnoremap <Left> <Space><BS><Left>
9269 :cnoremap <Right> <Space><BS><Right>
9270<
9271 The "WildMenu" highlighting is used for displaying the current match
9272 |hl-WildMenu|.
9273
9274 *'wildmode'* *'wim'*
9275'wildmode' 'wim' string (Vim default: "full")
9276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009277 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009278 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009279 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 first part specifies the behavior for the first use of 'wildchar',
9281 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009282
9283 Each part consists of a colon separated list consisting of the
9284 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009285 "" Complete only the first match.
9286 "full" Complete the next full match. After the last match,
9287 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009288 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289 "longest" Complete till longest common string. If this doesn't
9290 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009291 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009292 "lastused" When completing buffer names and more than one buffer
9293 matches, sort buffers by time last used (other than
9294 the current buffer).
9295 When there is only a single match, it is fully completed in all cases.
9296
9297 Examples of useful colon-separated values:
9298 "longest:full" Like "longest", but also start 'wildmenu' if it is
9299 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009300 "list:full" When more than one match, list all matches and
9301 complete first match.
9302 "list:longest" When more than one match, list all matches and
9303 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009304 "list:lastused" When more than one buffer matches, list all matches
9305 and sort buffers by time last used (other than the
9306 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009307
9308 Examples: >
9309 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009310< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009311 :set wildmode=longest,full
9312< Complete longest common string, then each full match >
9313 :set wildmode=list:full
9314< List all matches and complete each full match >
9315 :set wildmode=list,full
9316< List all matches without completing, then each full match >
9317 :set wildmode=longest,list
9318< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009319 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009320
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009321 *'wildoptions'* *'wop'*
9322'wildoptions' 'wop' string (default "")
9323 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009324 A list of words that change how |cmdline-completion| is done.
9325 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009326 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009327 this value is specified, wildcard expansion will not
9328 be used for completion. The matches will be sorted by
9329 the "best match" rather than alphabetically sorted.
9330 This will find more matches than the wildcard
9331 expansion. Currently fuzzy matching based completion
9332 is not supported for file and directory names and
9333 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009334 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009335 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009336 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009337 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009338 is displayed per line. Often used tag kinds are:
9339 d #define
9340 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009341
Bram Moolenaar071d4272004-06-13 20:20:40 +00009342 *'winaltkeys'* *'wak'*
9343'winaltkeys' 'wak' string (default "menu")
9344 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009345 {only used in Win32, Motif, GTK and Photon GUI}
9346 Some GUI versions allow the access to menu entries by using the ALT
9347 key in combination with a character that appears underlined in the
9348 menu. This conflicts with the use of the ALT key for mappings and
9349 entering special characters. This option tells what to do:
9350 no Don't use ALT keys for menus. ALT key combinations can be
9351 mapped, but there is no automatic handling. This can then be
9352 done with the |:simalt| command.
9353 yes ALT key handling is done by the windowing system. ALT key
9354 combinations cannot be mapped.
9355 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009356 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009357 keys can be mapped.
9358 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9359 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009360 This option is not used for <F10>; on Win32 and with GTK <F10> will
9361 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009362
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009363 *'wincolor'* *'wcr'*
9364'wincolor' 'wcr' string (default empty)
9365 local to window
9366 Highlight group name to use for this window instead of the Normal
9367 color |hl-Normal|.
9368
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009369 *'window'* *'wi'*
9370'window' 'wi' number (default screen height - 1)
9371 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009372 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9373 window and the value is smaller than 'lines' minus one. The screen
9374 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009375 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9376 in a much smarter way, taking care of wrapping lines.
9377 When resizing the Vim window, the value is smaller than 1 or more than
9378 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009379 Note: Do not confuse this with the height of the Vim window, use
9380 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009381
Bram Moolenaar071d4272004-06-13 20:20:40 +00009382 *'winheight'* *'wh'* *E591*
9383'winheight' 'wh' number (default 1)
9384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009385 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009386 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009387 focus goes to a window that is smaller, its size is increased, at the
9388 cost of the height of other windows.
9389 Set 'winheight' to a small number for normal editing.
9390 Set it to 999 to make the current window fill most of the screen.
9391 Other windows will be only 'winminheight' high. This has the drawback
9392 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9393 to create only two windows, set the option after startup is done,
9394 using the |VimEnter| event: >
9395 au VimEnter * set winheight=999
9396< Minimum value is 1.
9397 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009398 height of the current window.
9399 'winheight' applies to the current window. Use 'winminheight' to set
9400 the minimal height for other windows.
9401
9402 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9403'winfixheight' 'wfh' boolean (default off)
9404 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009405 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009406 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9407 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009408 The height may be changed anyway when running out of room.
9409
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009410 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9411'winfixwidth' 'wfw' boolean (default off)
9412 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009413 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009414 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009415 The width may be changed anyway when running out of room.
9416
Bram Moolenaar071d4272004-06-13 20:20:40 +00009417 *'winminheight'* *'wmh'*
9418'winminheight' 'wmh' number (default 1)
9419 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009420 The minimal height of a window, when it's not the current window.
9421 This is a hard minimum, windows will never become smaller.
9422 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9423 status bar) if necessary. They will return to at least one line when
9424 they become active (since the cursor has to have somewhere to go.)
9425 Use 'winheight' to set the minimal height of the current window.
9426 This option is only checked when making a window smaller. Don't use a
9427 large number, it will cause errors when opening more than a few
9428 windows. A value of 0 to 3 is reasonable.
9429
9430 *'winminwidth'* *'wmw'*
9431'winminwidth' 'wmw' number (default 1)
9432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009433 The minimal width of a window, when it's not the current window.
9434 This is a hard minimum, windows will never become smaller.
9435 When set to zero, windows may be "squashed" to zero columns (i.e. just
9436 a vertical separator) if necessary. They will return to at least one
9437 line when they become active (since the cursor has to have somewhere
9438 to go.)
9439 Use 'winwidth' to set the minimal width of the current window.
9440 This option is only checked when making a window smaller. Don't use a
9441 large number, it will cause errors when opening more than a few
9442 windows. A value of 0 to 12 is reasonable.
9443
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009444 *'winptydll'*
9445'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9446 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009447 {only available when compiled with the |terminal|
9448 feature on MS-Windows}
9449 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009450 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009451 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009452 a fallback.
9453 Environment variables are expanded |:set_env|.
9454 This option cannot be set from a |modeline| or in the |sandbox|, for
9455 security reasons.
9456
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457 *'winwidth'* *'wiw'* *E592*
9458'winwidth' 'wiw' number (default 20)
9459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009460 Minimal number of columns for the current window. This is not a hard
9461 minimum, Vim will use fewer columns if there is not enough room. If
9462 the current window is smaller, its size is increased, at the cost of
9463 the width of other windows. Set it to 999 to make the current window
9464 always fill the screen. Set it to a small number for normal editing.
9465 The width is not adjusted after one of the commands to change the
9466 width of the current window.
9467 'winwidth' applies to the current window. Use 'winminwidth' to set
9468 the minimal width for other windows.
9469
9470 *'wrap'* *'nowrap'*
9471'wrap' boolean (default on)
9472 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009473 This option changes how text is displayed. It doesn't change the text
9474 in the buffer, see 'textwidth' for that.
9475 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009476 displaying continues on the next line. When off lines will not wrap
9477 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009478 moved to a part that is not shown, the screen will scroll
9479 horizontally.
9480 The line will be broken in the middle of a word if necessary. See
9481 'linebreak' to get the break at a word boundary.
9482 To make scrolling horizontally a bit more useful, try this: >
9483 :set sidescroll=5
9484 :set listchars+=precedes:<,extends:>
9485< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009486 This option can't be set from a |modeline| when the 'diff' option is
9487 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009488
9489 *'wrapmargin'* *'wm'*
9490'wrapmargin' 'wm' number (default 0)
9491 local to buffer
9492 Number of characters from the right window border where wrapping
9493 starts. When typing text beyond this limit, an <EOL> will be inserted
9494 and inserting continues on the next line.
9495 Options that add a margin, such as 'number' and 'foldcolumn', cause
9496 the text width to be further reduced. This is Vi compatible.
9497 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009498 This option is set to 0 when 'paste' is set and restored when 'paste'
9499 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009500 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009501
9502 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9503'wrapscan' 'ws' boolean (default on) *E384* *E385*
9504 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009505 Searches wrap around the end of the file. Also applies to |]s| and
9506 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009507
9508 *'write'* *'nowrite'*
9509'write' boolean (default on)
9510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009511 Allows writing files. When not set, writing a file is not allowed.
9512 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009513 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009514 argument. Filtering text is still possible, even though this requires
9515 writing a temporary file.
9516
9517 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9518'writeany' 'wa' boolean (default off)
9519 global
9520 Allows writing to any file with no need for "!" override.
9521
9522 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9523'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9524 otherwise)
9525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009526 Make a backup before overwriting a file. The backup is removed after
9527 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009528 also on.
9529 WARNING: Switching this option off means that when Vim fails to write
9530 your buffer correctly and then, for whatever reason, Vim exits, you
9531 lose both the original file and what you were writing. Only reset
9532 this option if your file system is almost full and it makes the write
9533 fail (and make sure not to exit Vim until the write was successful).
9534 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009535 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009536 Depending on 'backupcopy' the backup is a new file or the original
9537 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009538 NOTE: This option is set to the default value when 'compatible' is
9539 set.
9540
9541 *'writedelay'* *'wd'*
9542'writedelay' 'wd' number (default 0)
9543 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009544 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009545 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009546 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009547
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009548 *'xtermcodes'* *'noxtermcodes'*
9549'xtermcodes' boolean (default on)
9550 global
9551 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009552 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009553 key codes and number of colors from the terminal. This takes care of
9554 various configuration options of the terminal that cannot be obtained
9555 from the termlib/terminfo entry, see |xterm-codes|.
9556 A side effect may be that t_Co changes and Vim will redraw the
9557 display.
9558
9559
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009560 vim:tw=78:ts=8:noet:ft=help:norl: