blob: a79e0b283dc76a854aa316cf6c263c76c8ac5507 [file] [log] [blame]
zeertzjq0049a492024-03-11 23:13:16 +08001*options.txt* For Vim version 9.1. Last change: 2024 Mar 11
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
h_east59858792023-10-25 22:47:05 +090074 *:set-args* *:set=* *E487* *E521*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075: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
Yee Cheng Chin900894b2023-09-29 20:42:32 +020082 set). Many string options with fixed syntax and names
83 also support completing known values. See
84 |cmdline-completion| and |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000085 White space between {option} and '=' is allowed and
86 will be ignored. White space between '=' and {value}
87 is not allowed.
88 See |option-backslash| for using white space and
89 backslashes in {value}.
90
91:se[t] {option}+={value} *:set+=*
92 Add the {value} to a number option, or append the
93 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010094 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000095 value was empty.
96 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000097 are removed. When adding a flag that was already
98 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000099 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100
101:se[t] {option}^={value} *:set^=*
102 Multiply the {value} to a number option, or prepend
103 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100104 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105 value was empty.
106 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000107
108:se[t] {option}-={value} *:set-=*
109 Subtract the {value} from a number option, or remove
110 the {value} from a string option, if it is there.
111 If the {value} is not found in a string option, there
112 is no error or warning. When the option is a comma
113 separated list, a comma is deleted, unless the option
114 becomes empty.
115 When the option is a list of flags, {value} must be
116 exactly as they appear in the option. Remove flags
117 one by one to avoid problems.
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200118 The individual values from a comma separated list or
119 list of flags can be inserted by typing 'wildchar'.
120 See |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122
123The {option} arguments to ":set" may be repeated. For example: >
124 :set ai nosi sw=3 ts=3
125If you make an error in one of the arguments, an error message will be given
126and the following arguments will be ignored.
127
128 *:set-verbose*
129When 'verbose' is non-zero, displaying an option value will also tell where it
130was last set. Example: >
131 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200132< shiftwidth=4 ~
133 Last set from modeline line 1 ~
134 cindent ~
135 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136This is only done when specific option values are requested, not for ":verbose
137set all" or ":verbose set" without an argument.
138When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139When the option was set while executing a function, user command or
140autocommand, the script in which it was defined is reported.
141Note that an option may also have been set as a side effect of setting
142'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000143A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200144 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000145 Option was set in a |modeline|.
146 Last set from --cmd argument ~
147 Option was set with command line argument |--cmd| or +.
148 Last set from -c argument ~
149 Option was set with command line argument |-c|, +, |-S| or
150 |-q|.
151 Last set from environment variable ~
152 Option was set from an environment variable, $VIMINIT,
153 $GVIMINIT or $EXINIT.
154 Last set from error handler ~
155 Option was cleared when evaluating it resulted in an error.
156
Bram Moolenaardb84e452010-08-15 13:50:43 +0200157{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158
159 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000160For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161override the value from the termcap. You can then use it in a mapping. If
162the "xx" part contains special characters, use the <t_xx> form: >
163 :set <t_#4>=^[Ot
164This can also be used to translate a special code for a normal key. For
165example, if Alt-b produces <Esc>b, use this: >
166 :set <M-b>=^[b
167(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
168The advantage over a mapping is that it works in all situations.
169
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100170You can define any key codes, e.g.: >
171 :set t_xy=^[foo;
172There is no warning for using a name that isn't recognized. You can map these
173codes as you like: >
174 :map <t_xy> something
175< *E846*
176When a key code is not set, it's like it does not exist. Trying to get its
177value will result in an error: >
178 :set t_kb=
179 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000180< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100181
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000182The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
183security reasons.
184
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000186at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187"set all" probably does not fit on the screen, causing Vim to give the
188|more-prompt|.
189
190 *option-backslash*
191To include white space in a string option value it has to be preceded with a
192backslash. To include a backslash you have to use two. Effectively this
193means that the number of backslashes in an option value is halved (rounded
194down).
Yee Cheng Chin54844852023-10-09 18:12:31 +0200195In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
196backslashes instead for compatibility with version 3.0 where the options can
197be separated by either commas or spaces.
198Comma-separated options like 'backupdir' and 'tags' will also require commas
199to be escaped with two backslashes, whereas this is not needed for
200non-comma-separated ones like 'makeprg'.
201When setting options using |:let| and |literal-string|, you need to use one
202fewer layer of backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203A few examples: >
Yee Cheng Chin54844852023-10-09 18:12:31 +0200204 :set makeprg=make\ file results in "make file"
205 :let &makeprg='make file' (same as above)
206 :set makeprg=make\\\ file results in "make\ file"
207 :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
208 :set tags=tags\\\ file results in "tags file"
209 :let &tags='tags\ file' (same as above)
210
211 :set makeprg=make,file results in "make,file"
212 :set makeprg=make\\,file results in "make\,file"
213 :set tags=tags,file results in "tags" and "file"
214 :set tags=tags\\,file results in "tags,file"
215 :let &tags='tags\,file' (same as above)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217The "|" character separates a ":set" command from a following command. To
218include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219'titlestring' option to "hi|there": >
220 :set titlestring=hi\|there
221This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
222 :set titlestring=hi|set iconstring=there
223
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200224Similarly, in legacy script the double quote character starts a comment. To
225include the '"' in the option value, use '\"' instead. This example sets the
226'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000227 :set titlestring=hi\ \"there\"
228
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200229In |Vim9| script it's simpler, comments start with a '#' character, and only
230when preceded by white space. A backslash is needed less often: >
231 vim9script
232 set titlestring=hi\ "there"
233 set titlestring=hi#there#
234 set titlestring=hi\ \#there#
235
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100236For Win32 backslashes in file names are mostly not removed. More precise: For
237options that expect a file name (those where environment variables are
238expanded) a backslash before a normal file name character is not removed. But
239a backslash before a special character (space, backslash, comma, etc.) is used
240like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000241There is one special situation, when the value starts with "\\": >
242 :set dir=\\machine\path results in "\\machine\path"
243 :set dir=\\\\machine\\path results in "\\machine\path"
244 :set dir=\\path\\file results in "\\path\file" (wrong!)
245For the first one the start is kept, but for the second one the backslashes
246are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000247halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248result which is probably not what you want. Avoid it.
249
250 *add-option-flags* *remove-option-flags*
251 *E539* *E550* *E551* *E552*
252Some options are a list of flags. When you want to add a flag to such an
253option, without changing the existing ones, you can do it like this: >
254 :set guioptions+=a
255Remove a flag from an option like this: >
256 :set guioptions-=a
257This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000258Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
260doesn't appear.
261
262 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000263Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264environment variable exists the '$' and the following environment variable
265name is replaced with its value. If it does not exist the '$' and the name
266are not modified. Any non-id character (not a letter, digit or '_') may
267follow the environment variable name. That character and what follows is
268appended to the value of the environment variable. Examples: >
269 :set term=$TERM.new
270 :set path=/usr/$INCLUDE,$HOME/include,.
271When adding or removing a string from an option with ":set opt-=val" or ":set
272opt+=val" the expansion is done before the adding or removing.
273
274
275Handling of local options *local-options*
276
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200277Note: The following also applies to |global-local| options.
278
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100280has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000281allows you to set 'list' in one window but not in another. And set
282'shiftwidth' to 3 in one buffer and 4 in another.
283
284The following explains what happens to these local options in specific
285situations. You don't really need to know all of this, since Vim mostly uses
286the option values you would expect. Unfortunately, doing what the user
287expects is a bit complicated...
288
289When splitting a window, the local options are copied to the new window. Thus
290right after the split the contents of the two windows look the same.
291
292When editing a new buffer, its local option values must be initialized. Since
293the local options of the current buffer might be specifically for that buffer,
294these are not used. Instead, for each buffer-local option there also is a
295global value, which is used for new buffers. With ":set" both the local and
296global value is changed. With "setlocal" only the local value is changed,
297thus this value is not used when editing a new buffer.
298
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200299When editing a buffer that has been edited before, the options from the window
300that was last closed are used again. If this buffer has been edited in this
301window, the values from back then are used. Otherwise the values from the
302last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303
304It's possible to set a local window option specifically for a type of buffer.
305When you edit another buffer in the same window, you don't want to keep
306using these local window options. Therefore Vim keeps a global value of the
307local window options, which is used when editing another buffer. Each window
308has its own copy of these values. Thus these are local to the window, but
309global to all buffers in the window. With this you can do: >
310 :e one
311 :set list
312 :e two
313Now the 'list' option will also be set in "two", since with the ":set list"
314command you have also set the global value. >
315 :set nolist
316 :e one
317 :setlocal list
318 :e two
319Now the 'list' option is not set, because ":set nolist" resets the global
320value, ":setlocal list" only changes the local value and ":e two" gets the
321global value. Note that if you do this next: >
322 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200323You will get back the 'list' value as it was the last time you edited "one".
324The options local to a window are remembered for each buffer. This also
325happens when the buffer is not loaded, but they are lost when the buffer is
326wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327
Christian Brabandt596ad662023-08-16 00:11:09 +0200328Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200329
330The following local window options won't be copied over when new windows are
331created, thus they behave slightly differently:
332
333 Option Reason ~
334 'previewwindow' there can only be a single one
335 'scroll' specific to existing window
zeertzjq0049a492024-03-11 23:13:16 +0800336 'winfixbuf' specific to existing window
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200337 'winfixheight' specific to existing window
338 'winfixwidth' specific to existing window
339
Christian Brabandt596ad662023-08-16 00:11:09 +0200340Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200341
342The following local buffer options won't be copied over when new buffers are
343created, thus they behave slightly differently:
344
345 Option Reason ~
346 'filetype' explicitly set by autocommands
347 'syntax' explicitly set by autocommands
348 'bufhidden' denote |special-buffers|
349 'buftype' denote |special-buffers|
350 'readonly' will be detected automatically
351 'modified' will be detected automatically
352
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100354:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 current buffer or window. Not all options have a
356 local value. If the option does not have a local
357 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200358 With the "all" argument: display local values for all
359 local options.
360 Without argument: Display local values for all local
361 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000363 local value. For a global/local boolean option, when
364 the global value is being used, "--" is displayed
365 before the option name.
366 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368
Matt Ellis374e26a2024-02-24 17:02:43 +0100369:se[t] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800370 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100371 For string |global-local| options, the local value is
372 removed, so that the global value will be used.
373 For all other options, the global value is copied to
374 the local value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000375
Matt Ellis374e26a2024-02-24 17:02:43 +0100376:setl[ocal] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800377 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100378 For number and boolean |global-local| options, the
379 local value is removed, so that the global value will
380 be used.
381 For all other options, including string |global-local|
382 options, the global value is copied to the local
383 value.
384
385Note that the behaviour for |global-local| options is slightly different
386between string and number-based options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387
388 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100389:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 option without changing the local value.
391 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200392 With the "all" argument: display global values for all
393 local options.
394 Without argument: display global values for all local
395 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396
397For buffer-local and window-local options:
398 Command global value local value ~
399 :set option=value set set
400 :setlocal option=value - set
401:setglobal option=value set -
402 :set option? - display
403 :setlocal option? - display
404:setglobal option? display -
405
406
407Global options with a local value *global-local*
408
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000409Options are global when you mostly use one value for all buffers and windows.
410For some global options it's useful to sometimes have a different local value.
411You can set the local value with ":setlocal". That buffer or window will then
412use the local value, while other buffers and windows continue using the global
413value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414
415For example, you have two windows, both on C source code. They use the global
416'makeprg' option. If you do this in one of the two windows: >
417 :set makeprg=gmake
418then the other window will switch to the same value. There is no need to set
419the 'makeprg' option in the other C source window too.
420However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000421another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000422files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423 :setlocal makeprg=perlmake
424You can switch back to using the global value by making the local value empty: >
425 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100426This only works for a string option. For a number or boolean option you need
427to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100429Note that for non-boolean and non-number options using "<" copies the global
430value to the local value, it doesn't switch back to using the global value
431(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000432 :set path<
433This will make the local value of 'path' empty, so that the global value is
434used. Thus it does the same as: >
435 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000436Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437":setlocal" on a global option might work differently then.
438
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000439 *option-value-function*
440Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000441'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000442a function name or a function reference or a lambda function. When using a
443lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000444>
445 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000446 set opfunc=function('MyOpFunc')
447 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000448 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000449
450Set to a script-local function: >
451 set opfunc=s:MyLocalFunc
452 set opfunc=<SID>MyLocalFunc
453In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
454the script: >
455 set opfunc=MyLocalFunc
456
457Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000458 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000459 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000460
461Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000462 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000463
464Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000465 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000466 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000467
468In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300469closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000470context of where it was defined.
471
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000472
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473Setting the filetype
474
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200475:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476 Set the 'filetype' option to {filetype}, but only if
477 not done yet in a sequence of (nested) autocommands.
478 This is short for: >
479 :if !did_filetype()
480 : setlocal filetype={filetype}
481 :endif
482< This command is used in a filetype.vim file to avoid
483 setting the 'filetype' option twice, causing different
484 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200485
486 When the optional FALLBACK argument is present, a
487 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100488 'filetype'. This is to be used for filetype
489 detections that are just a guess. |did_filetype()|
490 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200491
Bram Moolenaard58e9292011-02-09 17:07:58 +0100492 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
494:opt[ions] Open a window for viewing and setting all options.
495 Options are grouped by function.
496 Offers short help for each option. Hit <CR> on the
497 short help to open a help window with more help for
498 the option.
499 Modify the value of the option and hit <CR> on the
500 "set" line to set the new value. For window and
501 buffer specific options, the last accessed window is
502 used to set the option value in, unless this is a help
503 window, in which case the window below help window is
504 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100505 {not available when compiled without the |+eval|
506 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000507
508 *$HOME*
509Using "~" is like using "$HOME", but it is only recognized at the start of an
510option and after a space or comma.
511
512On Unix systems "~user" can be used too. It is replaced by the home directory
513of user "user". Example: >
514 :set path=~mool/include,/usr/include,.
515
516On Unix systems the form "${HOME}" can be used too. The name between {} can
517contain non-id characters then. Note that if you want to use this for the
518"gf" command, you need to add the '{' and '}' characters to 'isfname'.
519
520NOTE: expanding environment variables and "~/" is only done with the ":set"
521command, not when assigning a value to an option with ":let".
522
Bram Moolenaarc572da52017-08-27 16:52:01 +0200523 *$HOME-windows*
524On MS-Windows, if $HOME is not defined as an environment variable, then
525at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200526If $HOMEDRIVE is not set then $USERPROFILE is used.
527
528This expanded value is not exported to the environment, this matters when
529running an external command: >
530 :echo system('set | findstr ^HOME=')
531and >
532 :echo luaeval('os.getenv("HOME")')
533should echo nothing (an empty string) despite exists('$HOME') being true.
534When setting $HOME to a non-empty string it will be exported to the
535subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200536
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538Note the maximum length of an expanded option is limited. How much depends on
539the system, mostly it is something like 256 or 1024 characters.
540
541 *:fix* *:fixdel*
542:fix[del] Set the value of 't_kD':
543 't_kb' is 't_kD' becomes ~
544 CTRL-? CTRL-H
545 not CTRL-? CTRL-?
546
Bram Moolenaar82be4842021-01-11 19:40:15 +0100547 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000548
549 If your delete key terminal code is wrong, but the
550 code for backspace is alright, you can put this in
551 your .vimrc: >
552 :fixdel
553< This works no matter what the actual code for
554 backspace is.
555
556 If the backspace key terminal code is wrong you can
557 use this: >
558 :if &term == "termname"
559 : set t_kb=^V<BS>
560 : fixdel
561 :endif
562< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000563 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564 with your terminal name.
565
566 If your <Delete> key sends a strange key sequence (not
567 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
568 :if &term == "termname"
569 : set t_kD=^V<Delete>
570 :endif
571< Where "^V" is CTRL-V and "<Delete>" is the delete key
572 (don't type eight characters!). Replace "termname"
573 with your terminal name.
574
575 *Linux-backspace*
576 Note about Linux: By default the backspace key
577 produces CTRL-?, which is wrong. You can fix it by
578 putting this line in your rc.local: >
579 echo "keycode 14 = BackSpace" | loadkeys
580<
581 *NetBSD-backspace*
582 Note about NetBSD: If your backspace doesn't produce
583 the right code, try this: >
584 xmodmap -e "keycode 22 = BackSpace"
585< If this works, add this in your .Xmodmap file: >
586 keysym 22 = BackSpace
587< You need to restart for this to take effect.
588
589==============================================================================
5902. Automatically setting options *auto-setting*
591
592Besides changing options with the ":set" command, there are three alternatives
593to set options automatically for one or more files:
594
5951. When starting Vim initializations are read from various places. See
596 |initialization|. Most of them are performed for all editing sessions,
597 and some of them depend on the directory where Vim is started.
598 You can create an initialization file with |:mkvimrc|, |:mkview| and
599 |:mksession|.
6002. If you start editing a new file, the automatic commands are executed.
601 This can be used to set options for files matching a particular pattern and
602 many other things. See |autocommand|.
6033. If you start editing a new file, and the 'modeline' option is on, a
604 number of lines at the beginning and end of the file are checked for
605 modelines. This is explained here.
606
607 *modeline* *vim:* *vi:* *ex:* *E520*
608There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100609 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100611[text{white}] empty or any text followed by at least one blank
612 character (<Space> or <Tab>); "ex:" always requires at
613 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200614{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200615[white] optional white space
616{options} a list of option settings, separated with white space
617 or ':', where each part between ':' is the argument
618 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619
Bram Moolenaar14b69452013-06-29 23:05:20 +0200620Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000621 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200622 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623
624The second form (this is compatible with some versions of Vi):
625
Bram Moolenaarade0d392020-01-21 22:33:58 +0100626 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000627
Bram Moolenaarade0d392020-01-21 22:33:58 +0100628[text{white}] empty or any text followed by at least one blank
629 character (<Space> or <Tab>); "ex:" always requires at
630 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200631{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
632[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200633se[t] the string "set " or "se " (note the space); When
634 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200635{options} a list of options, separated with white space, which
636 is the argument for a ":set" command
637: a colon
638[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639
Bram Moolenaar14b69452013-06-29 23:05:20 +0200640Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000641 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200642 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200644The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
645chance that a normal word like "lex:" is caught. There is one exception:
646"vi:" and "vim:" can also be at the start of the line (for compatibility with
647version 3.0). Using "ex:" at the start of the line will be ignored (this
648could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649
Hu Jialun9dcd3492021-08-28 20:42:50 +0200650If the modeline is disabled within a modeline, subsequent modelines will be
651ignored. This is to allow turning off modeline on a per-file basis. This is
652useful when a line looks like a modeline but isn't. For example, it would be
653good to start a YAML file containing strings like "vim:" with
654 # vim: nomodeline ~
655so as to avoid modeline misdetection. Following options on the same line
656after modeline deactivation, if any, are still evaluated (but you would
657normally not have any).
658
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 *modeline-local*
660The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000661buffer and window that contain the file. Although it's possible to set global
662options from a modeline, this is unusual. If you have two windows open and
663the files in it set the same global option to a different value, the result
664depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000666When editing a file that was already loaded, only the window-local options
667from the modeline are used. Thus if you manually changed a buffer-local
668option after opening the file, it won't be changed if you edit the same buffer
669in another window. But window-local options will be set.
670
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671 *modeline-version*
672If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200673number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 vim{vers}: version {vers} or later
675 vim<{vers}: version before {vers}
676 vim={vers}: version {vers}
677 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100678{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
679For example, to use a modeline only for Vim 7.0:
680 /* vim700: set foldmethod=marker */ ~
681To use a modeline for Vim after version 7.2:
682 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683There can be no blanks between "vim" and the ":".
684
685
686The number of lines that are checked can be set with the 'modelines' option.
687If 'modeline' is off or 'modelines' is 0 no lines are checked.
688
689Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000690like:
691 /* vi:ts=4: */ ~
692will give an error message for the trailing "*/". This line is OK:
693 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694
695If an error is detected the rest of the line is skipped.
696
697If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000698backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100699 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
700This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
701before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200702 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000704might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200705can be set. For some options a flag is set, so that when the value is used
706the |sandbox| is effective. Some options can only be set from the modeline
707when 'modelineexpr' is set (the default is off).
708
709Still, there is always a small risk that a modeline causes trouble. E.g.,
710when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
711So disable modelines before editing untrusted text. The mail ftplugin does
712this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713
714Hint: If you would like to do something else than setting an option, you could
715define an autocommand that checks the file for a specific string. For
716example: >
717 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
718And define a function SetVar() that does something with the line containing
719"VAR".
720
721==============================================================================
7223. Options summary *option-summary*
723
724In the list below all the options are mentioned with their full name and with
725an abbreviation if there is one. Both forms may be used.
726
727In this document when a boolean option is "set" that means that ":set option"
728is entered. When an option is "reset", ":set nooption" is used.
729
730For some options there are two default values: The "Vim default", which is
731used when 'compatible' is not set, and the "Vi default", which is used when
732'compatible' is set.
733
734Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000735are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736different value in each window. For example the 'list' option can be set in
737one window and reset in another for the same text, giving both types of view
738at the same time. There are a few options that are specific to a certain
739file. These can have a different value for each file or buffer. For example
740the 'textwidth' option can be 78 for a normal text file and 0 for a C
741program.
742
743 global one option for all buffers and windows
744 local to window each window has its own copy of this option
745 local to buffer each buffer has its own copy of this option
746
747When creating a new window the option values from the currently active window
748are used as a default value for the window-specific options. For the
749buffer-specific options this depends on the 's' and 'S' flags in the
750'cpoptions' option. If 's' is included (which is the default) the values for
751buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000752first entered. If 'S' is present the options are copied each time the buffer
753is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754present, the options are copied from the currently active buffer when the
755buffer is created.
756
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000757Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000759Not all options are supported in all versions. This depends on the supported
760features and sometimes on the system. A remark about this is in curly braces
761below. When an option is not supported it may still be set without getting an
762error, this is called a hidden option. You can't get the value of a hidden
763option though, it is not stored.
764
765To test if option "foo" can be used with ":set" use something like this: >
766 if exists('&foo')
767This also returns true for a hidden option. To test if option "foo" is really
768supported use something like this: >
769 if exists('+foo')
770<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 *E355*
772A jump table for the options with a short description can be found at |Q_op|.
773
774 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100775'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 {only available when compiled with the |+rightleft|
778 feature}
779 The ASCII code for the first letter of the Hebrew alphabet. The
780 routine that maps the keyboard in Hebrew mode, both in Insert mode
781 (when hkmap is set) and on the command-line (when hitting CTRL-_)
782 outputs the Hebrew characters in the range [aleph..aleph+26].
783 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
784 See |rileft.txt|.
785
786 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
787'allowrevins' 'ari' boolean (default off)
788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 {only available when compiled with the |+rightleft|
790 feature}
791 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
792 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
793 into reverse Insert mode, and don't know how to get out. See
794 'revins'.
795 NOTE: This option is reset when 'compatible' is set.
796
797 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
798'altkeymap' 'akm' boolean (default off)
799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 {only available when compiled with the |+farsi|
801 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100802 This option was for using Farsi, which has been removed. See
803 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804
805 *'ambiwidth'* *'ambw'*
806'ambiwidth' 'ambw' string (default: "single")
807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
809 Tells Vim what to do with characters with East Asian Width Class
810 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
811 letters, Cyrillic letters).
812
813 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000814 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 expected by most users.
816 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200817 *E834* *E835*
818 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100819 contains a character that would be double width. These errors may
820 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200821
822 The values are overruled for characters specified with
823 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824
825 There are a number of CJK fonts for which the width of glyphs for
826 those characters are solely based on how many octets they take in
827 legacy/traditional CJK encodings. In those encodings, Euro,
828 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000829 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000831 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 Vim is running inside a terminal (emulators) that uses a CJK font
833 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
834 this option should be set to "double" to match the width perceived
835 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100836 to be set to "double" under CJK MS-Windows when the system locale is
837 set to one of CJK locales. See Unicode Standard Annex #11
838 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100840 Vim may set this option automatically at startup time when Vim is
841 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200842 escape sequence to request cursor position report. The response can
843 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100844
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
846'antialias' 'anti' boolean (default: off)
847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200849 on macOS}
850 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
852 which can be easier to read at certain sizes on certain displays.
853 Setting this option can sometimes cause problems if 'guifont' is set
854 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100855 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
858'arabic' 'arab' boolean (default off)
859 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 {only available when compiled with the |+arabic|
861 feature}
862 This option can be set to start editing Arabic text.
863 Setting this option will:
864 - Set the 'rightleft' option, unless 'termbidi' is set.
865 - Set the 'arabicshape' option, unless 'termbidi' is set.
866 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
867 between typing English and Arabic key mapping.
868 - Set the 'delcombine' option
869 Note that 'encoding' must be "utf-8" for working with Arabic text.
870
871 Resetting this option will:
872 - Reset the 'rightleft' option.
873 - Disable the use of 'keymap' (without changing its value).
874 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200875 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100876 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 Also see |arabic.txt|.
878
879 *'arabicshape'* *'arshape'*
880 *'noarabicshape'* *'noarshape'*
881'arabicshape' 'arshape' boolean (default on)
882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 {only available when compiled with the |+arabic|
884 feature}
885 When on and 'termbidi' is off, the required visual character
886 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200887 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 one which encompasses:
889 a) the changing/morphing of characters based on their location
890 within a word (initial, medial, final and stand-alone).
891 b) the enabling of the ability to compose characters
892 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100893 When disabled the display shows each character's true stand-alone
894 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 Arabic is a complex language which requires other settings, for
896 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100897 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898
laburnumT3f7855a2023-12-05 18:37:03 +0100899 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
900'autochdir' 'acd' boolean (default off)
901 global
902 {only available when compiled with it, use
903 exists("+autochdir") to check}
904 When on, Vim will change the current working directory whenever you
905 open a file, switch buffers, delete a buffer or open/close a window.
906 It will change to the directory containing the file which was opened
907 or selected. When a buffer has no name it also has no directory, thus
908 the current directory won't change when navigating to it.
909 Note: When this option is on some plugins may not work.
910
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
912'autoindent' 'ai' boolean (default off)
913 local to buffer
914 Copy indent from current line when starting a new line (typing <CR>
915 in Insert mode or when using the "o" or "O" command). If you do not
916 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000917 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
918 to another line has the same effect, unless the 'I' flag is included
919 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000920 When autoindent is on, formatting (with the "gq" command or when you
921 reach 'textwidth' in Insert mode) uses the indentation of the first
922 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923 When 'smartindent' or 'cindent' is on the indent is changed in
924 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200925 The 'autoindent' option is reset when the 'paste' option is set and
926 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927
928 *'autoread'* *'ar'* *'noautoread'* *'noar'*
929'autoread' 'ar' boolean (default off)
930 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 When a file has been detected to have been changed outside of Vim and
932 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200933 When the file has been deleted this is not done, so you have the text
934 from before it was deleted. When it appears again then it is read.
935 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 If this option has a local value, use this command to switch back to
937 using the global value: >
938 :set autoread<
939<
laburnumT3f7855a2023-12-05 18:37:03 +0100940
941 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
942'autoshelldir' 'asd' boolean (default off)
943 global
944 When on, Vim will change the current working directory whenever you
945 change the directory of the shell running in a terminal window. You
946 need proper setting-up, so whenever the shell's pwd changes an OSC 7
947 escape sequence will be emitted. For example, on Linux, you can
948 source /etc/profile.d/vte.sh in your shell profile if you use bash or
949 zsh. For bash this should work (put it in a bash init file): >
950 if [[ -n "$VIM_TERMINAL" ]]; then
951 PROMPT_COMMAND='_vim_sync_PWD'
952 function _vim_sync_PWD() {
953 printf '\033]7;file://%s\033\\' "$PWD"
954 }
955 fi
956<
957 Or, in a zsh init file: >
958 if [[ -n "$VIM_TERMINAL" ]]; then
959 autoload -Uz add-zsh-hook
960 add-zsh-hook -Uz chpwd _vim_sync_PWD
961 function _vim_sync_PWD() {
962 printf '\033]7;file://%s\033\\' "$PWD"
963 }
964 fi
965<
966 In a fish init file: >
967 if test -n "$VIM_TERMINAL"
968 function _vim_sync_PWD --on-variable=PWD
969 printf '\033]7;file://%s\033\\' "$PWD"
970 end
971 end
972<
973 You can find an alternative method at |terminal-autoshelldir|.
974 When the parsing of the OSC sequence fails you get *E1179* .
975
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
977'autowrite' 'aw' boolean (default off)
978 global
979 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000980 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000981 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
982 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000983 to another file.
984 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000985 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 Note that for some commands the 'autowrite' option is not used, see
987 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200988 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200989 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100990 USE WITH CARE: If you make temporary changes to a buffer that you
991 don't want to be saved this option may cause it to be saved anyway.
992 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993
994 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
995'autowriteall' 'awa' boolean (default off)
996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
998 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
999 Setting this option also implies that Vim behaves like 'autowrite' has
1000 been set.
1001
1002 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001003'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 When set to "dark", Vim will try to use colors that look good on a
1006 dark background. When set to "light", Vim will try to use colors that
1007 look good on a light background. Any other value is illegal.
1008 Vim tries to set the default value according to the terminal used.
1009 This will not always be correct.
1010 Setting this option does not change the background color, it tells Vim
1011 what the background color looks like. For changing the background
1012 color, see |:hi-normal|.
1013
Gregory Anders83ad2722024-01-03 19:48:51 +01001014 When 'background' is changed Vim will adjust the default color groups
1015 for the new value. But the colors used for syntax highlighting will
1016 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001017 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001018 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 the color scheme adjusts to the value of 'background' this will work.
1020 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001021 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022
1023 When setting 'background' to the default value with: >
1024 :set background&
1025< Vim will guess the value. In the GUI this should work correctly,
1026 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001027 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001028 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001030 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001031 color from the terminal. If the returned RGB value is dark/light and
1032 'background' is not dark/light, 'background' will be set and the
1033 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001034 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001035 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001036
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 When starting the GUI, the default value for 'background' will be
1038 "light". When the value is not set in the .gvimrc, and Vim detects
1039 that the background is actually quite dark, 'background' is set to
1040 "dark". But this happens only AFTER the .gvimrc file has been read
1041 (because the window needs to be opened to find the actual background
1042 color). To get around this, force the GUI window to be opened by
1043 putting a ":gui" command in the .gvimrc file, before where the value
1044 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001045
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001046 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001047 For other systems "dark" is used when 'term' is "linux",
1048 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1049 background. Otherwise the default is "light".
1050
Bram Moolenaarc572da52017-08-27 16:52:01 +02001051 The |:terminal| command and the |term_start()| function use the
1052 'background' value to decide whether the terminal window will start
1053 with a white or black background.
1054
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 Normally this option would be set in the .vimrc file. Possibly
1056 depending on the terminal name. Example: >
1057 :if &term == "pcterm"
1058 : set background=dark
1059 :endif
1060< When this option is set, the default settings for the highlight groups
1061 will change. To use other settings, place ":highlight" commands AFTER
1062 the setting of the 'background' option.
1063 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1064 to select the colors for syntax highlighting. After changing this
1065 option, you must load syntax.vim again to see the result. This can be
1066 done with ":syntax on".
1067
1068 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001069'backspace' 'bs' string (default "", set to "indent,eol,start"
1070 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1073 mode. This is a list of items, separated by commas. Each item allows
1074 a way to backspace over something:
1075 value effect ~
1076 indent allow backspacing over autoindent
1077 eol allow backspacing over line breaks (join lines)
1078 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1079 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001080 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1081 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082
Bram Moolenaar46eea442022-03-30 10:51:39 +01001083 When the value is empty, Vi compatible backspacing is used, none of
1084 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
1086 For backwards compatibility with version 5.4 and earlier:
1087 value effect ~
1088 0 same as ":set backspace=" (Vi compatible)
1089 1 same as ":set backspace=indent,eol"
1090 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001091 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092
1093 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1094 NOTE: This option is set to "" when 'compatible' is set.
1095
1096 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1097'backup' 'bk' boolean (default off)
1098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 Make a backup before overwriting a file. Leave it around after the
1100 file has been successfully written. If you do not want to keep the
1101 backup file, but you do want a backup while the file is being
1102 written, reset this option and set the 'writebackup' option (this is
1103 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001104 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 |backup-table| for more explanations.
1106 When the 'backupskip' pattern matches, a backup is not made anyway.
1107 When 'patchmode' is set, the backup may be renamed to become the
1108 oldest version of a file.
1109 NOTE: This option is reset when 'compatible' is set.
1110
1111 *'backupcopy'* *'bkc'*
1112'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001113 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001115 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116
1117 The main values are:
1118 "yes" make a copy of the file and overwrite the original one
1119 "no" rename the file and write a new one
1120 "auto" one of the previous, what works best
1121
1122 Extra values that can be combined with the ones above are:
1123 "breaksymlink" always break symlinks when writing
1124 "breakhardlink" always break hardlinks when writing
1125
1126 Making a copy and overwriting the original file:
1127 - Takes extra time to copy the file.
1128 + When the file has special attributes, is a (hard/symbolic) link or
1129 has a resource fork, all this is preserved.
1130 - When the file is a link the backup will have the name of the link,
1131 not of the real file.
1132
1133 Renaming the file and writing a new one:
1134 + It's fast.
1135 - Sometimes not all attributes of the file can be copied to the new
1136 file.
1137 - When the file is a link the new file will not be a link.
1138
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001139 The "auto" value is the middle way: When Vim sees that renaming the
1140 file is possible without side effects (the attributes can be passed on
1141 and the file is not a link) that is used. When problems are expected,
1142 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143
1144 The "breaksymlink" and "breakhardlink" values can be used in
1145 combination with any of "yes", "no" and "auto". When included, they
1146 force Vim to always break either symbolic or hard links by doing
1147 exactly what the "no" option does, renaming the original file to
1148 become the backup and writing a new file in its place. This can be
1149 useful for example in source trees where all the files are symbolic or
1150 hard links and any changes should stay in the local source tree, not
1151 be propagated back to the original source.
1152 *crontab*
1153 One situation where "no" and "auto" will cause problems: A program
1154 that opens a file, invokes Vim to edit that file, and then tests if
1155 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001156 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157 example.
1158
1159 When a copy is made, the original file is truncated and then filled
1160 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001161 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001162 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 group of the backup is set to the group of the original file. If this
1164 fails, the protection bits for the group are made the same as for
1165 others.
1166
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001167 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 the same attributes of the original file, and the newly written file
1169 is owned by the current user. When the file was a (hard/symbolic)
1170 link, the new file will not! That's why the "auto" value doesn't
1171 rename when the file is a link. The owner and group of the newly
1172 written file will be set to the same ones as the original file, but
1173 the system may refuse to do this. In that case the "auto" value will
1174 again not rename the file.
1175
Bram Moolenaar036986f2017-03-16 17:41:02 +01001176 NOTE: This option is set to the Vi default value when 'compatible' is
1177 set and to the Vim default value when 'compatible' is reset.
1178
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 *'backupdir'* *'bdir'*
1180'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001181 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 for Unix: ".,~/tmp,~/")
1183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 List of directories for the backup file, separated with commas.
1185 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001186 where this is possible. The directory must exist, Vim will not
1187 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001188 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189 impossible!). Writing may fail because of this.
1190 - A directory "." means to put the backup file in the same directory
1191 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001192 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1193 the backup file relative to where the edited file is. The leading
1194 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 ("." inside a directory name has no special meaning).
1196 - Spaces after the comma are ignored, other spaces are considered part
1197 of the directory name. To have a space at the start of a directory
1198 name, precede it with a backslash.
1199 - To include a comma in a directory name precede it with a backslash.
1200 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001201 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001202 the backup file name will be built from the complete path to the
1203 file with all path separators changed to percent '%' signs. This
1204 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001205 On Win32, it is also possible to end with "\\". However, When a
1206 separating comma is following, you must use "//", since "\\" will
1207 include the comma in the file name. Therefore it is recommended to
1208 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 - Environment variables are expanded |:set_env|.
1210 - Careful with '\' characters, type one before a space, type two to
1211 get one in the option (see |option-backslash|), for example: >
1212 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1213< - For backwards compatibility with Vim version 3.0 a '>' at the start
1214 of the option is removed.
1215 See also 'backup' and 'writebackup' options.
1216 If you want to hide your backup files on Unix, consider this value: >
1217 :set backupdir=./.backup,~/.backup,.,/tmp
1218< You must create a ".backup" directory in each directory and in your
1219 home directory for this to work properly.
1220 The use of |:set+=| and |:set-=| is preferred when adding or removing
1221 directories from the list. This avoids problems when a future version
1222 uses another default.
1223 This option cannot be set from a |modeline| or in the |sandbox|, for
1224 security reasons.
1225
1226 *'backupext'* *'bex'* *E589*
1227'backupext' 'bex' string (default "~", for VMS: "_")
1228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 String which is appended to a file name to make the name of the
1230 backup file. The default is quite unusual, because this avoids
1231 accidentally overwriting existing files with a backup file. You might
1232 prefer using ".bak", but make sure that you don't have files with
1233 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001234 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001236 If you like to keep a lot of backups, you could use a BufWritePre
1237 autocommand to change 'backupext' just before writing the file to
1238 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001239 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001240< Use 'backupdir' to put the backup in a different directory.
1241
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001243'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1244 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1245 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 A list of file patterns. When one of the patterns matches with the
1248 name of the file which is written, no backup file is created. Both
1249 the specified file name and the full path name of the file are used.
1250 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1251 Watch out for special characters, see |option-backslash|.
1252 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001253 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001254
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001255 WARNING: Not having a backup file means that when Vim fails to write
1256 your buffer correctly and then, for whatever reason, Vim exits, you
1257 lose both the original file and what you were writing. Only disable
1258 backups if you don't care about losing the file.
1259
Bram Moolenaar02467872007-05-06 13:22:01 +00001260 Note that environment variables are not expanded. If you want to use
1261 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001262 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001263
1264< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001265 backup would be made by renaming the original file crontab won't see
1266 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267
1268 *'balloondelay'* *'bdlay'*
1269'balloondelay' 'bdlay' number (default: 600)
1270 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271 {only available when compiled with the |+balloon_eval|
1272 feature}
1273 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1274
1275 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1276'ballooneval' 'beval' boolean (default off)
1277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001279 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001280 Switch on the |balloon-eval| functionality for the GUI.
1281
1282 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1283 *'nobevalterm'*
1284'balloonevalterm' 'bevalterm' boolean (default off)
1285 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001286 {only available when compiled with the
1287 |+balloon_eval_term| feature}
1288 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001290 *'balloonexpr'* *'bexpr'*
1291'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001292 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001293 {only available when compiled with the |+balloon_eval|
1294 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001295 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001296 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1297 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001298
1299 v:beval_bufnr number of the buffer in which balloon is going to show
1300 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001301 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001302 v:beval_lnum line number
1303 v:beval_col column number (byte index)
1304 v:beval_text word under or after the mouse pointer
1305
Bram Moolenaar54775062019-07-31 21:07:14 +02001306 Instead of showing a balloon, which is limited to plain text, consider
1307 using a popup window, see |popup_beval_example|. A popup window can
1308 use highlighting and show a border.
1309
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001310 The evaluation of the expression must not have side effects!
1311 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001312 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001313 return 'Cursor is at line ' .. v:beval_lnum ..
1314 \ ', column ' .. v:beval_col ..
1315 \ ' of file ' .. bufname(v:beval_bufnr) ..
1316 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001317 endfunction
1318 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001319 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001320<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001321 Also see |balloon_show()|, it can be used if the content of the balloon
1322 is to be fetched asynchronously. In that case evaluating
1323 'balloonexpr' should result in an empty string. If you get a balloon
1324 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001325
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001326 NOTE: The balloon is displayed only if the cursor is on a text
1327 character. If the result of evaluating 'balloonexpr' is not empty,
1328 Vim does not try to send a message to an external debugger (Netbeans
1329 or Sun Workshop).
1330
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001331 If the expression starts with s: or |<SID>|, then it is replaced with
1332 the script ID (|local-function|). Example: >
1333 set bexpr=s:MyBalloonExpr()
1334 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001335< Otherwise, the expression is evaluated in the context of the script
1336 where the option was set, thus script-local items are available.
1337
Bram Moolenaar30b65812012-07-12 22:01:11 +02001338 The expression will be evaluated in the |sandbox| when set from a
1339 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001340 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001341
1342 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001343 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001344
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001345 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001346 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001347< When they are supported "\n" characters will start a new line. If the
1348 expression evaluates to a |List| this is equal to using each List item
1349 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001350 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001351
Bram Moolenaar165bc692015-07-21 17:53:25 +02001352 *'belloff'* *'bo'*
1353'belloff' 'bo' string (default "")
1354 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001355 Specifies for which events the bell will not be rung. It is a comma
1356 separated list of items. For each item that is present, the bell
1357 will be silenced. This is most useful to specify specific events in
1358 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001359 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001360
1361 item meaning when present ~
1362 all All events.
1363 backspace When hitting <BS> or <Del> and deleting results in an
1364 error.
1365 cursor Fail to move around using the cursor keys or
1366 <PageUp>/<PageDown> in |Insert-mode|.
1367 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1368 |i_CTRL-X_CTRL-T|.
1369 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1370 |i_CTRL-E|.
1371 ctrlg Unknown Char after <C-G> in Insert mode.
1372 error Other Error occurred (e.g. try to join last line)
1373 (mostly used in |Normal-mode| or |Cmdline-mode|).
1374 esc hitting <Esc> in |Normal-mode|.
1375 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001376 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001377 insertmode Pressing <Esc> in 'insertmode'.
1378 lang Calling the beep module for Lua/Mzscheme/TCL.
1379 mess No output available for |g<|.
1380 showmatch Error occurred for 'showmatch' function.
1381 operator Empty region error |cpo-E|.
1382 register Unknown register after <C-R> in |Insert-mode|.
1383 shell Bell from shell output |:!|.
1384 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001385 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001386 wildmode More matches in |cmdline-completion| available
1387 (depends on the 'wildmode' setting).
1388
Bram Moolenaar036986f2017-03-16 17:41:02 +01001389 This is most useful to fine tune when in Insert mode the bell should
1390 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001391 indicate that an error occurred. It can be silenced by adding the
1392 "error" keyword.
1393
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1395'binary' 'bin' boolean (default off)
1396 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 This option should be set before editing a binary file. You can also
1398 use the |-b| Vim argument. When this option is switched on a few
1399 options will be changed (also when it already was on):
1400 'textwidth' will be set to 0
1401 'wrapmargin' will be set to 0
1402 'modeline' will be off
1403 'expandtab' will be off
1404 Also, 'fileformat' and 'fileformats' options will not be used, the
1405 file is read and written like 'fileformat' was "unix" (a single <NL>
1406 separates lines).
1407 The 'fileencoding' and 'fileencodings' options will not be used, the
1408 file is read without conversion.
1409 NOTE: When you start editing a(nother) file while the 'bin' option is
1410 on, settings from autocommands may change the settings again (e.g.,
1411 'textwidth'), causing trouble when editing. You might want to set
1412 'bin' again when the file has been loaded.
1413 The previous values of these options are remembered and restored when
1414 'bin' is switched from on to off. Each buffer has its own set of
1415 saved option values.
1416 To edit a file with 'binary' set you can use the |++bin| argument.
1417 This avoids you have to do ":set bin", which would have effect for all
1418 files you edit.
1419 When writing a file the <EOL> for the last line is only written if
1420 there was one in the original file (normally Vim appends an <EOL> to
1421 the last line if there is none; this would make the file longer). See
1422 the 'endofline' option.
1423
1424 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1425'bioskey' 'biosk' boolean (default on)
1426 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001427 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001428 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429
1430 *'bomb'* *'nobomb'*
1431'bomb' boolean (default off)
1432 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 When writing a file and the following conditions are met, a BOM (Byte
1434 Order Mark) is prepended to the file:
1435 - this option is on
1436 - the 'binary' option is off
1437 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1438 endian variants.
1439 Some applications use the BOM to recognize the encoding of the file.
1440 Often used for UCS-2 files on MS-Windows. For other applications it
1441 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001442 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1444 check for the presence of the BOM is done and 'bomb' set accordingly.
1445 Unless 'binary' is set, it is removed from the first line, so that you
1446 don't see it when editing. When you don't change the options, the BOM
1447 will be restored when writing the file.
1448
1449 *'breakat'* *'brk'*
1450'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1451 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001452 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 feature}
1454 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001455 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1456 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001458 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001459'breakindent' 'bri' boolean (default off)
1460 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001461 {not available when compiled without the |+linebreak|
1462 feature}
1463 Every wrapped line will continue visually indented (same amount of
1464 space as the beginning of that line), thus preserving horizontal blocks
1465 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001466 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001467
1468 *'breakindentopt'* *'briopt'*
1469'breakindentopt' 'briopt' string (default empty)
1470 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001471 {not available when compiled without the |+linebreak|
1472 feature}
1473 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001474 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001475 min:{n} Minimum text width that will be kept after
1476 applying 'breakindent', even if the resulting
1477 text should normally be narrower. This prevents
1478 text indented almost to the right window border
1479 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001480 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001481 shift:{n} After applying 'breakindent', the wrapped line's
1482 beginning will be shifted by the given number of
1483 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001484 indentation (negative) or emphasizing the line
1485 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001486 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001487 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001488 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001489 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001490 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001491 numbered or bulleted list (using the
1492 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001493 list:-1 Uses the length of a match with 'formatlistpat'
1494 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001495 (default: 0)
1496 column:{n} Indent at column {n}. Will overrule the other
1497 sub-options. Note: an additional indent may be
1498 added for the 'showbreak' setting.
1499 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001500
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001502'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001504 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001506 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001507 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 buffer Use the directory of the related buffer.
1509 current Use the current directory.
1510 {path} Use the specified directory
1511
1512 *'bufhidden'* *'bh'*
1513'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001514 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515 This option specifies what happens when a buffer is no longer
1516 displayed in a window:
1517 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001518 hide hide the buffer (don't unload it), even if 'hidden' is
1519 not set
1520 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001521 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001522 delete delete the buffer from the buffer list, even if
1523 'hidden' is set; the |:hide| command will also delete
1524 the buffer, making it behave like |:bdelete|
1525 wipe wipe the buffer from the buffer list, even if
1526 'hidden' is set; the |:hide| command will also wipe
1527 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001529 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001530 are lost without a warning. Also, these values may break autocommands
1531 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 This option is used together with 'buftype' and 'swapfile' to specify
1533 special kinds of buffers. See |special-buffers|.
1534
1535 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1536'buflisted' 'bl' boolean (default: on)
1537 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 When this option is set, the buffer shows up in the buffer list. If
1539 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1540 This option is reset by Vim for buffers that are only used to remember
1541 a file name or marks. Vim sets it when starting to edit a buffer.
1542 But not when moving to a buffer with ":buffer".
1543
1544 *'buftype'* *'bt'* *E382*
1545'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001546 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 The value of this option specifies the type of a buffer:
1548 <empty> normal buffer
1549 nofile buffer which is not related to a file and will not be
1550 written
1551 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001552 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001553 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001555 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 help help buffer (you are not supposed to set this
1557 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001558 terminal buffer for a |terminal| (you are not supposed to set
1559 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001560 prompt buffer where only the last line can be edited, meant
1561 to be used by a plugin, see |prompt-buffer|
1562 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001563 popup buffer used in a popup window, see |popup|.
1564 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565
1566 This option is used together with 'bufhidden' and 'swapfile' to
1567 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001568 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569
1570 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001571 One such effect is that Vim will not check the timestamp of the file,
1572 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573
Bram Moolenaar280f1262006-01-30 00:14:18 +00001574 A "quickfix" buffer is only used for the error list and the location
1575 list. This value is set by the |:cwindow| and |:lwindow| commands and
1576 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
1578 "nofile" and "nowrite" buffers are similar:
1579 both: The buffer is not to be written to disk, ":w" doesn't
1580 work (":w filename" does work though).
1581 both: The buffer is never considered to be |'modified'|.
1582 There is no warning when the changes will be lost, for
1583 example when you quit Vim.
1584 both: A swap file is only created when using too much memory
1585 (when 'swapfile' has been reset there is never a swap
1586 file).
1587 nofile only: The buffer name is fixed, it is not handled like a
1588 file name. It is not modified in response to a |:cd|
1589 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001590 both: When using ":e bufname" and already editing "bufname"
1591 the buffer is made empty and autocommands are
1592 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001593 *E676*
1594 "acwrite" implies that the buffer name is not related to a file, like
1595 "nofile", but it will be written. Thus, in contrast to "nofile" and
1596 "nowrite", ":w" does work and a modified buffer can't be abandoned
1597 without saving. For writing there must be matching |BufWriteCmd|,
1598 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599
1600 *'casemap'* *'cmp'*
1601'casemap' 'cmp' string (default: "internal,keepascii")
1602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 Specifies details about changing the case of letters. It may contain
1604 these words, separated by a comma:
1605 internal Use internal case mapping functions, the current
1606 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001607 matters when 'encoding' is a Unicode encoding,
1608 "latin1" or "iso-8859-15". When "internal" is
1609 omitted, the towupper() and towlower() system library
1610 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1612 case mapping, the current locale is not effective.
1613 This probably only matters for Turkish.
1614
Bram Moolenaar938ae282023-02-20 20:44:55 +00001615 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001616'cdhome' 'cdh' boolean (default: off)
1617 global
1618 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1619 current working directory to the |$HOME| directory like in Unix.
1620 When off, those commands just print the current directory name.
1621 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001622 This option cannot be set from a |modeline| or in the |sandbox|, for
1623 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001624 NOTE: This option is reset when 'compatible' is set.
1625
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 *'cdpath'* *'cd'* *E344* *E346*
1627'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001630 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1631 searched for has a relative path, not an absolute part starting with
1632 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 The 'cdpath' option's value has the same form and semantics as
1634 |'path'|. Also see |file-searching|.
1635 The default value is taken from $CDPATH, with a "," prepended to look
1636 in the current directory first.
1637 If the default value taken from $CDPATH is not what you want, include
1638 a modified version of the following command in your vimrc file to
1639 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001640 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641< This option cannot be set from a |modeline| or in the |sandbox|, for
1642 security reasons.
1643 (parts of 'cdpath' can be passed to the shell to expand file names).
1644
1645 *'cedit'*
1646'cedit' string (Vi default: "", Vim default: CTRL-F)
1647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648 The key used in Command-line Mode to open the command-line window.
1649 The default is CTRL-F when 'compatible' is off.
1650 Only non-printable keys are allowed.
1651 The key can be specified as a single character, but it is difficult to
1652 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001653 :exe "set cedit=\<C-Y>"
1654 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655< |Nvi| also has this option, but it only uses the first character.
1656 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001657 NOTE: This option is set to the Vim default value when 'compatible'
1658 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659
1660 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1661'charconvert' 'ccv' string (default "")
1662 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001663 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 An expression that is used for character encoding conversion. It is
1665 evaluated when a file that is to be read or has been written has a
1666 different encoding from what is desired.
1667 'charconvert' is not used when the internal iconv() function is
1668 supported and is able to do the conversion. Using iconv() is
1669 preferred, because it is much faster.
1670 'charconvert' is not used when reading stdin |--|, because there is no
1671 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001672 The expression must return zero, false or an empty string for success,
1673 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 The possible encoding names encountered are in 'encoding'.
1675 Additionally, names given in 'fileencodings' and 'fileencoding' are
1676 used.
1677 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1678 is done internally by Vim, 'charconvert' is not used for this.
1679 'charconvert' is also used to convert the viminfo file, if the 'c'
1680 flag is present in 'viminfo'. Also used for Unicode conversion.
1681 Example: >
1682 set charconvert=CharConvert()
1683 fun CharConvert()
1684 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001685 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1686 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 return v:shell_error
1688 endfun
1689< The related Vim variables are:
1690 v:charconvert_from name of the current encoding
1691 v:charconvert_to name of the desired encoding
1692 v:fname_in name of the input file
1693 v:fname_out name of the output file
1694 Note that v:fname_in and v:fname_out will never be the same.
1695 Note that v:charconvert_from and v:charconvert_to may be different
1696 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001697
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001698 The advantage of using a function call without arguments is that it is
1699 faster, see |expr-option-function|.
1700
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 Encryption is not done by Vim when using 'charconvert'. If you want
1702 to encrypt the file after conversion, 'charconvert' should take care
1703 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001704
1705 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1706 replaced with the script ID (|local-function|). Example: >
1707 set charconvert=s:MyConvert()
1708 set charconvert=<SID>SomeConvert()
1709< Otherwise the expression is evaluated in the context of the script
1710 where the option was set, thus script-local items are available.
1711
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 This option cannot be set from a |modeline| or in the |sandbox|, for
1713 security reasons.
1714
1715 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1716'cindent' 'cin' boolean (default off)
1717 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001718 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 that trigger reindenting in insert mode and 'cinoptions' to set your
1720 preferred indent style.
1721 If 'indentexpr' is not empty, it overrules 'cindent'.
1722 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1723 the "=" operator indents using this algorithm rather than calling an
1724 external program.
1725 See |C-indenting|.
1726 When you don't like the way 'cindent' works, try the 'smartindent'
1727 option or 'indentexpr'.
1728 This option is not used when 'paste' is set.
1729 NOTE: This option is reset when 'compatible' is set.
1730
1731 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001732'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 A list of keys that, when typed in Insert mode, cause reindenting of
1735 the current line. Only used if 'cindent' is on and 'indentexpr' is
1736 empty.
1737 For the format of this option see |cinkeys-format|.
1738 See |C-indenting|.
1739
1740 *'cinoptions'* *'cino'*
1741'cinoptions' 'cino' string (default "")
1742 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1744 program. See |cinoptions-values| for the values of this option, and
1745 |C-indenting| for info on C indenting in general.
1746
laburnumT3f7855a2023-12-05 18:37:03 +01001747 *'cinscopedecls'* *'cinsd'*
1748'cinscopedecls' 'cinsd' string (default "public,protected,private")
1749 local to buffer
1750 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1751 Useful e.g. for working with the Qt framework that defines additional
1752 scope declarations "signals", "public slots" and "private slots": >
1753 set cinscopedecls+=signals,public\ slots,private\ slots
1754<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 *'cinwords'* *'cinw'*
1756'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1757 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 These keywords start an extra indent in the next line when
1759 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1760 an appropriate place (inside {}).
1761 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1762 matter, include the keyword both the uppercase and lowercase:
1763 "if,If,IF".
1764
laburnumT3f7855a2023-12-05 18:37:03 +01001765 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1767 for X-windows, "" otherwise)
1768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 {only in GUI versions or when the |+xterm_clipboard|
1770 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001771 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001772 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001773 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001774 prepend, e.g.: >
1775 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001776< When using the GUI see |'go-A'|.
1777 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001779 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 unnamed When included, Vim will use the clipboard register '*'
1781 for all yank, delete, change and put operations which
1782 would normally go to the unnamed register. When a
1783 register is explicitly specified, it will always be
1784 used regardless of whether "unnamed" is in 'clipboard'
1785 or not. The clipboard register can always be
1786 explicitly accessed using the "* notation. Also see
1787 |gui-clipboard|.
1788
Bram Moolenaar30b65812012-07-12 22:01:11 +02001789 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001790 unnamedplus A variant of the "unnamed" flag which uses the
1791 clipboard register '+' (|quoteplus|) instead of
1792 register '*' for all yank, delete, change and put
1793 operations which would normally go to the unnamed
1794 register. When "unnamed" is also included to the
1795 option, yank operations (but not delete, change or
1796 put) will additionally copy the text into register
1797 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001798 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001799 Availability can be checked with: >
1800 if has('unnamedplus')
1801<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001802 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 autoselect Works like the 'a' flag in 'guioptions': If present,
1804 then whenever Visual mode is started, or the Visual
1805 area extended, Vim tries to become the owner of the
1806 windowing system's global selection or put the
1807 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001808 register "*. See |'go-a'| and |quotestar| for details.
1809 When the GUI is active, the 'a' flag in 'guioptions'
1810 is used, when the GUI is not active, this "autoselect"
1811 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 Also applies to the modeless selection.
1813
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001814 *clipboard-autoselectplus*
1815 autoselectplus Like "autoselect" but using the + register instead of
1816 the * register. Compare to the 'P' flag in
1817 'guioptions'.
1818
1819 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 autoselectml Like "autoselect", but for the modeless selection
1821 only. Compare to the 'A' flag in 'guioptions'.
1822
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001823 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001824 html When the clipboard contains HTML, use this when
1825 pasting. When putting text on the clipboard, mark it
1826 as HTML. This works to copy rendered HTML from
1827 Firefox, paste it as raw HTML in Vim, select the HTML
1828 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001829 You probably want to add this only temporarily,
1830 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001831 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001832
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001833 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 exclude:{pattern}
1835 Defines a pattern that is matched against the name of
1836 the terminal 'term'. If there is a match, no
1837 connection will be made to the X server. This is
1838 useful in this situation:
1839 - Running Vim in a console.
1840 - $DISPLAY is set to start applications on another
1841 display.
1842 - You do not want to connect to the X server in the
1843 console, but do want this in a terminal emulator.
1844 To never connect to the X server use: >
1845 exclude:.*
1846< This has the same effect as using the |-X| argument.
1847 Note that when there is no connection to the X server
1848 the window title won't be restored and the clipboard
1849 cannot be accessed.
1850 The value of 'magic' is ignored, {pattern} is
1851 interpreted as if 'magic' was on.
1852 The rest of the option value will be used for
1853 {pattern}, this must be the last entry.
1854
1855 *'cmdheight'* *'ch'*
1856'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001857 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001858 Number of screen lines to use for the command-line. A larger value
1859 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001860 The value of this option is stored with the tab page, so that each tab
1861 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862
1863 *'cmdwinheight'* *'cwh'*
1864'cmdwinheight' 'cwh' number (default 7)
1865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 Number of screen lines to use for the command-line window. |cmdwin|
1867
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001868 *'colorcolumn'* *'cc'*
1869'colorcolumn' 'cc' string (default "")
1870 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001871 {not available when compiled without the |+syntax|
1872 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001873 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001874 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1875 text. Will make screen redrawing slower.
1876 The screen column can be an absolute number, or a number preceded with
1877 '+' or '-', which is added to or subtracted from 'textwidth'. >
1878
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001879 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001880 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1881 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1882<
1883 When 'textwidth' is zero then the items with '-' and '+' are not used.
1884 A maximum of 256 columns are highlighted.
1885
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 *'columns'* *'co'* *E594*
1887'columns' 'co' number (default 80 or terminal width)
1888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001890 initialization and does not have to be set by hand. Also see
1891 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 When Vim is running in the GUI or in a resizable window, setting this
1893 option will cause the window size to be changed. When you only want
1894 to use the size for the GUI, put the command in your |gvimrc| file.
1895 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001896 number of columns of the display, the display may be messed up. For
1897 the GUI it is always possible and Vim limits the number of columns to
1898 what fits on the screen. You can use this command to get the widest
1899 window possible: >
1900 :set columns=9999
1901< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902
1903 *'comments'* *'com'* *E524* *E525*
1904'comments' 'com' string (default
1905 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1906 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001907 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 |format-comments|. See |option-backslash| about using backslashes to
1909 insert a space.
1910
1911 *'commentstring'* *'cms'* *E537*
1912'commentstring' 'cms' string (default "/*%s*/")
1913 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 {not available when compiled without the |+folding|
1915 feature}
1916 A template for a comment. The "%s" in the value is replaced with the
1917 comment text. Currently only used to add markers for folding, see
1918 |fold-marker|.
1919
1920 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001921'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001922 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 This option has the effect of making Vim either more Vi-compatible, or
1925 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001926
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001928 other options are also changed as a side effect.
1929 NOTE: Setting or resetting this option can have a lot of unexpected
1930 effects: Mappings are interpreted in another way, undo behaves
1931 differently, etc. If you set this option in your vimrc file, you
1932 should probably put it at the very start.
1933
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 By default this option is on and the Vi defaults are used for the
1935 options. This default was chosen for those people who want to use Vim
1936 just like Vi, and don't even (want to) know about the 'compatible'
1937 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001938 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001939 this option is switched off, and all options that have not been
1940 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001941 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001942 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001943 happen for the system-wide vimrc or gvimrc file, nor for a file given
1944 with the |-u| argument). Also see |compatible-default| and
1945 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 You can also set this option with the "-C" argument, and reset it with
1947 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001948 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949
Bram Moolenaar214641f2017-03-05 17:04:09 +01001950 When this option is set, numerous other options are set to make Vim as
1951 Vi-compatible as possible. When this option is unset, various options
1952 are set to make Vim more useful. The table below lists all the
1953 options affected.
1954 The {?} column indicates when the options are affected:
1955 + Means that the option is set to the value given in {set value} when
1956 'compatible' is set.
1957 & Means that the option is set to the value given in {set value} when
1958 'compatible' is set AND is set to its Vim default value when
1959 'compatible' is unset.
1960 - Means the option is NOT changed when setting 'compatible' but IS
1961 set to its Vim default when 'compatible' is unset.
1962 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963
Bram Moolenaar036986f2017-03-16 17:41:02 +01001964 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001965
1966 'allowrevins' + off no CTRL-_ command
1967 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001968 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001969 'arabicshape' + on correct character shapes
1970 'backspace' + "" normal backspace
1971 'backup' + off no backup file
1972 'backupcopy' & Unix: "yes" backup file is a copy
1973 else: "auto" copy or rename backup file
1974 'balloonexpr' + "" text to show in evaluation balloon
1975 'breakindent' + off don't indent when wrapping lines
1976 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001977 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001978 'cindent' + off no C code indentation
1979 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1980 'copyindent' + off don't copy indent structure
1981 'cpoptions' & (all flags) Vi-compatible flags
1982 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001983 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001984 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001985 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001986 'cscopeverbose' + off see |cscopeverbose|
1987 'delcombine' + off unicode: delete whole char combination
1988 'digraph' + off no digraphs
1989 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001990 this also disables |modifyOtherKeys|
1991 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001992 'expandtab' + off tabs not expanded to spaces
1993 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001994 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001995 'formatexpr' + "" use 'formatprg' for auto-formatting
1996 'formatoptions' & "vt" Vi compatible formatting
1997 'gdefault' + off no default 'g' flag for ":s"
1998 'history' & 0 no commandline history
1999 'hkmap' + off no Hebrew keyboard mapping
2000 'hkmapp' + off no phonetic Hebrew keyboard mapping
2001 'hlsearch' + off no highlighting of search matches
2002 'incsearch' + off no incremental searching
2003 'indentexpr' + "" no indenting by expression
2004 'insertmode' + off do not start in Insert mode
2005 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002007 'joinspaces' + on insert 2 spaces after period
2008 'modeline' & off no modelines
2009 'more' & off no pauses in listings
2010 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2011 'numberwidth' & 8 min number of columns for line number
2012 'preserveindent'+ off don't preserve current indent structure
2013 when changing it
2014 'revins' + off no reverse insert
2015 'ruler' + off no ruler
2016 'scrolljump' + 1 no jump scroll
2017 'scrolloff' + 0 no scroll offset
2018 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2019 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002020 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002021 'showcmd' & off command characters not shown
2022 'showmode' & off current mode not shown
2023 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2024 'smartcase' + off no automatic ignore case switch
2025 'smartindent' + off no smart indentation
2026 'smarttab' + off no smart tab size
2027 'softtabstop' + 0 tabs are always 'tabstop' positions
2028 'startofline' + on goto startofline with some commands
2029 'tagcase' & "followic" 'ignorecase' when searching tags file
2030 'tagrelative' & off tag file names are not relative
2031 'termguicolors' + off don't use highlight-(guifg|guibg)
2032 'textauto' & off no automatic textmode detection
2033 'textwidth' + 0 no automatic line wrap
2034 'tildeop' + off tilde is not an operator
2035 'ttimeout' + off no terminal timeout
2036 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002037 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002038 'virtualedit' + "" cursor can only be placed on characters
2039 'whichwrap' & "" left-right movements don't wrap
2040 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002042 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043
2044 *'complete'* *'cpt'* *E535*
2045'complete' 'cpt' string (default: ".,w,b,u,t,i")
2046 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 This option specifies how keyword completion |ins-completion| works
2048 when CTRL-P or CTRL-N are used. It is also used for whole-line
2049 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002050 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002051 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 w scan buffers from other windows
2053 b scan other loaded buffers that are in the buffer list
2054 u scan the unloaded buffers that are in the buffer list
2055 U scan the buffers that are not in the buffer list
2056 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002057 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 k{dict} scan the file {dict}. Several "k" flags can be given,
2059 patterns are valid too. For example: >
2060 :set cpt=k/usr/dict/*,k~/spanish
2061< s scan the files given with the 'thesaurus' option
2062 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2063 are valid too.
2064 i scan current and included files
2065 d scan current and included files for defined name or macro
2066 |i_CTRL-X_CTRL-D|
2067 ] tag completion
2068 t same as "]"
2069
2070 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2071 not executed, this may lead to unexpected completions from some files
2072 (gzipped files for example). Unloaded buffers are not scanned for
2073 whole-line completion.
2074
2075 The default is ".,w,b,u,t,i", which means to scan:
2076 1. the current buffer
2077 2. buffers in other windows
2078 3. other loaded buffers
2079 4. unloaded buffers
2080 5. tags
2081 6. included files
2082
2083 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002084 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2085 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002087 *'completefunc'* *'cfu'*
2088'completefunc' 'cfu' string (default: empty)
2089 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002090 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002091 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002092 This option specifies a function to be used for Insert mode completion
2093 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002094 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002095 invoked and what it should return. The value can be the name of a
2096 function, a |lambda| or a |Funcref|. See |option-value-function| for
2097 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002098 This option cannot be set from a |modeline| or in the |sandbox|, for
2099 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002100
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002101 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002102'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002103 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002104 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002105 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002106
2107 menu Use a popup menu to show the possible completions. The
2108 menu is only shown when there is more than one match and
2109 sufficient colors are available. |ins-completion-menu|
2110
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002111 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002112 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002113 match, e.g., what file it comes from.
2114
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002115 longest Only insert the longest common text of the matches. If
2116 the menu is displayed you can use CTRL-L to add more
2117 characters. Whether case is ignored depends on the kind
2118 of completion. For buffer text the 'ignorecase' option is
2119 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002120
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002121 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002122 completion in the preview window. Only works in
2123 combination with "menu" or "menuone".
2124
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002125 popup Show extra information about the currently selected
2126 completion in a popup window. Only works in combination
2127 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002128 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002129 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002130
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002131 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002132 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002133 |CompleteChanged| autocommand to fetch the info and call
2134 |popup_show()| once the popup has been filled.
2135 See the example at |complete-popuphidden|.
2136 {only works when compiled with the |+textprop| feature}
2137
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002138 noinsert Do not insert any text for a match until the user selects
2139 a match from the menu. Only works in combination with
2140 "menu" or "menuone". No effect if "longest" is present.
2141
2142 noselect Do not select a match in the menu, force the user to
2143 select one from the menu. Only works in combination with
2144 "menu" or "menuone".
2145
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002146 *'completepopup'* *'cpp'*
2147'completepopup' 'cpp' string (default empty)
2148 global
2149 {not available when compiled without the |+textprop|
2150 or |+quickfix| feature}
2151 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002152 properties of the info popup when it is created. If an info popup
2153 window already exists it is closed, so that the option value is
2154 applied when it is created again.
2155 You can also use |popup_findinfo()| and then set properties for an
2156 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002157
laburnumT3f7855a2023-12-05 18:37:03 +01002158 *'completeslash'* *'csl'*
2159'completeslash' 'csl' string (default: "")
2160 local to buffer
2161 {only for MS-Windows}
2162 When this option is set it overrules 'shellslash' for completion:
2163 - When this option is set to "slash", a forward slash is used for path
2164 completion in insert mode. This is useful when editing HTML tag, or
2165 Makefile with 'noshellslash' on MS-Windows.
2166 - When this option is set to "backslash", backslash is used. This is
2167 useful when editing a batch file with 'shellslash' set on MS-Windows.
2168 - When this option is empty, same character is used as for
2169 'shellslash'.
2170 For Insert mode completion the buffer-local value is used. For
2171 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002172
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002173 *'concealcursor'* *'cocu'*
2174'concealcursor' 'cocu' string (default: "")
2175 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002176 {not available when compiled without the |+conceal|
2177 feature}
2178 Sets the modes in which text in the cursor line can also be concealed.
2179 When the current mode is listed then concealing happens just like in
2180 other lines.
2181 n Normal mode
2182 v Visual mode
2183 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002184 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002185
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002186 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002187 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002188 are moving around text is concealed, but when starting to insert text
2189 or selecting a Visual area the concealed text is displayed, so that
2190 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002191 Keep in mind that the cursor position is not always where it's
2192 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002193
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002194 *'conceallevel'* *'cole'*
2195'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002196 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002197 {not available when compiled without the |+conceal|
2198 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002199 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2200 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002201
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002202 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002203 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002204 1 Each block of concealed text is replaced with one
2205 character. If the syntax item does not have a custom
2206 replacement character defined (see |:syn-cchar|) the
2207 character defined in 'listchars' is used (default is a
2208 space).
2209 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002210 2 Concealed text is completely hidden unless it has a
2211 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002212 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002213 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002214
Bram Moolenaara7781e02010-07-19 20:13:22 +02002215 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002216 edit and copy the text. This can be changed with the 'concealcursor'
2217 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002218
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2220'confirm' 'cf' boolean (default off)
2221 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222 When 'confirm' is on, certain operations that would normally
2223 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2224 instead raise a |dialog| asking if you wish to save the current
2225 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2226 If 'confirm' is off you can still activate confirmation for one
2227 command only (this is most useful in mappings) with the |:confirm|
2228 command.
2229 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2230
2231 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2232'conskey' 'consk' boolean (default off)
2233 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002234 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235
2236 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2237'copyindent' 'ci' boolean (default off)
2238 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 Copy the structure of the existing lines indent when autoindenting a
2240 new line. Normally the new indent is reconstructed by a series of
2241 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2242 in which case only spaces are used). Enabling this option makes the
2243 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002244 existing line. 'expandtab' has no effect on these characters, a Tab
2245 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002247 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 Also see 'preserveindent'.
2249
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002250 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251'cpoptions' 'cpo' string (Vim default: "aABceFs",
2252 Vi default: all flags)
2253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002255 this indicates Vi-compatible behavior. This is used for things where
2256 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 'cpoptions' stands for "compatible-options".
2258 Commas can be added for readability.
2259 To avoid problems with flags that are added in the future, use the
2260 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002261
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 NOTE: This option is set to the Vi default value when 'compatible' is
2263 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002264
2265 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2266 is saved, 'cpoptions' is set to the Vim default, and the saved value
2267 is restored at the end of the script. Changes to the value of
2268 'cpoptions' will be applied to the saved value, but keep in mind that
2269 removing a flag that is not present when 'cpoptions' is changed has no
2270 effect. In the |.vimrc| file the value is not restored, thus using
2271 `vim9script` in the |.vimrc| file results in using the Vim default.
2272
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002273 NOTE: This option is set to the POSIX default value at startup when
2274 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002275 variable exists |posix|. This means Vim tries to behave like the
2276 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277
2278 contains behavior ~
2279 *cpo-a*
2280 a When included, a ":read" command with a file name
2281 argument will set the alternate file name for the
2282 current window.
2283 *cpo-A*
2284 A When included, a ":write" command with a file name
2285 argument will set the alternate file name for the
2286 current window.
2287 *cpo-b*
2288 b "\|" in a ":map" command is recognized as the end of
2289 the map command. The '\' is included in the mapping,
2290 the text after the '|' is interpreted as the next
2291 command. Use a CTRL-V instead of a backslash to
2292 include the '|' in the mapping. Applies to all
2293 mapping, abbreviation, menu and autocmd commands.
2294 See also |map_bar|.
2295 *cpo-B*
2296 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002297 abbreviations, user commands and the "to" part of the
2298 menu commands. Remove this flag to be able to use a
2299 backslash like a CTRL-V. For example, the command
2300 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301 'B' included: "\^[" (^[ is a real <Esc>)
2302 'B' excluded: "<Esc>" (5 characters)
2303 ('<' excluded in both cases)
2304 *cpo-c*
2305 c Searching continues at the end of any match at the
2306 cursor position, but not further than the start of the
2307 next line. When not present searching continues
2308 one character from the cursor position. With 'c'
2309 "abababababab" only gets three matches when repeating
2310 "/abab", without 'c' there are five matches.
2311 *cpo-C*
2312 C Do not concatenate sourced lines that start with a
2313 backslash. See |line-continuation|.
2314 *cpo-d*
2315 d Using "./" in the 'tags' option doesn't mean to use
2316 the tags file relative to the current file, but the
2317 tags file in the current directory.
2318 *cpo-D*
2319 D Can't use CTRL-K to enter a digraph after Normal mode
2320 commands with a character argument, like |r|, |f| and
2321 |t|.
2322 *cpo-e*
2323 e When executing a register with ":@r", always add a
2324 <CR> to the last line, also when the register is not
2325 linewise. If this flag is not present, the register
2326 is not linewise and the last line does not end in a
2327 <CR>, then the last line is put on the command-line
2328 and can be edited before hitting <CR>.
2329 *cpo-E*
2330 E It is an error when using "y", "d", "c", "g~", "gu" or
2331 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002332 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 This makes "y0" fail in the first column.
2334 *cpo-f*
2335 f When included, a ":read" command with a file name
2336 argument will set the file name for the current buffer,
2337 if the current buffer doesn't have a file name yet.
2338 *cpo-F*
2339 F When included, a ":write" command with a file name
2340 argument will set the file name for the current
2341 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002342 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343 *cpo-g*
2344 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002345 *cpo-H*
2346 H When using "I" on a line with only blanks, insert
2347 before the last blank. Without this flag insert after
2348 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 *cpo-i*
2350 i When included, interrupting the reading of a file will
2351 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002352 *cpo-I*
2353 I When moving the cursor up or down just after inserting
2354 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355 *cpo-j*
2356 j When joining lines, only add two spaces after a '.',
2357 not after '!' or '?'. Also see 'joinspaces'.
2358 *cpo-J*
2359 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002360 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 white space.
2362 *cpo-k*
2363 k Disable the recognition of raw key codes in
2364 mappings, abbreviations, and the "to" part of menu
2365 commands. For example, if <Key> sends ^[OA (where ^[
2366 is <Esc>), the command ":map X ^[OA" results in X
2367 being mapped to:
2368 'k' included: "^[OA" (3 characters)
2369 'k' excluded: "<Key>" (one key code)
2370 Also see the '<' flag below.
2371 *cpo-K*
2372 K Don't wait for a key code to complete when it is
2373 halfway a mapping. This breaks mapping <F1><F1> when
2374 only part of the second <F1> has been read. It
2375 enables cancelling the mapping by typing <F1><Esc>.
2376 *cpo-l*
2377 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002378 literally, only "\]", "\^", "\-" and "\\" are special.
2379 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2381 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002382 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 *cpo-L*
2384 L When the 'list' option is set, 'wrapmargin',
2385 'textwidth', 'softtabstop' and Virtual Replace mode
2386 (see |gR|) count a <Tab> as two characters, instead of
2387 the normal behavior of a <Tab>.
2388 *cpo-m*
2389 m When included, a showmatch will always wait half a
2390 second. When not included, a showmatch will wait half
2391 a second or until a character is typed. |'showmatch'|
2392 *cpo-M*
2393 M When excluded, "%" matching will take backslashes into
2394 account. Thus in "( \( )" and "\( ( \)" the outer
2395 parenthesis match. When included "%" ignores
2396 backslashes, which is Vi compatible.
2397 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002398 n When included, the column used for 'number' and
2399 'relativenumber' will also be used for text of wrapped
2400 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 *cpo-o*
2402 o Line offset to search command is not remembered for
2403 next search.
2404 *cpo-O*
2405 O Don't complain if a file is being overwritten, even
2406 when it didn't exist when editing it. This is a
2407 protection against a file unexpectedly created by
2408 someone else. Vi didn't complain about this.
2409 *cpo-p*
2410 p Vi compatible Lisp indenting. When not present, a
2411 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002412 *cpo-P*
2413 P When included, a ":write" command that appends to a
2414 file will set the file name for the current buffer, if
2415 the current buffer doesn't have a file name yet and
2416 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002417 *cpo-q*
2418 q When joining multiple lines leave the cursor at the
2419 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 *cpo-r*
2421 r Redo ("." command) uses "/" to repeat a search
2422 command, instead of the actually used search string.
2423 *cpo-R*
2424 R Remove marks from filtered lines. Without this flag
2425 marks are kept like |:keepmarks| was used.
2426 *cpo-s*
2427 s Set buffer options when entering the buffer for the
2428 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002429 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 set when the buffer is created.
2431 *cpo-S*
2432 S Set buffer options always when entering a buffer
2433 (except 'readonly', 'fileformat', 'filetype' and
2434 'syntax'). This is the (most) Vi compatible setting.
2435 The options are set to the values in the current
2436 buffer. When you change an option and go to another
2437 buffer, the value is copied. Effectively makes the
2438 buffer options global to all buffers.
2439
2440 's' 'S' copy buffer options
2441 no no when buffer created
2442 yes no when buffer first entered (default)
2443 X yes each time when buffer entered (vi comp.)
2444 *cpo-t*
2445 t Search pattern for the tag command is remembered for
2446 "n" command. Otherwise Vim only puts the pattern in
2447 the history for search pattern, but doesn't change the
2448 last used search pattern.
2449 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002450 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 *cpo-v*
2452 v Backspaced characters remain visible on the screen in
2453 Insert mode. Without this flag the characters are
2454 erased from the screen right away. With this flag the
2455 screen newly typed text overwrites backspaced
2456 characters.
2457 *cpo-w*
2458 w When using "cw" on a blank character, only change one
2459 character and not all blanks until the start of the
2460 next word.
2461 *cpo-W*
2462 W Don't overwrite a readonly file. When omitted, ":w!"
2463 overwrites a readonly file, if possible.
2464 *cpo-x*
2465 x <Esc> on the command-line executes the command-line.
2466 The default in Vim is to abandon the command-line,
2467 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002468 *cpo-X*
2469 X When using a count with "R" the replaced text is
2470 deleted only once. Also when repeating "R" with "."
2471 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002473 y A yank command can be redone with ".". Think twice if
2474 you really want to use this, it may break some
2475 plugins, since most people expect "." to only repeat a
2476 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002477 *cpo-Z*
2478 Z When using "w!" while the 'readonly' option is set,
2479 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480 *cpo-!*
2481 ! When redoing a filter command, use the last used
2482 external command, whatever it was. Otherwise the last
2483 used -filter- command is used.
2484 *cpo-$*
2485 $ When making a change to one line, don't redisplay the
2486 line, but put a '$' at the end of the changed text.
2487 The changed text will be overwritten when you type the
2488 new text. The line is redisplayed if you type any
2489 command that moves the cursor from the insertion
2490 point.
2491 *cpo-%*
2492 % Vi-compatible matching is done for the "%" command.
2493 Does not recognize "#if", "#endif", etc.
2494 Does not recognize "/*" and "*/".
2495 Parens inside single and double quotes are also
2496 counted, causing a string that contains a paren to
2497 disturb the matching. For example, in a line like
2498 "if (strcmp("foo(", s))" the first paren does not
2499 match the last one. When this flag is not included,
2500 parens inside single and double quotes are treated
2501 specially. When matching a paren outside of quotes,
2502 everything inside quotes is ignored. When matching a
2503 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002504 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002505 This flag is also used for other features, such as
2506 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002507 *cpo--*
2508 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002509 it would go above the first line or below the last
2510 line. Without it the cursor moves to the first or
2511 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002512 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002513 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002514 *cpo-+*
2515 + When included, a ":write file" command will reset the
2516 'modified' flag of the buffer, even though the buffer
2517 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002518 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519 * Use ":*" in the same way as ":@". When not included,
2520 ":*" is an alias for ":'<,'>", select the Visual area.
2521 *cpo-<*
2522 < Disable the recognition of special key codes in |<>|
2523 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002524 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 ":map X <Tab>" results in X being mapped to:
2526 '<' included: "<Tab>" (5 characters)
2527 '<' excluded: "^I" (^I is a real <Tab>)
2528 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002529 *cpo->*
2530 > When appending to a register, put a line break before
2531 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002532 *cpo-;*
2533 ; When using |,| or |;| to repeat the last |t| search
2534 and the cursor is right in front of the searched
2535 character, the cursor won't move. When not included,
2536 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002537 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002538
2539 POSIX flags. These are not included in the Vi default value, except
2540 when $VIM_POSIX was set on startup. |posix|
2541
2542 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002543 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002544 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002545 *cpo-&*
2546 & When ":preserve" was used keep the swap file when
2547 exiting normally while this buffer is still loaded.
2548 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002549 *cpo-\*
2550 \ Backslash in a [] range in a search pattern is taken
2551 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002552 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2553 '\' excluded: "/[ \-]" finds <Space> and '-'
2554 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002555 *cpo-/*
2556 / When "%" is used as the replacement string in a |:s|
2557 command, use the previous replacement string. |:s%|
2558 *cpo-{*
2559 { The |{| and |}| commands also stop at a "{" character
2560 at the start of a line.
2561 *cpo-.*
2562 . The ":chdir" and ":cd" commands fail if the current
2563 buffer is modified, unless ! is used. Vim doesn't
2564 need this, since it remembers the full path of an
2565 opened file.
2566 *cpo-bar*
2567 | The value of the $LINES and $COLUMNS environment
2568 variables overrule the terminal size values obtained
2569 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002570
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002571 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002572'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002573 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002574 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002575 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002576 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002577 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002578 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002579 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002580 blowfish Blowfish method. Medium strong encryption but it has
2581 an implementation flaw. Requires Vim 7.3 or later,
2582 files can NOT be read by Vim 7.2 and older. This adds
2583 a "seed" to the file, every time you write the file
2584 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002585 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002586 *blowfish2*
2587 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002588 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002589 and older. This adds a "seed" to the file, every time
2590 you write the file the encrypted bytes will be
2591 different. The whole undo file is encrypted, not just
2592 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002593 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002594 *E1197* *E1198* *E1199* *E1200* *E1201*
2595 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2596 Code. Medium strong till strong encryption.
2597 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002598 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002599 It adds a seed and a message authentication code (MAC)
2600 to the file. This needs at least a Vim 8.2.3022 to
2601 read the encrypted file.
2602 Encryption of swap files is not supported, therefore
2603 no swap file will be used when xchacha20 encryption is
2604 enabled.
2605 Encryption of undo files is not yet supported,
2606 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002607 CAREFUL: Files written with this method might have to
2608 be read back with the same version of Vim if the
2609 binary format changes later.
2610 Obsolete, please do no longer use.
2611 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2612 stores the key derivation parameters together with the
2613 encrypted file. Should work better in case the
2614 parameters in the libsodium library ever change.
2615 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002616 might have to be read back with the same version of
2617 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002618
Christian Brabandtaae58342023-04-23 17:50:22 +01002619 You should use "blowfish2", also to re-encrypt older files. The
2620 "xchacha20" method provides better encryption, but it does not work
2621 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002622
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002623 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002624 to the detected method of the file being read. Thus if you write it
2625 without changing 'cryptmethod' the same method will be used.
2626 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002627 explicitly write it, you don't get a warning unless there are other
2628 modifications. Also see |:X|.
2629
2630 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002631 the value "blowfish2". When setting the local value to an empty
2632 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002633
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002634 When a new encryption method is added in a later version of Vim, and
2635 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002636 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002637
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 *'cscopepathcomp'* *'cspc'*
2639'cscopepathcomp' 'cspc' number (default 0)
2640 global
2641 {not available when compiled without the |+cscope|
2642 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 Determines how many components of the path to show in a list of tags.
2644 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002645 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646
2647 *'cscopeprg'* *'csprg'*
2648'cscopeprg' 'csprg' string (default "cscope")
2649 global
2650 {not available when compiled without the |+cscope|
2651 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 Specifies the command to execute cscope. See |cscopeprg|.
2653 This option cannot be set from a |modeline| or in the |sandbox|, for
2654 security reasons.
2655
2656 *'cscopequickfix'* *'csqf'*
2657'cscopequickfix' 'csqf' string (default "")
2658 global
2659 {not available when compiled without the |+cscope|
2660 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 Specifies whether to use quickfix window to show cscope results.
2662 See |cscopequickfix|.
2663
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002664 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002665'cscoperelative' 'csre' boolean (default off)
2666 global
2667 {not available when compiled without the |+cscope|
2668 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002669 In the absence of a prefix (-P) for cscope. setting this option enables
2670 to use the basename of cscope.out path as the prefix.
2671 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002672 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002673
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2675'cscopetag' 'cst' boolean (default off)
2676 global
2677 {not available when compiled without the |+cscope|
2678 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 Use cscope for tag commands. See |cscope-options|.
2680 NOTE: This option is reset when 'compatible' is set.
2681
2682 *'cscopetagorder'* *'csto'*
2683'cscopetagorder' 'csto' number (default 0)
2684 global
2685 {not available when compiled without the |+cscope|
2686 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 Determines the order in which ":cstag" performs a search. See
2688 |cscopetagorder|.
2689 NOTE: This option is set to 0 when 'compatible' is set.
2690
2691 *'cscopeverbose'* *'csverb'*
2692 *'nocscopeverbose'* *'nocsverb'*
2693'cscopeverbose' 'csverb' boolean (default off)
2694 global
2695 {not available when compiled without the |+cscope|
2696 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 Give messages when adding a cscope database. See |cscopeverbose|.
2698 NOTE: This option is reset when 'compatible' is set.
2699
Bram Moolenaar860cae12010-06-05 23:22:07 +02002700 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2701'cursorbind' 'crb' boolean (default off)
2702 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002703 When this option is set, as the cursor in the current
2704 window moves other cursorbound windows (windows that also have
2705 this option set) move their cursors to the corresponding line and
2706 column. This option is useful for viewing the
2707 differences between two versions of a file (see 'diff'); in diff mode,
2708 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002709 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002710
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002711 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2712'cursorcolumn' 'cuc' boolean (default off)
2713 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002714 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002715 feature}
2716 Highlight the screen column of the cursor with CursorColumn
2717 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2718 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002719 If you only want the highlighting in the current window you can use
2720 these autocommands: >
2721 au WinLeave * set nocursorline nocursorcolumn
2722 au WinEnter * set cursorline cursorcolumn
2723<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002724
2725 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2726'cursorline' 'cul' boolean (default off)
2727 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002728 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002729 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002730 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2731 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002732 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002733 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002734
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002735 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002736'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002737 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002738 {not available when compiled without the |+syntax|
2739 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002740 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002741 Valid values:
2742 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002743 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002744 "screenline" Highlight only the screen line of the cursor with
2745 CursorLine |hl-CursorLine|.
2746 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002747 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002748
2749 Special value:
2750 "both" Alias for the values "line,number".
2751
2752 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002753
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 *'debug'*
2755'debug' string (default "")
2756 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002757 These values can be used:
2758 msg Error messages that would otherwise be omitted will be given
2759 anyway.
2760 throw Error messages that would otherwise be omitted will be given
2761 anyway and also throw an exception and set |v:errmsg|.
2762 beep A message will be given when otherwise only a beep would be
2763 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002764 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002765 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2766 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767
2768 *'define'* *'def'*
2769'define' 'def' string (default "^\s*#\s*define")
2770 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002771 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 pattern, just like for the "/" command. This option is used for the
2773 commands like "[i" and "[d" |include-search|. The 'isident' option is
2774 used to recognize the defined name after the match:
2775 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2776 See |option-backslash| about inserting backslashes to include a space
2777 or backslash.
2778 The default value is for C programs. For C++ this value would be
2779 useful, to include const type declarations: >
2780 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002781< You can also use "\ze" just before the name and continue the pattern
2782 to check what is following. E.g. for Javascript, if a function is
2783 defined with "func_name = function(args)": >
2784 ^\s*\ze\i\+\s*=\s*function(
2785< If the function is defined with "func_name : function() {...": >
2786 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002788 To avoid that use `:let` with a single quote string: >
2789 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002790<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791
2792 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2793'delcombine' 'deco' boolean (default off)
2794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 If editing Unicode and this option is set, backspace and Normal mode
2796 "x" delete each combining character on its own. When it is off (the
2797 default) the character along with its combining characters are
2798 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002799 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800
2801 This is useful for Arabic, Hebrew and many other languages where one
2802 may have combining characters overtop of base characters, and want
2803 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002804 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805
2806 *'dictionary'* *'dict'*
2807'dictionary' 'dict' string (default "")
2808 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 List of file names, separated by commas, that are used to lookup words
2810 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2811 contain a list of words. This can be one word per line, or several
2812 words per line, separated by non-keyword characters (white space is
2813 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002814
2815 When this option is empty or an entry "spell" is present, and spell
2816 checking is enabled, words in the word lists for the currently active
2817 'spelllang' are used. See |spell|.
2818
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002819 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 after a comma are ignored, otherwise spaces are included in the file
2821 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002822 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 Where to find a list of words?
2824 - On FreeBSD, there is the file "/usr/share/dict/words".
2825 - In the Simtel archive, look in the "msdos/linguist" directory.
2826 - In "miscfiles" of the GNU collection.
2827 The use of |:set+=| and |:set-=| is preferred when adding or removing
2828 directories from the list. This avoids problems when a future version
2829 uses another default.
2830 Backticks cannot be used in this option for security reasons.
2831
2832 *'diff'* *'nodiff'*
2833'diff' boolean (default off)
2834 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 {not available when compiled without the |+diff|
2836 feature}
2837 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002838 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839
2840 *'dex'* *'diffexpr'*
2841'diffexpr' 'dex' string (default "")
2842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 {not available when compiled without the |+diff|
2844 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002845 Expression which is evaluated to obtain a diff file (either ed-style
2846 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 This option cannot be set from a |modeline| or in the |sandbox|, for
2848 security reasons.
2849
2850 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002851'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853 {not available when compiled without the |+diff|
2854 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002855 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 All are optional. Items must be separated by a comma.
2857
2858 filler Show filler lines, to keep the text
2859 synchronized with a window that has inserted
2860 lines at the same position. Mostly useful
2861 when windows are side-by-side and 'scrollbind'
2862 is set.
2863
2864 context:{n} Use a context of {n} lines between a change
2865 and a fold that contains unchanged lines.
2866 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002867 When using zero the context is actually one,
2868 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002869 for a deleted line. Set it to a very large
2870 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 See |fold-diff|.
2872
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002873 iblank Ignore changes where lines are all blank. Adds
2874 the "-B" flag to the "diff" command if
2875 'diffexpr' is empty. Check the documentation
2876 of the "diff" command for what this does
2877 exactly.
2878 NOTE: the diff windows will get out of sync,
2879 because no differences between blank lines are
2880 taken into account.
2881
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 icase Ignore changes in case of text. "a" and "A"
2883 are considered the same. Adds the "-i" flag
2884 to the "diff" command if 'diffexpr' is empty.
2885
2886 iwhite Ignore changes in amount of white space. Adds
2887 the "-b" flag to the "diff" command if
2888 'diffexpr' is empty. Check the documentation
2889 of the "diff" command for what this does
2890 exactly. It should ignore adding trailing
2891 white space, but not leading white space.
2892
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002893 iwhiteall Ignore all white space changes. Adds
2894 the "-w" flag to the "diff" command if
2895 'diffexpr' is empty. Check the documentation
2896 of the "diff" command for what this does
2897 exactly.
2898
2899 iwhiteeol Ignore white space changes at end of line.
2900 Adds the "-Z" flag to the "diff" command if
2901 'diffexpr' is empty. Check the documentation
2902 of the "diff" command for what this does
2903 exactly.
2904
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002905 horizontal Start diff mode with horizontal splits (unless
2906 explicitly specified otherwise).
2907
2908 vertical Start diff mode with vertical splits (unless
2909 explicitly specified otherwise).
2910
Bram Moolenaarc8234772019-11-10 21:00:27 +01002911 closeoff When a window is closed where 'diff' is set
2912 and there is only one window remaining in the
2913 same tab page with 'diff' set, execute
2914 `:diffoff` in that window. This undoes a
2915 `:diffsplit` command.
2916
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002917 hiddenoff Do not use diff mode for a buffer when it
2918 becomes hidden.
2919
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002920 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2921 starting diff mode. Without this 2 is used.
2922
Bram Moolenaar4223d432021-02-10 13:18:17 +01002923 followwrap Follow the 'wrap' option and leave as it is.
2924
Bram Moolenaare828b762018-09-10 17:51:58 +02002925 internal Use the internal diff library. This is
2926 ignored when 'diffexpr' is set. *E960*
2927 When running out of memory when writing a
2928 buffer this item will be ignored for diffs
2929 involving that buffer. Set the 'verbose'
2930 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931
Bram Moolenaare828b762018-09-10 17:51:58 +02002932 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002933 Use the indent heuristic for the internal
2934 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002935
zeertzjqd086b8f2024-02-25 15:42:52 +08002936 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002937 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002938 algorithms are:
2939 myers the default algorithm
2940 minimal spend extra time to generate the
2941 smallest possible diff
2942 patience patience diff algorithm
2943 histogram histogram diff algorithm
2944
2945 Examples: >
2946 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002948 :set diffopt=internal,filler,foldcolumn:3
2949 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950<
2951 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2952'digraph' 'dg' boolean (default off)
2953 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 {not available when compiled without the |+digraphs|
2955 feature}
2956 Enable the entering of digraphs in Insert mode with {char1} <BS>
2957 {char2}. See |digraphs|.
2958 NOTE: This option is reset when 'compatible' is set.
2959
2960 *'directory'* *'dir'*
2961'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002962 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 for Unix: ".,~/tmp,/var/tmp,/tmp")
2964 global
2965 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002966 Recommended value: ".,~/vimswap//" - this will put the swap file next
2967 to the edited file if possible, and in your personal swap directory
2968 otherwise. Make sure "~/vimswap//" is only readable for you.
2969
2970 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 - The swap file will be created in the first directory where this is
2972 possible.
2973 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002974 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 - A directory "." means to put the swap file in the same directory as
2976 the edited file. On Unix, a dot is prepended to the file name, so
2977 it doesn't show in a directory listing. On MS-Windows the "hidden"
2978 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002979 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2980 the swap file relative to where the edited file is. The leading "."
2981 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002982 - For Unix and Win32, if a directory ends in two path separators "//",
2983 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002984 with all path separators replaced by percent '%' signs (including
2985 the colon following the drive letter on Win32). This will ensure
2986 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002987 On Win32, it is also possible to end with "\\". However, When a
2988 separating comma is following, you must use "//", since "\\" will
2989 include the comma in the file name. Therefore it is recommended to
2990 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 - Spaces after the comma are ignored, other spaces are considered part
2992 of the directory name. To have a space at the start of a directory
2993 name, precede it with a backslash.
2994 - To include a comma in a directory name precede it with a backslash.
2995 - A directory name may end in an ':' or '/'.
2996 - Environment variables are expanded |:set_env|.
2997 - Careful with '\' characters, type one before a space, type two to
2998 get one in the option (see |option-backslash|), for example: >
2999 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3000< - For backwards compatibility with Vim version 3.0 a '>' at the start
3001 of the option is removed.
3002 Using "." first in the list is recommended. This means that editing
3003 the same file twice will result in a warning. Using "/tmp" on Unix is
3004 discouraged: When the system crashes you lose the swap file.
3005 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003006 choice than "/tmp". But others on the computer may be able to see the
3007 files, and it can contain a lot of files, your swap files get lost in
3008 the crowd. That is why a "tmp" directory in your home directory is
3009 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 The use of |:set+=| and |:set-=| is preferred when adding or removing
3011 directories from the list. This avoids problems when a future version
3012 uses another default.
3013 This option cannot be set from a |modeline| or in the |sandbox|, for
3014 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015
3016 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003017'display' 'dy' string (default "", set to "truncate" in
3018 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003020 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 flags:
3022 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003023 in a window will be displayed. "@@@" is put in the
3024 last columns of the last screen line to indicate the
3025 rest of the line is not displayed.
3026 truncate Like "lastline", but "@@@" is displayed in the first
3027 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 uhex Show unprintable characters hexadecimal as <xx>
3029 instead of using ^C and ~C.
3030
Bram Moolenaard0796902016-09-16 20:02:31 +02003031 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003032 doesn't fit is replaced with "@" lines.
3033
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003034 The "@" character can be changed by setting the "lastline" item in
3035 'fillchars'. The character is highlighted with |hl-NonText|.
3036
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 *'eadirection'* *'ead'*
3038'eadirection' 'ead' string (default "both")
3039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 Tells when the 'equalalways' option applies:
3041 ver vertically, width of windows is not affected
3042 hor horizontally, height of windows is not affected
3043 both width and height of windows is affected
3044
3045 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3046'edcompatible' 'ed' boolean (default off)
3047 global
3048 Makes the 'g' and 'c' flags of the ":substitute" command to be
3049 toggled each time the flag is given. See |complex-change|. See
3050 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003051 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003052 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053
Bram Moolenaar03413f42016-04-12 21:07:15 +02003054 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003055'emoji' 'emo' boolean (default: on)
3056 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003057 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003058 This excludes "text emoji" characters, which are normally displayed as
3059 single width. Unfortunately there is no good specification for this
3060 and it has been determined on trial-and-error basis. Use the
3061 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003062
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003064'encoding' 'enc' string (default for MS-Windows: "utf-8",
3065 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 Sets the character encoding used inside Vim. It applies to text in
3068 the buffers, registers, Strings in expressions, text stored in the
3069 viminfo file, etc. It sets the kind of characters which Vim can work
3070 with. See |encoding-names| for the possible values.
3071
3072 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003073 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003075 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076
Bram Moolenaar865242e2010-07-14 21:12:05 +02003077 This option cannot be set from a |modeline|. It would most likely
3078 corrupt the text.
3079
Bram Moolenaar3df01732017-02-17 22:47:16 +01003080 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3081 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 'encoding', "utf-8" is the natural choice for the environment and
3083 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003084 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 versions, and to avoid changing the encoding of newly created files
3086 without your knowledge (in case 'fileencodings' is empty).
3087
3088 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003089 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 iconv() or as specified with 'charconvert'.
3091
Bram Moolenaar207f0092020-08-30 17:20:20 +02003092 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003093 can use: >
3094 if has("multi_byte_encoding")
3095<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 Normally 'encoding' will be equal to your current locale. This will
3097 be the default if Vim recognizes your environment settings. If
3098 'encoding' is not set to the current locale, 'termencoding' must be
3099 set to convert typed and displayed text. See |encoding-table|.
3100
3101 When you set this option, it fires the |EncodingChanged| autocommand
3102 event so that you can set up fonts if necessary.
3103
3104 When the option is set, the value is converted to lowercase. Thus
3105 you can set it with uppercase values too. Underscores are translated
3106 to '-' signs.
3107 When the encoding is recognized, it is changed to the standard name.
3108 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3109 "iso-8859-2" and "utf8" becomes "utf-8".
3110
3111 Note: "latin1" is also used when the encoding could not be detected.
3112 This only works when editing files in the same encoding! When the
3113 actual character set is not latin1, make sure 'fileencoding' and
3114 'fileencodings' are empty. When conversion is needed, switch to using
3115 utf-8.
3116
3117 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3118 You don't notice this while editing, but it does matter for the
3119 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3120 setting 'encoding' to one of these values instead of utf-8 only has
3121 effect for encoding used for files when 'fileencoding' is empty.
3122
Bram Moolenaar661b1822005-07-28 22:36:45 +00003123 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3124 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003126 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003127'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003129 Indicates that a CTRL-Z character was found at the end of the file
3130 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003132 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003133 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003134 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003135
3136 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3137'endofline' 'eol' boolean (default on)
3138 local to buffer
3139 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003140 is on, or 'fixeol' option is off, no <EOL> will be written for the
3141 last line in the file. This option is automatically set or reset when
3142 starting to edit a new file, depending on whether file has an <EOL>
3143 for the last line in the file. Normally you don't have to set or
3144 reset this option.
3145 When 'binary' is off and 'fixeol' is on the value is not used when
3146 writing the file. When 'binary' is on or 'fixeol' is off it is used
3147 to remember the presence of a <EOL> for the last line in the file, so
3148 that when you write the file the situation from the original file can
3149 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003150 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151
3152 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3153'equalalways' 'ea' boolean (default on)
3154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003156 splitting or closing a window. This also happens the moment the
3157 option is switched on. When off, splitting a window will reduce the
3158 size of the current window and leave the other windows the same. When
3159 closing a window the extra lines are given to the window next to it
3160 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 When mixing vertically and horizontally split windows, a minimal size
3162 is computed and some windows may be larger if there is room. The
3163 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003164 Changing the height and width of a window can be avoided by setting
3165 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003166 If a window size is specified when creating a new window sizes are
3167 currently not equalized (it's complicated, but may be implemented in
3168 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169
3170 *'equalprg'* *'ep'*
3171'equalprg' 'ep' string (default "")
3172 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003174 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003175 or 'indentexpr'. When Vim was compiled without internal formatting,
3176 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003177 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 about including spaces and backslashes.
3179 This option cannot be set from a |modeline| or in the |sandbox|, for
3180 security reasons.
3181
3182 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3183'errorbells' 'eb' boolean (default off)
3184 global
3185 Ring the bell (beep or screen flash) for error messages. This only
3186 makes a difference for error messages, the bell will be used always
3187 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003188 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003189 screen flash or do nothing. See 'belloff' to finetune when to ring the
3190 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191
3192 *'errorfile'* *'ef'*
3193'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3194 others: "errors.err")
3195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 {not available when compiled without the |+quickfix|
3197 feature}
3198 Name of the errorfile for the QuickFix mode (see |:cf|).
3199 When the "-q" command-line argument is used, 'errorfile' is set to the
3200 following argument. See |-q|.
3201 NOT used for the ":make" command. See 'makeef' for that.
3202 Environment variables are expanded |:set_env|.
3203 See |option-backslash| about including spaces and backslashes.
3204 This option cannot be set from a |modeline| or in the |sandbox|, for
3205 security reasons.
3206
3207 *'errorformat'* *'efm'*
3208'errorformat' 'efm' string (default is very long)
3209 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 {not available when compiled without the |+quickfix|
3211 feature}
3212 Scanf-like description of the format for the lines in the error file
3213 (see |errorformat|).
3214
3215 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3216'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 Function keys that start with an <Esc> are recognized in Insert
3219 mode. When this option is off, the cursor and function keys cannot be
3220 used in Insert mode if they start with an <Esc>. The advantage of
3221 this is that the single <Esc> is recognized immediately, instead of
3222 after one second. Instead of resetting this option, you might want to
3223 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3224 when 'esckeys' is off, you can still map anything, but the cursor keys
3225 won't work by default.
3226 NOTE: This option is set to the Vi default value when 'compatible' is
3227 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003228 NOTE: when this option is off then the |modifyOtherKeys| and
3229 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3230 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231
3232 *'eventignore'* *'ei'*
3233'eventignore' 'ei' string (default "")
3234 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003236 When set to "all" or when "all" is one of the items, all autocommand
3237 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003238 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 :set ei=WinEnter,WinLeave
3240<
3241 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3242'expandtab' 'et' boolean (default off)
3243 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003245 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3247 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003248 This option is reset when the 'paste' option is set and restored when
3249 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 NOTE: This option is reset when 'compatible' is set.
3251
3252 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3253'exrc' 'ex' boolean (default off)
3254 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003256 directory.
3257
3258 Setting this option is a potential security leak. E.g., consider
3259 unpacking a package or fetching files from github, a .vimrc in there
3260 might be a trojan horse. BETTER NOT SET THIS OPTION!
3261 Instead, define an autocommand in your .vimrc to set options for a
3262 matching directory.
3263
3264 If you do switch this option on you should also consider setting the
3265 'secure' option (see |initialization|).
3266 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 This option cannot be set from a |modeline| or in the |sandbox|, for
3268 security reasons.
3269
3270 *'fileencoding'* *'fenc'* *E213*
3271'fileencoding' 'fenc' string (default: "")
3272 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003274
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003276 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 When 'fileencoding' is empty, the same value as 'encoding' will be
3278 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003279 No error will be given when the value is set, only when it is used,
3280 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003281 Conversion will also be done when 'encoding' and 'fileencoding' are
3282 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3283 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003285 'encoding' is "utf-8" or another Unicode encoding, conversion
3286 is most likely done in a way that the reverse conversion
3287 results in the same text. When 'encoding' is not "utf-8" some
3288 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003289
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 See 'encoding' for the possible values. Additionally, values may be
3291 specified that can be handled by the converter, see
3292 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003293
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 When reading a file 'fileencoding' will be set from 'fileencodings'.
3295 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003296 'fileencoding', use the |++enc| argument. One exception: when
3297 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003298 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003299
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3301 When the option is set, the value is converted to lowercase. Thus
3302 you can set it with uppercase values too. '_' characters are
3303 replaced with '-'. If a name is recognized from the list for
3304 'encoding', it is replaced by the standard name. For example
3305 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003306
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 When this option is set, after starting to edit a file, the 'modified'
3308 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003309
3310 Keep in mind that changing 'fenc' from a modeline happens
3311 AFTER the text has been read, thus it applies to when the file will be
3312 written. If you do set 'fenc' in a modeline, you might want to set
3313 'nomodified' to avoid not being able to ":q".
3314
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 This option can not be changed when 'modifiable' is off.
3316
3317 *'fe'*
3318 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003319 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 old short name was 'fe', which is no longer used.
3321
3322 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003323'fileencodings' 'fencs' string (default: "ucs-bom",
3324 "ucs-bom,utf-8,default,latin1" when
3325 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 This is a list of character encodings considered when starting to edit
3328 an existing file. When a file is read, Vim tries to use the first
3329 mentioned character encoding. If an error is detected, the next one
3330 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003331 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 an empty string, which means the value of 'encoding' is used.
3333 WARNING: Conversion can cause loss of information! When
3334 'encoding' is "utf-8" (or one of the other Unicode variants)
3335 conversion is most likely done in a way that the reverse
3336 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003337 "utf-8" some non-ASCII characters may be lost! You can use
3338 the |++bad| argument to specify what is done with characters
3339 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 For an empty file or a file with only ASCII characters most encodings
3341 will work and the first entry of 'fileencodings' will be used (except
3342 "ucs-bom", which requires the BOM to be present). If you prefer
3343 another encoding use an BufReadPost autocommand event to test if your
3344 preferred encoding is to be used. Example: >
3345 au BufReadPost * if search('\S', 'w') == 0 |
3346 \ set fenc=iso-2022-jp | endif
3347< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3348 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003349 When the |++enc| argument is used then the value of 'fileencodings' is
3350 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003351 Note that 'fileencodings' is not used for a new file, the global value
3352 of 'fileencoding' is used instead. You can set it with: >
3353 :setglobal fenc=iso-8859-2
3354< This means that a non-existing file may get a different encoding than
3355 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 The special value "ucs-bom" can be used to check for a Unicode BOM
3357 (Byte Order Mark) at the start of the file. It must not be preceded
3358 by "utf-8" or another Unicode encoding for this to work properly.
3359 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3360 because Vim cannot detect an error, thus the encoding is always
3361 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003362 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003363 environment. On MS-Windows this is the system encoding. Otherwise
3364 this is the default value for 'encoding'. It is useful when
3365 'encoding' is set to "utf-8" and your environment uses a non-latin1
3366 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003367 When 'encoding' is "utf-8" and a file contains an illegal byte
3368 sequence it won't be recognized as UTF-8. You can use the |8g8|
3369 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 WRONG VALUES: WHAT'S WRONG:
3371 latin1,utf-8 "latin1" will always be used
3372 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3373 file
3374 cp1250,latin1 "cp1250" will always be used
3375 If 'fileencodings' is empty, 'fileencoding' is not modified.
3376 See 'fileencoding' for the possible values.
3377 Setting this option does not have an effect until the next time a file
3378 is read.
3379
3380 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003381'fileformat' 'ff' string (MS-Windows default: "dos",
3382 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 This gives the <EOL> of the current buffer, which is used for
3385 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003386 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 unix <NL>
3388 mac <CR>
3389 When "dos" is used, CTRL-Z at the end of a file is ignored.
3390 See |file-formats| and |file-read|.
3391 For the character encoding of the file see 'fileencoding'.
3392 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003393 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 This option is set automatically when starting to edit a file and
3395 'fileformats' is not empty and 'binary' is off.
3396 When this option is set, after starting to edit a file, the 'modified'
3397 option is set, because the file would be different when written.
3398 This option can not be changed when 'modifiable' is off.
3399 For backwards compatibility: When this option is set to "dos",
3400 'textmode' is set, otherwise 'textmode' is reset.
3401
3402 *'fileformats'* *'ffs'*
3403'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003404 Vim+Vi MS-Windows: "dos,unix",
3405 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 Vi Cygwin: "unix,dos",
3407 Vi others: "")
3408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 This gives the end-of-line (<EOL>) formats that will be tried when
3410 starting to edit a new buffer and when reading a file into an existing
3411 buffer:
3412 - When empty, the format defined with 'fileformat' will be used
3413 always. It is not set automatically.
3414 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003415 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 'fileformats' name will be used when a file is read into an existing
3417 buffer, no matter what 'fileformat' for that buffer is set to.
3418 - When more than one name is present, separated by commas, automatic
3419 <EOL> detection will be done when reading a file. When starting to
3420 edit a file, a check is done for the <EOL>:
3421 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3422 'fileformat' is set to "dos".
3423 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003424 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003426 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3427 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003428 This means that "mac" is only chosen when:
3429 "unix" is not present or no <NL> is found in the file, and
3430 "dos" is not present or no <CR><NL> is found in the file.
3431 Except: if "unix" was chosen, but there is a <CR> before
3432 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003433 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 4. If 'fileformat' is still not set, the first name from
3435 'fileformats' is used.
3436 When reading a file into an existing buffer, the same is done, but
3437 this happens like 'fileformat' has been set appropriately for that
3438 file only, the option is not changed.
3439 When 'binary' is set, the value of 'fileformats' is not used.
3440
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003441 When Vim starts up with an empty buffer the first item is used. You
3442 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003443
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3445 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3446 done:
3447 - When 'fileformats' is empty, there is no automatic detection. Dos
3448 format will be used.
3449 - When 'fileformats' is set to one or more names, automatic detection
3450 is done. This is based on the first <NL> in the file: If there is a
3451 <CR> in front of it, Dos format is used, otherwise Unix format is
3452 used.
3453 Also see |file-formats|.
3454 For backwards compatibility: When this option is set to an empty
3455 string or one format (no comma is included), 'textauto' is reset,
3456 otherwise 'textauto' is set.
3457 NOTE: This option is set to the Vi default value when 'compatible' is
3458 set and to the Vim default value when 'compatible' is reset.
3459
Bram Moolenaarbf884932013-04-05 22:26:15 +02003460 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3461'fileignorecase' 'fic' boolean (default on for systems where case in file
3462 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003463 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003464 When set case is ignored when using file names and directories.
3465 See 'wildignorecase' for only ignoring case when doing completion.
3466
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 *'filetype'* *'ft'*
3468'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003469 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 When this option is set, the FileType autocommand event is triggered.
3471 All autocommands that match with the value of this option will be
3472 executed. Thus the value of 'filetype' is used in place of the file
3473 name.
3474 Otherwise this option does not always reflect the current file type.
3475 This option is normally set when the file type is detected. To enable
3476 this use the ":filetype on" command. |:filetype|
3477 Setting this option to a different value is most useful in a modeline,
3478 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003479 Example, for in an IDL file:
3480 /* vim: set filetype=idl : */ ~
3481 |FileType| |filetypes|
3482 When a dot appears in the value then this separates two filetype
3483 names. Example:
3484 /* vim: set filetype=c.doxygen : */ ~
3485 This will use the "c" filetype first, then the "doxygen" filetype.
3486 This works both for filetype plugins and for syntax files. More than
3487 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 This option is not copied to another buffer, independent of the 's' or
3489 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003490 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491
3492 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003493'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003494 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003495 Characters to fill the statuslines, vertical separators and special
3496 lines in the window.
3497 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003498 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003500 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003501 stl ' ' statusline of the current window
3502 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003503 vert '|' vertical separators |:vsplit|
3504 fold '-' filling 'foldtext'
3505 foldopen '-' mark the beginning of a fold
3506 foldclose '+' show a closed fold
3507 foldsep '|' open fold middle character
3508 diff '-' deleted lines of the 'diff' option
3509 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003510 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003512 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513
3514 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003515 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3516<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003517 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3518 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003519 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003520
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003522 item name highlight group ~
3523 stl StatusLine |hl-StatusLine|
3524 stlnc StatusLineNC |hl-StatusLineNC|
3525 vert VertSplit |hl-VertSplit|
3526 fold Folded |hl-Folded|
3527 diff DiffDelete |hl-DiffDelete|
3528 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003529 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003531 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3532'fixendofline' 'fixeol' boolean (default on)
3533 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003534 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003535 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003536 preserve the situation from the original file.
3537 When the 'binary' option is set the value of this option doesn't
3538 matter.
3539 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003540 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003541
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003543'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 {only available when compiled with the |+rightleft|
3546 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003547 This option was for using Farsi, which has been removed. See
3548 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549
3550 *'foldclose'* *'fcl'*
3551'foldclose' 'fcl' string (default "")
3552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 {not available when compiled without the |+folding|
3554 feature}
3555 When set to "all", a fold is closed when the cursor isn't in it and
3556 its level is higher than 'foldlevel'. Useful if you want folds to
3557 automatically close when moving out of them.
3558
3559 *'foldcolumn'* *'fdc'*
3560'foldcolumn' 'fdc' number (default 0)
3561 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 {not available when compiled without the |+folding|
3563 feature}
3564 When non-zero, a column with the specified width is shown at the side
3565 of the window which indicates open and closed folds. The maximum
3566 value is 12.
3567 See |folding|.
3568
3569 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3570'foldenable' 'fen' boolean (default on)
3571 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 {not available when compiled without the |+folding|
3573 feature}
3574 When off, all folds are open. This option can be used to quickly
3575 switch between showing all text unfolded and viewing the text with
3576 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003577 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 'foldenable' is off.
3579 This option is set by commands that create a new fold or close a fold.
3580 See |folding|.
3581
3582 *'foldexpr'* *'fde'*
3583'foldexpr' 'fde' string (default: "0")
3584 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003586 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003588 for each line to obtain its fold level. The context is set to the
3589 script where 'foldexpr' was set, script-local items can be accessed.
3590 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003591
Bram Moolenaar30b65812012-07-12 22:01:11 +02003592 The expression will be evaluated in the |sandbox| if set from a
3593 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003594 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003595 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003596
3597 It is not allowed to change text or jump to another window while
3598 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599
3600 *'foldignore'* *'fdi'*
3601'foldignore' 'fdi' string (default: "#")
3602 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 {not available when compiled without the |+folding|
3604 feature}
3605 Used only when 'foldmethod' is "indent". Lines starting with
3606 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003607 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 The default "#" works well for C programs. See |fold-indent|.
3609
3610 *'foldlevel'* *'fdl'*
3611'foldlevel' 'fdl' number (default: 0)
3612 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 {not available when compiled without the |+folding|
3614 feature}
3615 Sets the fold level: Folds with a higher level will be closed.
3616 Setting this option to zero will close all folds. Higher numbers will
3617 close fewer folds.
3618 This option is set by commands like |zm|, |zM| and |zR|.
3619 See |fold-foldlevel|.
3620
3621 *'foldlevelstart'* *'fdls'*
3622'foldlevelstart' 'fdls' number (default: -1)
3623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 {not available when compiled without the |+folding|
3625 feature}
3626 Sets 'foldlevel' when starting to edit another buffer in a window.
3627 Useful to always start editing with all folds closed (value zero),
3628 some folds closed (one) or no folds closed (99).
3629 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003630 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 ignores this option and closes all folds.
3632 It is also done before BufReadPre autocommands, to allow an autocmd to
3633 overrule the 'foldlevel' value for specific files.
3634 When the value is negative, it is not used.
3635
3636 *'foldmarker'* *'fmr'* *E536*
3637'foldmarker' 'fmr' string (default: "{{{,}}}")
3638 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 {not available when compiled without the |+folding|
3640 feature}
3641 The start and end marker used when 'foldmethod' is "marker". There
3642 must be one comma, which separates the start and end marker. The
3643 marker is a literal string (a regular expression would be too slow).
3644 See |fold-marker|.
3645
3646 *'foldmethod'* *'fdm'*
3647'foldmethod' 'fdm' string (default: "manual")
3648 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 {not available when compiled without the |+folding|
3650 feature}
3651 The kind of folding used for the current window. Possible values:
3652 |fold-manual| manual Folds are created manually.
3653 |fold-indent| indent Lines with equal indent form a fold.
3654 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3655 |fold-marker| marker Markers are used to specify folds.
3656 |fold-syntax| syntax Syntax highlighting items specify folds.
3657 |fold-diff| diff Fold text that is not changed.
3658
3659 *'foldminlines'* *'fml'*
3660'foldminlines' 'fml' number (default: 1)
3661 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 {not available when compiled without the |+folding|
3663 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003664 Sets the number of screen lines above which a fold can be displayed
3665 closed. Also for manually closed folds. With the default value of
3666 one a fold can only be closed if it takes up two or more screen lines.
3667 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003668 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 "zc" to close a fold, which is displayed open because it's smaller
3670 than 'foldminlines', a following "zc" may close a containing fold.
3671
3672 *'foldnestmax'* *'fdn'*
3673'foldnestmax' 'fdn' number (default: 20)
3674 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 {not available when compiled without the |+folding|
3676 feature}
3677 Sets the maximum nesting of folds for the "indent" and "syntax"
3678 methods. This avoids that too many folds will be created. Using more
3679 than 20 doesn't work, because the internal limit is 20.
3680
3681 *'foldopen'* *'fdo'*
3682'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3683 search,tag,undo")
3684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 {not available when compiled without the |+folding|
3686 feature}
3687 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003688 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003690 NOTE: When the command is part of a mapping this option is not used.
3691 Add the |zv| command to the mapping to get the same effect.
3692 (rationale: the mapping may want to control opening folds itself)
3693
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 item commands ~
3695 all any
3696 block "(", "{", "[[", "[{", etc.
3697 hor horizontal movements: "l", "w", "fx", etc.
3698 insert any command in Insert mode
3699 jump far jumps: "G", "gg", etc.
3700 mark jumping to a mark: "'m", CTRL-O, etc.
3701 percent "%"
3702 quickfix ":cn", ":crew", ":make", etc.
3703 search search for a pattern: "/", "n", "*", "gd", etc.
3704 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003705 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 tag jumping to a tag: ":ta", CTRL-T, etc.
3707 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 When a movement command is used for an operator (e.g., "dl" or "y%")
3709 this option is not used. This means the operator will include the
3710 whole closed fold.
3711 Note that vertical movements are not here, because it would make it
3712 very difficult to move onto a closed fold.
3713 In insert mode the folds containing the cursor will always be open
3714 when text is inserted.
3715 To close folds you can re-apply 'foldlevel' with the |zx| command or
3716 set the 'foldclose' option to "all".
3717
3718 *'foldtext'* *'fdt'*
3719'foldtext' 'fdt' string (default: "foldtext()")
3720 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 {not available when compiled without the |+folding|
3722 feature}
3723 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003724 fold. The context is set to the script where 'foldexpr' was set,
3725 script-local items can be accessed. See |fold-foldtext| for the
3726 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727
Bram Moolenaar30b65812012-07-12 22:01:11 +02003728 The expression will be evaluated in the |sandbox| if set from a
3729 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003730 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003731
3732 It is not allowed to change text or jump to another window while
3733 evaluating 'foldtext' |textlock|.
3734
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003735 *'formatexpr'* *'fex'*
3736'formatexpr' 'fex' string (default "")
3737 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003738 {not available when compiled without the |+eval|
3739 feature}
3740 Expression which is evaluated to format a range of lines for the |gq|
3741 operator or automatic formatting (see 'formatoptions'). When this
3742 option is empty 'formatprg' is used.
3743
3744 The |v:lnum| variable holds the first line to be formatted.
3745 The |v:count| variable holds the number of lines to be formatted.
3746 The |v:char| variable holds the character that is going to be
3747 inserted if the expression is being evaluated due to
3748 automatic formatting. This can be empty. Don't insert
3749 it yet!
3750
3751 Example: >
3752 :set formatexpr=mylang#Format()
3753< This will invoke the mylang#Format() function in the
3754 autoload/mylang.vim file in 'runtimepath'. |autoload|
3755
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003756 The advantage of using a function call without arguments is that it is
3757 faster, see |expr-option-function|.
3758
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003759 The expression is also evaluated when 'textwidth' is set and adding
3760 text beyond that limit. This happens under the same conditions as
3761 when internal formatting is used. Make sure the cursor is kept in the
3762 same spot relative to the text then! The |mode()| function will
3763 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003764
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003765 When the expression evaluates to non-zero Vim will fall back to using
3766 the internal format mechanism.
3767
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003768 If the expression starts with s: or |<SID>|, then it is replaced with
3769 the script ID (|local-function|). Example: >
3770 set formatexpr=s:MyFormatExpr()
3771 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003772< Otherwise, the expression is evaluated in the context of the script
3773 where the option was set, thus script-local items are available.
3774
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003775 The expression will be evaluated in the |sandbox| when set from a
3776 modeline, see |sandbox-option|. That stops the option from working,
3777 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003778 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003779 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003780
Bram Moolenaar86b68352004-12-27 21:59:20 +00003781 *'formatlistpat'* *'flp'*
3782'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3783 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003784 A pattern that is used to recognize a list header. This is used for
3785 the "n" flag in 'formatoptions'.
3786 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003787 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003788 while still checking more characters. There must be a character
3789 following the pattern, when it matches the whole line it is handled
3790 like there is no match.
3791 The default recognizes a number, followed by an optional punctuation
3792 character and white space.
3793
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003794 *'formatoptions'* *'fo'*
3795'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3796 local to buffer
3797 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003798 formatting is to be done.
3799 See |fo-table| for possible values and |gq| for how to format text.
3800 When the 'paste' option is on, no formatting is done (like
3801 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003802 To avoid problems with flags that are added in the future, use the
3803 "+=" and "-=" feature of ":set" |add-option-flags|.
3804 NOTE: This option is set to the Vi default value when 'compatible' is
3805 set and to the Vim default value when 'compatible' is reset.
3806
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 *'formatprg'* *'fp'*
3808'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003809 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003811 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003813 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003814 If the 'formatexpr' option is not empty it will be used instead.
3815 Otherwise, if 'formatprg' option is an empty string, the internal
3816 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003817 Environment variables are expanded |:set_env|. See |option-backslash|
3818 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003819 This option cannot be set from a |modeline| or in the |sandbox|, for
3820 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821
Bram Moolenaard94464e2015-11-02 15:28:18 +01003822 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003823'fsync' 'fs' boolean (default on)
3824 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003825 When on, the library function fsync() will be called after writing a
3826 file. This will flush a file to disk, ensuring that it is safely
3827 written even on filesystems which do metadata-only journaling. This
3828 will force the harddrive to spin up on Linux systems running in laptop
3829 mode, so it may be undesirable in some situations. Be warned that
3830 turning this off increases the chances of data loss after a crash. On
3831 systems without an fsync() implementation, this variable is always
3832 off.
3833 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003834 'fsync' also applies to |writefile()| (unless a flag is used to
3835 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003836 This option cannot be set from a |modeline| or in the |sandbox|, for
3837 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003838
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3840'gdefault' 'gd' boolean (default off)
3841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 When on, the ":substitute" flag 'g' is default on. This means that
3843 all matches in a line are substituted instead of one. When a 'g' flag
3844 is given to a ":substitute" command, this will toggle the substitution
3845 of all or one match. See |complex-change|.
3846
3847 command 'gdefault' on 'gdefault' off ~
3848 :s/// subst. all subst. one
3849 :s///g subst. one subst. all
3850 :s///gg subst. all subst. one
3851
3852 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003853 Setting this option may break plugins that rely on the default
3854 behavior of the 'g' flag. This will also make the 'g' flag have the
3855 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003856 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857
3858 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003859'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 Format to recognize for the ":grep" command output.
3862 This is a scanf-like string that uses the same format as the
3863 'errorformat' option: see |errorformat|.
3864
3865 *'grepprg'* *'gp'*
3866'grepprg' 'gp' string (default "grep -n ",
3867 Unix: "grep -n $* /dev/null",
3868 Win32: "findstr /n" or "grep -n",
3869 VMS: "SEARCH/NUMBERS ")
3870 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003871 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 and '#' characters, which are expanded like when used in a command-
3873 line. The placeholder "$*" is allowed to specify where the arguments
3874 will be included. Environment variables are expanded |:set_env|. See
3875 |option-backslash| about including spaces and backslashes.
3876 When your "grep" accepts the "-H" argument, use this to make ":grep"
3877 also work well with a single file: >
3878 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003879< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003880 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3881 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003882 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 apply equally to 'grepprg'.
3884 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3885 otherwise it's "grep -n".
3886 This option cannot be set from a |modeline| or in the |sandbox|, for
3887 security reasons.
3888
3889 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3890'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3891 ve:ver35-Cursor,
3892 o:hor50-Cursor,
3893 i-ci:ver25-Cursor/lCursor,
3894 r-cr:hor20-Cursor/lCursor,
3895 sm:block-Cursor
3896 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003897 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 "n-v-c:block,o:hor50,i-ci:hor15,
3899 r-cr:hor30,sm:block")
3900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003902 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003904 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003905 height of the cursor can be changed. This can be done by specifying a
3906 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003907 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3908 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003910 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 mode-list and an argument-list:
3912 mode-list:argument-list,mode-list:argument-list,..
3913 The mode-list is a dash separated list of these modes:
3914 n Normal mode
3915 v Visual mode
3916 ve Visual mode with 'selection' "exclusive" (same as 'v',
3917 if not specified)
3918 o Operator-pending mode
3919 i Insert mode
3920 r Replace mode
3921 c Command-line Normal (append) mode
3922 ci Command-line Insert mode
3923 cr Command-line Replace mode
3924 sm showmatch in Insert mode
3925 a all modes
3926 The argument-list is a dash separated list of these arguments:
3927 hor{N} horizontal bar, {N} percent of the character height
3928 ver{N} vertical bar, {N} percent of the character width
3929 block block cursor, fills the whole character
3930 [only one of the above three should be present]
3931 blinkwait{N} *cursor-blinking*
3932 blinkon{N}
3933 blinkoff{N}
3934 blink times for cursor: blinkwait is the delay before
3935 the cursor starts blinking, blinkon is the time that
3936 the cursor is shown and blinkoff is the time that the
3937 cursor is not shown. The times are in msec. When one
3938 of the numbers is zero, there is no blinking. The
3939 default is: "blinkwait700-blinkon400-blinkoff250".
3940 These numbers are used for a missing entry. This
3941 means that blinking is enabled by default. To switch
3942 blinking off you can use "blinkon0". The cursor only
3943 blinks when Vim is waiting for input, not while
3944 executing a command.
3945 To make the cursor blink in an xterm, see
3946 |xterm-blink|.
3947 {group-name}
3948 a highlight group name, that sets the color and font
3949 for the cursor
3950 {group-name}/{group-name}
3951 Two highlight group names, the first is used when
3952 no language mappings are used, the other when they
3953 are. |language-mapping|
3954
3955 Examples of parts:
3956 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3957 block cursor with colors from the "nCursor"
3958 highlight group
3959 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3960 In Insert and Command-line Insert mode, use a
3961 30% vertical bar cursor with colors from the
3962 "iCursor" highlight group. Blink a bit
3963 faster.
3964
3965 The 'a' mode is different. It will set the given argument-list for
3966 all modes. It does not reset anything to defaults. This can be used
3967 to do a common setting for all modes. For example, to switch off
3968 blinking: "a:blinkon0"
3969
3970 Examples of cursor highlighting: >
3971 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3972 :highlight Cursor gui=NONE guifg=bg guibg=fg
3973<
3974 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003975 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976'guifont' 'gfn' string (default "")
3977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 {only available when compiled with GUI enabled}
3979 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003980 In its simplest form the value is just one font name.
3981 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982
3983 *'guifontset'* *'gfs'*
3984 *E250* *E252* *E234* *E597* *E598*
3985'guifontset' 'gfs' string (default "")
3986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 {only available when compiled with GUI enabled and
3988 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003989 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 When not empty, specifies two (or more) fonts to be used. The first
3991 one for normal English, the second one for your special language. See
3992 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003993
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3995'guifontwide' 'gfw' string (default "")
3996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 {only available when compiled with GUI enabled}
3998 When not empty, specifies a comma-separated list of fonts to be used
3999 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004000 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004001
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 *'guiheadroom'* *'ghr'*
4003'guiheadroom' 'ghr' number (default 50)
4004 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004005 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 The number of pixels subtracted from the screen height when fitting
4007 the GUI window on the screen. Set this before the GUI is started,
4008 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004009 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 lines will be left for window decorations and other items on the
4011 screen. Set it to a negative value to allow windows taller than the
4012 screen.
4013
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004014 *'guiligatures'* *'gli'* *E1243*
4015'guiligatures' 'gli' string (default "")
4016 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004017 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004018 List of ASCII characters that, when combined together, can create more
4019 complex shapes. Each character must be a printable ASCII character
4020 with a value in the 32-127 range.
4021 Example: >
4022 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4023< Changing this option updates screen output immediately. Set it to an
4024 empty string to disable ligatures.
4025
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004027'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4028 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004029 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004030 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004033 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 sequence of letters which describes what components and options of the
4035 GUI should be used.
4036 To avoid problems with flags that are added in the future, use the
4037 "+=" and "-=" feature of ":set" |add-option-flags|.
4038
Bram Moolenaar13568252018-03-16 20:46:58 +01004039 Valid characters are as follows:
4040 *'go-!'*
4041 '!' External commands are executed in a terminal window. Without
4042 this flag the MS-Windows GUI will open a console window to
4043 execute the command. The Unix GUI will simulate a dumb
4044 terminal to list the command output.
4045 The terminal window will be positioned at the bottom, and grow
4046 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004047 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 'a' Autoselect: If present, then whenever VISUAL mode is started,
4049 or the Visual area extended, Vim tries to become the owner of
4050 the windowing system's global selection. This means that the
4051 Visually highlighted text is available for pasting into other
4052 applications as well as into Vim itself. When the Visual mode
4053 ends, possibly due to an operation on the text, or when an
4054 application wants to paste the selection, the highlighted text
4055 is automatically yanked into the "* selection register.
4056 Thus the selection is still available for pasting into other
4057 applications after the VISUAL mode has ended.
4058 If not present, then Vim won't become the owner of the
4059 windowing system's global selection unless explicitly told to
4060 by a yank or delete operation for the "* register.
4061 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004062 *'go-P'*
4063 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004064 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004065 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004066 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 applies to the modeless selection.
4068
4069 'guioptions' autoselect Visual autoselect modeless ~
4070 "" - -
4071 "a" yes yes
4072 "A" - yes
4073 "aA" yes yes
4074
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004075 When using a terminal see the 'clipboard' option.
4076
Bram Moolenaar02467872007-05-06 13:22:01 +00004077 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 'c' Use console dialogs instead of popup dialogs for simple
4079 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004080 *'go-d'*
4081 'd' Use dark theme variant if available. Currently only works for
4082 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004083 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004084 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004085 'guitablabel' can be used to change the text in the labels.
4086 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004087 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004088 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004089 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 'f' Foreground: Don't use fork() to detach the GUI from the shell
4091 where it was started. Use this for programs that wait for the
4092 editor to finish (e.g., an e-mail program). Alternatively you
4093 can use "gvim -f" or ":gui -f" to start the GUI in the
4094 foreground. |gui-fork|
4095 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004096 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004097 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4099 corner of the window. It's black&white on non-GTK, because of
4100 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004101 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004103 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004104 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004106 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004108 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004109 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 'g' Grey menu items: Make menu items that are not active grey. If
4111 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004112 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 't' Include tearoff menu items. Currently only works for Win32,
4114 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004115 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004116 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4117 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004118 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004120 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 'R' Right-hand scrollbar is present when there is a vertically
4122 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004123 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004125 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 'L' Left-hand scrollbar is present when there is a vertically
4127 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004128 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4130 the longest visible line, or on the cursor line if the 'h'
4131 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004132 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 'h' Limit horizontal scrollbar size to the length of the cursor
4134 line. Reduces computations. |gui-horiz-scroll|
4135
4136 And yes, you may even have scrollbars on the left AND the right if
4137 you really want to :-). See |gui-scrollbars| for more information.
4138
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004139 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 'v' Use a vertical button layout for dialogs. When not included,
4141 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004142 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004143 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 'p' Use Pointer callbacks for X11 GUI. This is required for some
4145 window managers. If the cursor is not blinking or hollow at
4146 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004147 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004149 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004150 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004151 *'go-k'*
4152 'k' Keep the GUI window size when adding/removing a scrollbar, or
4153 toolbar, tabline, etc. Instead, the behavior is similar to
4154 when the window is maximized and will adjust 'lines' and
4155 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004156 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004157 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004158
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 *'guipty'* *'noguipty'*
4160'guipty' boolean (default on)
4161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 {only available when compiled with GUI enabled}
4163 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4164 I/O to/from shell commands. See |gui-pty|.
4165
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004166 *'guitablabel'* *'gtl'*
4167'guitablabel' 'gtl' string (default empty)
4168 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004169 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004170 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004171 pages line. When empty and when the result is empty Vim will use a
4172 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004173
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004174 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004175 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004176 The expression will be evaluated in the |sandbox| when set from a
4177 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004178 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004179
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004180 Only used when the GUI tab pages line is displayed. 'e' must be
4181 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4182 used.
4183
Bram Moolenaar57657d82006-04-21 22:12:41 +00004184 *'guitabtooltip'* *'gtt'*
4185'guitabtooltip' 'gtt' string (default empty)
4186 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004187 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004188 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004189 pages line. When empty Vim will use a default tooltip.
4190 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004191 You can include a line break. Simplest method is to use |:let|: >
4192 :let &guitabtooltip = "line one\nline two"
4193<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004194
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004196'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 (others) "$VIMRUNTIME/doc/help.txt")
4198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 Name of the main help file. All distributed help files should be
4200 placed together in one directory. Additionally, all "doc" directories
4201 in 'runtimepath' will be used.
4202 Environment variables are expanded |:set_env|. For example:
4203 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004204 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 spaces and backslashes.
4206 This option cannot be set from a |modeline| or in the |sandbox|, for
4207 security reasons.
4208
4209 *'helpheight'* *'hh'*
4210'helpheight' 'hh' number (default 20)
4211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 Minimal initial height of the help window when it is opened with the
4213 ":help" command. The initial height of the help window is half of the
4214 current window, or (when the 'ea' option is on) the same as other
4215 windows. When the height is less than 'helpheight', the height is
4216 set to 'helpheight'. Set to zero to disable.
4217
4218 *'helplang'* *'hlg'*
4219'helplang' 'hlg' string (default: messages language or empty)
4220 global
4221 {only available when compiled with the |+multi_lang|
4222 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004223 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 for which the desired help can be found. The English help will always
4225 be used as a last resort. You can add "en" to prefer English over
4226 another language, but that will only find tags that exist in that
4227 language and not in the English help.
4228 Example: >
4229 :set helplang=de,it
4230< This will first search German, then Italian and finally English help
4231 files.
4232 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4233 try to find the tag in the current language before using this option.
4234 See |help-translated|.
4235
4236 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4237'hidden' 'hid' boolean (default off)
4238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 When off a buffer is unloaded when it is |abandon|ed. When on a
4240 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4241 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004242
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004244 hidden even if the 'hidden' option is off when these three are true:
4245 - the buffer is modified
4246 - 'autowrite' is off or writing is not possible
4247 - the '!' flag was used
4248 Also see |windows.txt|.
4249
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004250 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 This option is set for one command with ":hide {command}" |:hide|.
4252 WARNING: It's easy to forget that you have changes in hidden buffers.
4253 Think twice when using ":q!" or ":qa!".
4254
4255 *'highlight'* *'hl'*
4256'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004257 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4258 d:Directory,e:ErrorMsg,i:IncSearch,
4259 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004260 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004261 N:CursorLineNr,r:Question,s:StatusLine,
4262 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004263 v:Visual,V:VisualNOS,w:WarningMsg,
4264 W:WildMenu,f:Folded,F:FoldColumn,
4265 A:DiffAdd,C:DiffChange,D:DiffDelete,
4266 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004267 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004268 L:SpellLocal,+:Pmenu,=:PmenuSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004269 [:PmenuKind,]:PmenuKindSel,
4270 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004271 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4272 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004273 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004274 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004277 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004279 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004281 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4282 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 characters from 'showbreak'
4284 |hl-Directory| d directories in CTRL-D listing and other special
4285 things in listings
4286 |hl-ErrorMsg| e error messages
4287 h (obsolete, ignored)
4288 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004289 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4291 |hl-MoreMsg| m |more-prompt|
4292 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004293 |hl-LineNr| n line number for ":number" and ":#" commands, and
4294 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004295 |hl-LineNrAbove| a line number above the cursor for when the
4296 'relativenumber' option is set.
4297 |hl-LineNrBelow| b line number below the cursor for when the
4298 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004299 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4300 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 |hl-Question| r |hit-enter| prompt and yes/no questions
4302 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004303 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4305 |hl-VertSplit| c column used to separate vertically split windows
4306 |hl-Visual| v Visual mode
4307 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4308 Selection" Only X11 Gui's |gui-x11| and
4309 |xterm-clipboard|.
4310 |hl-WarningMsg| w warning messages
4311 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4312 |hl-Folded| f line used for closed folds
4313 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004314 |hl-DiffAdd| A added line in diff mode
4315 |hl-DiffChange| C changed line in diff mode
4316 |hl-DiffDelete| D deleted line in diff mode
4317 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004319 |hl-Conceal| - the placeholders used for concealed characters
4320 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004321 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004322 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004323 |hl-SpellRare| R rare word |spell|
4324 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004325 |hl-Pmenu| + popup menu normal line
4326 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004327 |hl-PmenuKind| [ popup menu "kind" normal line
4328 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004329 |hl-PmenuExtra| { popup menu "extra" normal line
4330 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004331 |hl-PmenuSbar| x popup menu scrollbar
4332 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333
4334 The display modes are:
4335 r reverse (termcap entry "mr" and "me")
4336 i italic (termcap entry "ZH" and "ZR")
4337 b bold (termcap entry "md" and "me")
4338 s standout (termcap entry "so" and "se")
4339 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004340 c undercurl (termcap entry "Us" and "Ce")
4341 2 double underline (termcap entry "Ds" and "Ce")
4342 d dotted underline (termcap entry "ds" and "Ce")
4343 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004344 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 n no highlighting
4346 - no highlighting
4347 : use a highlight group
4348 The default is used for occasions that are not included.
4349 If you want to change what the display modes do, see |dos-colors|
4350 for an example.
4351 When using the ':' display mode, this must be followed by the name of
4352 a highlight group. A highlight group can be used to define any type
4353 of highlighting, including using color. See |:highlight| on how to
4354 define one. The default uses a different group for each occasion.
4355 See |highlight-default| for the default highlight groups.
4356
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004358'history' 'hi' number (Vim default: 50, Vi default: 0,
4359 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004362 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004364 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 NOTE: This option is set to the Vi default value when 'compatible' is
4366 set and to the Vim default value when 'compatible' is reset.
4367
4368 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4369'hkmap' 'hk' boolean (default off)
4370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 {only available when compiled with the |+rightleft|
4372 feature}
4373 When on, the keyboard is mapped for the Hebrew character set.
4374 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4375 toggle this option. See |rileft.txt|.
4376 NOTE: This option is reset when 'compatible' is set.
4377
4378 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4379'hkmapp' 'hkp' boolean (default off)
4380 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 {only available when compiled with the |+rightleft|
4382 feature}
4383 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4384 This is useful if you have a non-Hebrew keyboard.
4385 See |rileft.txt|.
4386 NOTE: This option is reset when 'compatible' is set.
4387
Bram Moolenaar036986f2017-03-16 17:41:02 +01004388 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4389'hlsearch' 'hls' boolean (default off)
4390 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004391 {not available when compiled without the
4392 |+extra_search| feature}
4393 When there is a previous search pattern, highlight all its matches.
4394 The type of highlighting used can be set with the 'l' occasion in the
4395 'highlight' option. This uses the "Search" highlight group by
4396 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004397 are not applied. If the "CurSearch" highlight group is set then the
4398 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004399 See also: 'incsearch' and |:match|.
4400 When you get bored looking at the highlighted matches, you can turn it
4401 off with |:nohlsearch|. This does not change the option value, as
4402 soon as you use a search command, the highlighting comes back.
4403 'redrawtime' specifies the maximum time spent on finding matches.
4404 When the search pattern can match an end-of-line, Vim will try to
4405 highlight all of the matched text. However, this depends on where the
4406 search starts. This will be the first line in the window or the first
4407 line below a closed fold. A match in a previous line which is not
4408 drawn may not continue in a newly drawn line.
4409 You can specify whether the highlight status is restored on startup
4410 with the 'h' flag in 'viminfo' |viminfo-h|.
4411 NOTE: This option is reset when 'compatible' is set.
4412
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 *'icon'* *'noicon'*
4414'icon' boolean (default off, on when title can be restored)
4415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 When on, the icon text of the window will be set to the value of
4417 'iconstring' (if it is not empty), or to the name of the file
4418 currently being edited. Only the last part of the name is used.
4419 Overridden by the 'iconstring' option.
4420 Only works if the terminal supports setting window icons (currently
4421 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4422 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4423 builtin termcap).
4424 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004425 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004427 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428
4429 *'iconstring'*
4430'iconstring' string (default "")
4431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 When this option is not empty, it will be used for the icon text of
4433 the window. This happens only when the 'icon' option is on.
4434 Only works if the terminal supports setting window icon text
4435 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004436 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 When Vim was compiled with HAVE_X11 defined, the original icon will be
4438 restored if possible |X11|.
4439 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004440 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004442 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 {not available when compiled without the |+statusline| feature}
4444
4445 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4446'ignorecase' 'ic' boolean (default off)
4447 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004448 Ignore case in search patterns, |cmdline-completion|, when
4449 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004450 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 Can be overruled by using "\c" or "\C" in the pattern, see
4452 |/ignorecase|.
4453
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004454 *'imactivatefunc'* *'imaf'*
4455'imactivatefunc' 'imaf' string (default "")
4456 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004457 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004458 activate or deactivate the Input Method. The value can be the name of
4459 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4460 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004461 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004462 The expression will be evaluated in the |sandbox| when set from a
4463 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004464
4465 Example: >
4466 function ImActivateFunc(active)
4467 if a:active
4468 ... do something
4469 else
4470 ... do something
4471 endif
4472 " return value is not used
4473 endfunction
4474 set imactivatefunc=ImActivateFunc
4475<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 *'imactivatekey'* *'imak'*
4477'imactivatekey' 'imak' string (default "")
4478 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004480 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 Specifies the key that your Input Method in X-Windows uses for
4482 activation. When this is specified correctly, vim can fully control
4483 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4484 You can't use this option to change the activation key, the option
4485 tells Vim what the key is.
4486 Format:
4487 [MODIFIER_FLAG-]KEY_STRING
4488
4489 These characters can be used for MODIFIER_FLAG (case is ignored):
4490 S Shift key
4491 L Lock key
4492 C Control key
4493 1 Mod1 key
4494 2 Mod2 key
4495 3 Mod3 key
4496 4 Mod4 key
4497 5 Mod5 key
4498 Combinations are allowed, for example "S-C-space" or "SC-space" are
4499 both shift+ctrl+space.
4500 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4501
4502 Example: >
4503 :set imactivatekey=S-space
4504< "S-space" means shift+space. This is the activation key for kinput2 +
4505 canna (Japanese), and ami (Korean).
4506
4507 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4508'imcmdline' 'imc' boolean (default off)
4509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 When set the Input Method is always on when starting to edit a command
4511 line, unless entering a search pattern (see 'imsearch' for that).
4512 Setting this option is useful when your input method allows entering
4513 English characters directly, e.g., when it's used to type accented
4514 characters with dead keys.
4515
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004516 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 When set the Input Method is never used. This is useful to disable
4520 the IM when it doesn't work properly.
4521 Currently this option is on by default for SGI/IRIX machines. This
4522 may change in later releases.
4523
4524 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004525'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 Specifies whether :lmap or an Input Method (IM) is to be used in
4528 Insert mode. Valid values:
4529 0 :lmap is off and IM is off
4530 1 :lmap is ON and IM is off
4531 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 To always reset the option to zero when leaving Insert mode with <Esc>
4533 this can be used: >
4534 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4535< This makes :lmap and IM turn off automatically when leaving Insert
4536 mode.
4537 Note that this option changes when using CTRL-^ in Insert mode
4538 |i_CTRL-^|.
4539 The value is set to 1 when setting 'keymap' to a valid keymap name.
4540 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004541 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 methods. Use 'imdisable' to disable XIM then.
4543
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004544 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004545 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004546 |+multi_byte_ime| or |global-ime|.
4547
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004549'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 Specifies whether :lmap or an Input Method (IM) is to be used when
4552 entering a search pattern. Valid values:
4553 -1 the value of 'iminsert' is used, makes it look like
4554 'iminsert' is also used when typing a search pattern
4555 0 :lmap is off and IM is off
4556 1 :lmap is ON and IM is off
4557 2 :lmap is off and IM is ON
4558 Note that this option changes when using CTRL-^ in Command-line mode
4559 |c_CTRL-^|.
4560 The value is set to 1 when it is not -1 and setting the 'keymap'
4561 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004562 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563 methods. Use 'imdisable' to disable XIM then.
4564
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004565 *'imstatusfunc'* *'imsf'*
4566'imstatusfunc' 'imsf' string (default "")
4567 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004568 This option specifies a function that is called to obtain the status
4569 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004570 The value can be the name of a function, a |lambda| or a |Funcref|.
4571 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004572 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004573
4574 Example: >
4575 function ImStatusFunc()
4576 let is_active = ...do something
4577 return is_active ? 1 : 0
4578 endfunction
4579 set imstatusfunc=ImStatusFunc
4580<
4581 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004582 The expression will be evaluated in the |sandbox| when set from a
4583 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004584
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004585 *'imstyle'* *'imst'*
4586'imstyle' 'imst' number (default 1)
4587 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004588 {only available when compiled with |+xim| and
4589 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004590 This option specifies the input style of Input Method:
4591 0 use on-the-spot style
4592 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004593 See: |xim-input-style|
4594
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004595 For a long time on-the-spot style had been used in the GTK version of
4596 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004597 |single-repeat|, etc. Therefore over-the-spot style becomes the
4598 default now. This should work fine for most people, however if you
4599 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004600 The expression will be evaluated in the |sandbox| when set from a
4601 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004602
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 *'include'* *'inc'*
4604'include' 'inc' string (default "^\s*#\s*include")
4605 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 {not available when compiled without the
4607 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004608 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 pattern, just like for the "/" command (See |pattern|). The default
4610 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004611 "]I", "[d", etc.
4612 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004613 comes after the matched pattern. But if "\zs" appears in the pattern
4614 then the text matched from "\zs" to the end, or until "\ze" if it
4615 appears, is used as the file name. Use this to include characters
4616 that are not in 'isfname', such as a space. You can then use
4617 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004618 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619
4620 *'includeexpr'* *'inex'*
4621'includeexpr' 'inex' string (default "")
4622 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004624 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004626 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004627 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004629 Note the double backslash: the `:set` command first halves them, then
4630 one remains it the value, where "\." matches a dot literally. For
4631 simple character replacements `tr()` avoids the need for escaping: >
4632 :setlocal includeexpr=tr(v:fname,'.','/')
4633<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004635 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 Also used for |<cfile>|.
4637
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004638 If the expression starts with s: or |<SID>|, then it is replaced with
4639 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004640 setlocal includeexpr=s:MyIncludeExpr()
4641 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004642< Otherwise, the expression is evaluated in the context of the script
4643 where the option was set, thus script-local items are available.
4644
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004645 It is more efficient if the value is just a function call without
4646 arguments, see |expr-option-function|.
4647
Bram Moolenaar30b65812012-07-12 22:01:11 +02004648 The expression will be evaluated in the |sandbox| when set from a
4649 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004650 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004651
4652 It is not allowed to change text or jump to another window while
4653 evaluating 'includeexpr' |textlock|.
4654
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004656'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004657 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004660 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004661 While typing a search command, show where the pattern, as it was typed
4662 so far, matches. The matched string is highlighted. If the pattern
4663 is invalid or not found, nothing is shown. The screen will be updated
4664 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004665 Also applies to the pattern in commands: >
4666 :global
4667 :lvimgrep
4668 :lvimgrepadd
4669 :smagic
4670 :snomagic
4671 :sort
4672 :substitute
4673 :vglobal
4674 :vimgrep
4675 :vimgrepadd
4676< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004677 original position when no match is found and when pressing <Esc>. You
4678 still need to finish the search command with <Enter> to move the
4679 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004680 You can use the CTRL-G and CTRL-T keys to move to the next and
4681 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004682 When compiled with the |+reltime| feature Vim only searches for about
4683 half a second. With a complicated pattern and/or a lot of text the
4684 match may not be found. This is to avoid that Vim hangs while you
4685 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004686 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004687 When 'hlsearch' is on, all matched strings are highlighted too while
4688 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004689 If you don't want to turn 'hlsearch' on, but want to highlight all
4690 matches while searching, you can turn on and off 'hlsearch' with
4691 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004692 augroup vimrc-incsearch-highlight
4693 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004694 autocmd CmdlineEnter /,\? :set hlsearch
4695 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004696 augroup END
4697<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004698 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004699 to the command line. If 'ignorecase' and 'smartcase' are set and the
4700 command line has no uppercase characters, the added character is
4701 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004702 CTRL-R CTRL-W can be used to add the word at the end of the current
4703 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 NOTE: This option is reset when 'compatible' is set.
4705
4706 *'indentexpr'* *'inde'*
4707'indentexpr' 'inde' string (default "")
4708 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004709 {not available when compiled without the |+eval|
4710 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 Expression which is evaluated to obtain the proper indent for a line.
4712 It is used when a new line is created, for the |=| operator and
4713 in Insert mode as specified with the 'indentkeys' option.
4714 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004715 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004716 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 When 'paste' is set this option is not used for indenting.
4718 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004719 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004721
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004722 If the expression starts with s: or |<SID>|, then it is replaced with
4723 the script ID (|local-function|). Example: >
4724 set indentexpr=s:MyIndentExpr()
4725 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004726< Otherwise, the expression is evaluated in the context of the script
4727 where the option was set, thus script-local items are available.
4728
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004729 The advantage of using a function call without arguments is that it is
4730 faster, see |expr-option-function|.
4731
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 The expression must return the number of spaces worth of indent. It
4733 can return "-1" to keep the current indent (this means 'autoindent' is
4734 used for the indent).
4735 Functions useful for computing the indent are |indent()|, |cindent()|
4736 and |lispindent()|.
4737 The evaluation of the expression must not have side effects! It must
4738 not change the text, jump to another window, etc. Afterwards the
4739 cursor position is always restored, thus the cursor may be moved.
4740 Normally this option would be set to call a function: >
4741 :set indentexpr=GetMyIndent()
4742< Error messages will be suppressed, unless the 'debug' option contains
4743 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004744 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004745 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746
Bram Moolenaar30b65812012-07-12 22:01:11 +02004747 The expression will be evaluated in the |sandbox| when set from a
4748 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004749 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004750
4751 It is not allowed to change text or jump to another window while
4752 evaluating 'indentexpr' |textlock|.
4753
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004755'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 A list of keys that, when typed in Insert mode, cause reindenting of
4758 the current line. Only happens if 'indentexpr' isn't empty.
4759 The format is identical to 'cinkeys', see |indentkeys-format|.
4760 See |C-indenting| and |indent-expression|.
4761
4762 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4763'infercase' 'inf' boolean (default off)
4764 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004766 'ignorecase' is also on, the case of the match is adjusted depending
4767 on the typed text. If the typed text contains a lowercase letter
4768 where the match has an upper case letter, the completed part is made
4769 lowercase. If the typed text has no lowercase letters and the match
4770 has a lowercase letter where the typed text has an uppercase letter,
4771 and there is a letter before it, the completed part is made uppercase.
4772 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773
4774 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4775'insertmode' 'im' boolean (default off)
4776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 Makes Vim work in a way that Insert mode is the default mode. Useful
4778 if you want to use Vim as a modeless editor. Used for |evim|.
4779 These Insert mode commands will be useful:
4780 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004781 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 this is a mapping, it is executed as if 'insertmode' was off.
4783 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004785 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4786 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787
4788 These items change when 'insertmode' is set:
4789 - when starting to edit of a file, Vim goes to Insert mode.
4790 - <Esc> in Insert mode is a no-op and beeps.
4791 - <Esc> in Normal mode makes Vim go to Insert mode.
4792 - CTRL-L in Insert mode is a command, it is not inserted.
4793 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4794 However, when <Esc> is used inside a mapping, it behaves like
4795 'insertmode' was not set. This was done to be able to use the same
4796 mappings with 'insertmode' set or not set.
4797 When executing commands with |:normal| 'insertmode' is not used.
4798
4799 NOTE: This option is reset when 'compatible' is set.
4800
4801 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004802'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4804 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4805 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4806 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4807 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 The characters specified by this option are included in file names and
4810 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004811 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 Multi-byte characters 256 and above are always included, only the
4813 characters up to 255 are specified with this option.
4814 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004815 Think twice before adding white space to this option. Although a
4816 space may appear inside a file name, the effect will be that Vim
4817 doesn't know where a file name starts or ends when doing completion.
4818 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819
4820 Note that on systems using a backslash as path separator, Vim tries to
4821 do its best to make it work as you would expect. That is a bit
4822 tricky, since Vi originally used the backslash to escape special
4823 characters. Vim will not remove a backslash in front of a normal file
4824 name character on these systems, but it will on Unix and alikes. The
4825 '&' and '^' are not included by default, because these are special for
4826 cmd.exe.
4827
4828 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004829 Each part can be a single character number or a range. A range is two
4830 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 decimal number between 0 and 255 or the ASCII character itself (does
4832 not work for digits). Example:
4833 "_,-,128-140,#-43" (include '_' and '-' and the range
4834 128 to 140 and '#' to 43)
4835 If a part starts with '^', the following character number or range
4836 will be excluded from the option. The option is interpreted from left
4837 to right. Put the excluded character after the range where it is
4838 included. To include '^' itself use it as the last character of the
4839 option or the end of a range. Example:
4840 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4841 If the character is '@', all characters where isalpha() returns TRUE
4842 are included. Normally these are the characters a to z and A to Z,
4843 plus accented characters. To include '@' itself use "@-@". Examples:
4844 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004845 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 "a-z,A-Z,@-@" All letters plus the '@' character.
4847 A comma can be included by using it where a character number is
4848 expected. Example:
4849 "48-57,,,_" Digits, comma and underscore.
4850 A comma can be excluded by prepending a '^'. Example:
4851 " -~,^,,9" All characters from space to '~', excluding
4852 comma, plus <Tab>.
4853 See |option-backslash| about including spaces and backslashes.
4854
4855 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004856'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 "@,48-57,_,128-167,224-235"
4858 otherwise: "@,48-57,_,192-255")
4859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 The characters given by this option are included in identifiers.
4861 Identifiers are used in recognizing environment variables and after a
4862 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004863 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004864 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004866 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4868
4869 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004870'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 "@,48-57,_,128-167,224-235"
4872 otherwise: "@,48-57,_,192-255"
4873 Vi default: "@,48-57,_")
4874 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004876 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004877 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004878 characters above 255 check the "word" character class (any character
4879 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004880 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 For a help file it is set to all non-blank printable characters except
4882 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4883 command).
4884 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004885 This option also influences syntax highlighting, unless the syntax
4886 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 NOTE: This option is set to the Vi default value when 'compatible' is
4888 set and to the Vim default value when 'compatible' is reset.
4889
4890 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004891'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 "@,~-255"; otherwise: "@,161-255")
4893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 The characters given by this option are displayed directly on the
4895 screen. It is also used for "\p" in a |pattern|. The characters from
4896 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4897 even when they are not included in 'isprint' or excluded. See
4898 'isfname' for a description of the format of this option.
4899
4900 Non-printable characters are displayed with two characters:
4901 0 - 31 "^@" - "^_"
4902 32 - 126 always single characters
4903 127 "^?"
4904 128 - 159 "~@" - "~_"
4905 160 - 254 "| " - "|~"
4906 255 "~?"
4907 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4908 displayed as <xx>, with the hexadecimal value of the byte.
4909 When 'display' contains "uhex" all unprintable characters are
4910 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004911 The SpecialKey highlighting will be used for unprintable characters.
4912 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913
4914 Multi-byte characters 256 and above are always included, only the
4915 characters up to 255 are specified with this option. When a character
4916 is printable but it is not available in the current font, a
4917 replacement character will be shown.
4918 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4919 There is no option to specify these characters.
4920
4921 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4922'joinspaces' 'js' boolean (default on)
4923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 Insert two spaces after a '.', '?' and '!' with a join command.
4925 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4926 Otherwise only one space is inserted.
4927 NOTE: This option is set when 'compatible' is set.
4928
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004929 *'jumpoptions'* *'jop'*
4930'jumpoptions' 'jop' string (default "")
4931 global
4932 List of words that change the behavior of the |jumplist|.
4933 stack Make the jumplist behave like the tagstack.
4934 Relative location of entries in the jumplist is
4935 preserved at the cost of discarding subsequent entries
4936 when navigating backwards in the jumplist and then
4937 jumping to a location. |jumplist-stack|
4938
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 *'key'*
4940'key' string (default "")
4941 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004942 {only available when compiled with the |+cryptv|
4943 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004945 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 Careful: Do not set the key value by hand, someone might see the typed
4947 key. Use the |:X| command. But you can make 'key' empty: >
4948 :set key=
4949< It is not possible to get the value of this option with ":set key" or
4950 "echo &key". This is to avoid showing it to someone who shouldn't
4951 know. It also means you cannot see it yourself once you have set it,
4952 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004953 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4954 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004955 You can use "&key" in an expression to detect whether encryption is
4956 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957
4958 *'keymap'* *'kmp'* *E544*
4959'keymap' 'kmp' string (default "")
4960 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 {only available when compiled with the |+keymap|
4962 feature}
4963 Name of a keyboard mapping. See |mbyte-keymap|.
4964 Setting this option to a valid keymap name has the side effect of
4965 setting 'iminsert' to one, so that the keymap becomes effective.
4966 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004967 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968
4969 *'keymodel'* *'km'*
4970'keymodel' 'km' string (default "")
4971 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004972 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 can do. These values can be used:
4974 startsel Using a shifted special key starts selection (either
4975 Select mode or Visual mode, depending on "key" being
4976 present in 'selectmode').
4977 stopsel Using a not-shifted special key stops selection.
4978 Special keys in this context are the cursor keys, <End>, <Home>,
4979 <PageUp> and <PageDown>.
4980 The 'keymodel' option is set by the |:behave| command.
4981
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004982 *'keyprotocol'* *'kpc'*
4983'keyprotocol' 'kpc' string (default: see below)
4984 global
4985 Specifies what keyboard protocol to use depending on the value of
4986 'term'. The supported keyboard protocols names are:
4987 none whatever the terminal uses
4988 mok2 modifyOtherKeys level 2, as supported by xterm
4989 kitty Kitty keyboard protocol, as supported by Kitty
4990
Bram Moolenaara87749e2022-11-30 10:23:17 +00004991 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004992 a pattern that is matched against the 'term' option, a colon and the
4993 protocol name to be used. To illustrate this, the default value would
4994 be set with: >
4995 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
4996
4997< This means that when 'term' contains "kitty, "foot" or "wezterm"
4998 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00004999 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005000
5001 The first match is used, thus if you want to have "kitty" use the
5002 kitty protocol, but "badkitty" not, then you should match "badkitty"
5003 first and use the "none" value: >
5004 set keyprotocol=badkitty:none,kitty:kitty
5005<
5006 The option is used after 'term' has been changed. First the termcap
5007 entries are set, possibly using the builtin list, see |builtin-terms|.
5008 Then this option is inspected and if there is a match and a protocol
5009 is specified the following happens:
5010 none Nothing, the regular t_TE and t_TI values remain
5011
5012 mok2 The t_TE value is changed to:
5013 CSI >4;m disables modifyOtherKeys
5014 The t_TI value is changed to:
5015 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005016 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005017
5018 kitty The t_TE value is changed to:
5019 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005020 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005021 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005022 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005023 CSI ?u request kitty keyboard protocol state
5024 CSI >c request the termresponse
5025
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005026 If you notice problems, such as characters being displayed that
5027 disappear after `CTRL-L`, you might want to try making this option
5028 empty. Then set the 'term' option to have it take effect: >
5029 set keyprotocol=
5030 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005031<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005032
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 *'keywordprg'* *'kp'*
5034'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005035 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 Program to use for the |K| command. Environment variables are
5038 expanded |:set_env|. ":help" may be used to access the Vim internal
5039 help. (Note that previously setting the global option to the empty
5040 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005041 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005042 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005043 When "man", "man -s" or an Ex command is used, Vim will automatically
5044 translate a count for the "K" command and pass it as the first
5045 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 See |option-backslash| about including spaces and backslashes.
5047 Example: >
5048 :set keywordprg=man\ -s
5049< This option cannot be set from a |modeline| or in the |sandbox|, for
5050 security reasons.
5051
5052 *'langmap'* *'lmap'* *E357* *E358*
5053'langmap' 'lmap' string (default "")
5054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 {only available when compiled with the |+langmap|
5056 feature}
5057 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005058 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005059 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 care of translating these special characters to the original meaning
5061 of the key. This means you don't have to change the keyboard mode to
5062 be able to execute Normal mode commands.
5063 This is the opposite of the 'keymap' option, where characters are
5064 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005065 Also consider setting 'langremap' to off, to prevent 'langmap' from
5066 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005067 This option cannot be set from a |modeline| or in the |sandbox|, for
5068 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005070 Example (for Greek, in UTF-8): *greek* >
5071 :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 +00005072< Example (exchanges meaning of z and y for commands): >
5073 :set langmap=zy,yz,ZY,YZ
5074<
5075 The 'langmap' option is a list of parts, separated with commas. Each
5076 part can be in one of two forms:
5077 1. A list of pairs. Each pair is a "from" character immediately
5078 followed by the "to" character. Examples: "aA", "aAbBcC".
5079 2. A list of "from" characters, a semi-colon and a list of "to"
5080 characters. Example: "abc;ABC"
5081 Example: "aA,fgh;FGH,cCdDeE"
5082 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005083 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084
5085 This will allow you to activate vim actions without having to switch
5086 back and forth between the languages. Your language characters will
5087 be understood as normal vim English characters (according to the
5088 langmap mappings) in the following cases:
5089 o Normal/Visual mode (commands, buffer/register names, user mappings)
5090 o Insert/Replace Mode: Register names after CTRL-R
5091 o Insert/Replace Mode: Mappings
5092 Characters entered in Command-line mode will NOT be affected by
5093 this option. Note that this option can be changed at any time
5094 allowing to switch between mappings for different languages/encodings.
5095 Use a mapping to avoid having to type it each time!
5096
5097 *'langmenu'* *'lm'*
5098'langmenu' 'lm' string (default "")
5099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 {only available when compiled with the |+menu| and
5101 |+multi_lang| features}
5102 Language to use for menu translation. Tells which file is loaded
5103 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005104 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105< (without the spaces). For example, to always use the Dutch menus, no
5106 matter what $LANG is set to: >
5107 :set langmenu=nl_NL.ISO_8859-1
5108< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005109 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 If your $LANG is set to a non-English language but you do want to use
5111 the English menus: >
5112 :set langmenu=none
5113< This option must be set before loading menus, switching on filetype
5114 detection or syntax highlighting. Once the menus are defined setting
5115 this option has no effect. But you could do this: >
5116 :source $VIMRUNTIME/delmenu.vim
5117 :set langmenu=de_DE.ISO_8859-1
5118 :source $VIMRUNTIME/menu.vim
5119< Warning: This deletes all menus that you defined yourself!
5120
Bram Moolenaard94464e2015-11-02 15:28:18 +01005121 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005122'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005123 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005124 {only available when compiled with the |+langmap|
5125 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005126 This is just like 'langremap' but with the value inverted. It only
5127 exists for backwards compatibility. When setting 'langremap' then
5128 'langnoremap' is set to the inverted value, and the other way around.
5129
5130 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005131'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005132 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005133 {only available when compiled with the |+langmap|
5134 feature}
5135 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005136 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005137 'langmap' disables some of your mappings, try resetting this option.
5138 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005139 that works for you to avoid mappings to break.
5140
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 *'laststatus'* *'ls'*
5142'laststatus' 'ls' number (default 1)
5143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 The value of this option influences when the last window will have a
5145 status line:
5146 0: never
5147 1: only if there are at least two windows
5148 2: always
5149 The screen looks nicer with a status line if you have several
5150 windows, but it takes another screen line. |status-line|
5151
5152 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5153'lazyredraw' 'lz' boolean (default off)
5154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 When this option is set, the screen will not be redrawn while
5156 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005157 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005159 This may occasionally cause display errors. It is only meant to be set
5160 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005161 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162
5163 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5164'linebreak' 'lbr' boolean (default off)
5165 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005166 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005168 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 than at the last character that fits on the screen. Unlike
5170 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005171 it only affects the way the file is displayed, not its contents.
5172 If 'breakindent' is set, line is visually indented. Then, the value
5173 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005174 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 Note that <Tab> characters after an <EOL> are mostly not displayed
5176 with the right amount of white space.
5177
5178 *'lines'* *E593*
5179'lines' number (default 24 or terminal height)
5180 global
5181 Number of lines of the Vim window.
5182 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005183 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 When Vim is running in the GUI or in a resizable window, setting this
5185 option will cause the window size to be changed. When you only want
5186 to use the size for the GUI, put the command in your |gvimrc| file.
5187 Vim limits the number of lines to what fits on the screen. You can
5188 use this command to get the tallest window possible: >
5189 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005190< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005191 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 When you set this option and Vim is unable to change the physical
5193 number of lines of the display, the display may be messed up.
5194
5195 *'linespace'* *'lsp'*
5196'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 {only in the GUI}
5199 Number of pixel lines inserted between characters. Useful if the font
5200 uses the full character cell height, making lines touch each other.
5201 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005202 With some fonts there can be too much room between lines (to have
5203 space for ascents and descents). Then it makes sense to set
5204 'linespace' to a negative value. This may cause display problems
5205 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206
5207 *'lisp'* *'nolisp'*
5208'lisp' boolean (default off)
5209 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 Lisp mode: When <Enter> is typed in insert mode set the indent for
5211 the next line to Lisp standards (well, sort of). Also happens with
5212 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5213 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5214 better. Also see 'lispwords'.
5215 The '-' character is included in keyword characters. Redefines the
5216 "=" operator to use this same indentation algorithm rather than
5217 calling an external program if 'equalprg' is empty.
5218 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005220 *'lispoptions'* *'lop'*
5221'lispoptions' 'lop' string (default "")
5222 local to buffer
5223 Comma-separated list of items that influence the Lisp indenting when
5224 enabled with the |'lisp'| option. Currently only one item is
5225 supported:
5226 expr:1 use 'indentexpr' for Lisp indenting when it is set
5227 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5228 Note that when using 'indentexpr' the `=` operator indents all the
5229 lines, otherwise the first line is not indented (Vi-compatible).
5230
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 *'lispwords'* *'lw'*
5232'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005233 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005234 Comma-separated list of words that influence the Lisp indenting when
5235 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236
5237 *'list'* *'nolist'*
5238'list' boolean (default off)
5239 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005240 List mode: By default show tabs as CTRL-I is displayed, display $
5241 after end of line. Useful to see the difference between tabs and
5242 spaces and for trailing blanks. Further changed by the 'listchars'
5243 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005244
5245 The cursor is displayed at the start of the space a Tab character
5246 occupies, not at the end as usual in Normal mode. To get this cursor
5247 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005248 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005249<
5250 Note that list mode will also affect formatting (set with 'textwidth'
5251 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 changing the way tabs are displayed.
5253
5254 *'listchars'* *'lcs'*
5255'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005256 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005257 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005258 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005259 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 eol:c Character to show at the end of each line. When
5261 omitted, there is no extra character at the end of the
5262 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005263 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005264 tab:xy[z] Two or three characters to be used to show a tab.
5265 The third character is optional.
5266
5267 tab:xy The 'x' is always used, then 'y' as many times as will
5268 fit. Thus "tab:>-" displays:
5269 >
5270 >-
5271 >--
5272 etc.
5273
5274 tab:xyz The 'z' is always used, then 'x' is prepended, and
5275 then 'y' is used as many times as will fit. Thus
5276 "tab:<->" displays:
5277 >
5278 <>
5279 <->
5280 <-->
5281 etc.
5282
5283 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005284 *lcs-space*
5285 space:c Character to show for a space. When omitted, spaces
5286 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005287 *lcs-multispace*
5288 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005289 One or more characters to use cyclically to show for
5290 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005291 setting, except for single spaces. When omitted, the
5292 "space" setting is used. For example,
5293 `:set listchars=multispace:---+` shows ten consecutive
5294 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005295 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005296 *lcs-lead*
5297 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005298 leading spaces are blank. Overrides the "space" and
5299 "multispace" settings for leading spaces. You can
5300 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005301 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005302< *lcs-leadmultispace*
5303 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005304 Like the |lcs-multispace| value, but for leading
5305 spaces only. Also overrides |lcs-lead| for leading
5306 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005307 `:set listchars=leadmultispace:---+` shows ten
5308 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005309 ---+---+--XXX ~
5310 Where "XXX" denotes the first non-blank characters in
5311 the line.
5312 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005313 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005314 trailing spaces are blank. Overrides the "space" and
5315 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005316 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317 extends:c Character to show in the last column, when 'wrap' is
5318 off and the line continues beyond the right of the
5319 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005320 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005321 precedes:c Character to show in the first visible column of the
5322 physical line, when there is text preceding the
5323 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005324 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005325 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005326 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005327 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005328 nbsp:c Character to show for a non-breakable space character
5329 (0xA0 (160 decimal) and U+202F). Left blank when
5330 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005332 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005334 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005336 Each character can be specified as hex: >
5337 set listchars=eol:\\x24
5338 set listchars=eol:\\u21b5
5339 set listchars=eol:\\U000021b5
5340< Note that a double backslash is used. The number of hex characters
5341 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5342
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 Examples: >
5344 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005345 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 :set lcs=extends:>,precedes:<
5347< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005348 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5349 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005350 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351
5352 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5353'loadplugins' 'lpl' boolean (default on)
5354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 When on the plugin scripts are loaded when starting up |load-plugins|.
5356 This option can be reset in your |vimrc| file to disable the loading
5357 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005358 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5359 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360
Bram Moolenaard94464e2015-11-02 15:28:18 +01005361 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005362'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005363 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005364 {only available when compiled with the |+lua/dyn|
5365 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005366 Specifies the name of the Lua shared library. The default is
5367 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005368 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005369 This option cannot be set from a |modeline| or in the |sandbox|, for
5370 security reasons.
5371
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005372 *'macatsui'* *'nomacatsui'*
5373'macatsui' boolean (default on)
5374 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005375 {not supported}
5376 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005377
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 *'magic'* *'nomagic'*
5379'magic' boolean (default on)
5380 global
5381 Changes the special characters that can be used in search patterns.
5382 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005383 WARNING: Switching this option off most likely breaks plugins! That
5384 is because many patterns assume it's on and will fail when it's off.
5385 Only switch it off when working with old Vi scripts. In any other
5386 situation write patterns that work when 'magic' is on. Include "\M"
5387 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005388 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5389 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390
5391 *'makeef'* *'mef'*
5392'makeef' 'mef' string (default: "")
5393 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 {not available when compiled without the |+quickfix|
5395 feature}
5396 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5397 and the |:grep| command.
5398 When it is empty, an internally generated temp file will be used.
5399 When "##" is included, it is replaced by a number to make the name
5400 unique. This makes sure that the ":make" command doesn't overwrite an
5401 existing file.
5402 NOT used for the ":cf" command. See 'errorfile' for that.
5403 Environment variables are expanded |:set_env|.
5404 See |option-backslash| about including spaces and backslashes.
5405 This option cannot be set from a |modeline| or in the |sandbox|, for
5406 security reasons.
5407
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005408 *'makeencoding'* *'menc'*
5409'makeencoding' 'menc' string (default "")
5410 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005411 Encoding used for reading the output of external commands. When empty,
5412 encoding is not converted.
5413 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5414 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5415 and `:laddfile`.
5416
5417 This would be mostly useful when you use MS-Windows and set 'encoding'
5418 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5419 'makeencoding' to "char" has the same effect as setting to the system
5420 locale encoding. Example: >
5421 :set encoding=utf-8
5422 :set makeencoding=char " system locale is used
5423<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 *'makeprg'* *'mp'*
5425'makeprg' 'mp' string (default "make", VMS: "MMS")
5426 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005427 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005428 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5429 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005430 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005431 Environment variables are expanded |:set_env|. See |option-backslash|
5432 about including spaces and backslashes.
5433 Note that a '|' must be escaped twice: once for ":set" and once for
5434 the interpretation of a command. When you use a filter called
5435 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 :set makeprg=gmake\ \\\|\ myfilter
5437< The placeholder "$*" can be given (even multiple times) to specify
5438 where the arguments will be included, for example: >
5439 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5440< This option cannot be set from a |modeline| or in the |sandbox|, for
5441 security reasons.
5442
5443 *'matchpairs'* *'mps'*
5444'matchpairs' 'mps' string (default "(:),{:},[:]")
5445 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005447 other.
5448 Only character pairs are allowed that are different, thus you cannot
5449 jump between two double quotes.
5450 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005451 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005452 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 :set mps+=<:>
5454
5455< A more exotic example, to jump between the '=' and ';' in an
5456 assignment, useful for languages like C and Java: >
5457 :au FileType c,cpp,java set mps+==:;
5458
5459< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005460 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
5462 *'matchtime'* *'mat'*
5463'matchtime' 'mat' number (default 5)
5464 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 Tenths of a second to show the matching paren, when 'showmatch' is
5466 set. Note that this is not in milliseconds, like other options that
5467 set a time. This is to be compatible with Nvi.
5468
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005469 *'maxcombine'* *'mco'*
5470'maxcombine' 'mco' number (default 2)
5471 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005472 The maximum number of combining characters supported for displaying.
5473 Only used when 'encoding' is "utf-8".
5474 The default is OK for most languages. Hebrew may require 4.
5475 Maximum value is 6.
5476 Even when this option is set to 2 you can still edit text with more
5477 combining characters, you just can't see them. Use |g8| or |ga|.
5478 See |mbyte-combining|.
5479
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 *'maxfuncdepth'* *'mfd'*
5481'maxfuncdepth' 'mfd' number (default 100)
5482 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005483 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005484 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 Maximum depth of function calls for user functions. This normally
5486 catches endless recursion. When using a recursive function with
5487 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5488 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005489 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005490 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005492 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493
5494 *'maxmapdepth'* *'mmd'* *E223*
5495'maxmapdepth' 'mmd' number (default 1000)
5496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 Maximum number of times a mapping is done without resulting in a
5498 character to be used. This normally catches endless mappings, like
5499 ":map x y" with ":map y x". It still does not catch ":map g wg",
5500 because the 'w' is used before the next mapping is done. See also
5501 |key-mapping|.
5502
5503 *'maxmem'* *'mm'*
5504'maxmem' 'mm' number (default between 256 to 5120 (system
5505 dependent) or half the amount of memory
5506 available)
5507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5509 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005510 other memory to be freed.
5511 The maximum usable value is about 2000000. Use this to work without a
5512 limit.
5513 The value is ignored when 'swapfile' is off.
5514 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005516 *'maxmempattern'* *'mmp'*
5517'maxmempattern' 'mmp' number (default 1000)
5518 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005519 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005520 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005521 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005522 When Vim runs into the limit it gives an error message and mostly
5523 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005524 Running into the limit often means that the pattern is very
5525 inefficient or too complex. This may already happen with the pattern
5526 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005527 Might also happen on redraw, when syntax rules try to match a complex
5528 text structure.
5529 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5530 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005531
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 *'maxmemtot'* *'mmt'*
5533'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5534 dependent) or half the amount of memory
5535 available)
5536 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005537 Maximum amount of memory in Kbyte to use for all buffers together.
5538 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005539 without a limit.
5540 On 64 bit machines higher values might work. But hey, do you really
5541 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005542 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005543 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005544 Buffers with 'swapfile' off still count to the total amount of memory
5545 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005546 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547
5548 *'menuitems'* *'mis'*
5549'menuitems' 'mis' number (default 25)
5550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 {not available when compiled without the |+menu|
5552 feature}
5553 Maximum number of items to use in a menu. Used for menus that are
5554 generated from a list of items, e.g., the Buffers menu. Changing this
5555 option has no direct effect, the menu must be refreshed first.
5556
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005557 *'mkspellmem'* *'msm'*
5558'mkspellmem' 'msm' string (default "460000,2000,500")
5559 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005560 {not available when compiled without the |+syntax|
5561 feature}
5562 Parameters for |:mkspell|. This tunes when to start compressing the
5563 word tree. Compression can be slow when there are many words, but
5564 it's needed to avoid running out of memory. The amount of memory used
5565 per word depends very much on how similar the words are, that's why
5566 this tuning is complicated.
5567
5568 There are three numbers, separated by commas:
5569 {start},{inc},{added}
5570
5571 For most languages the uncompressed word tree fits in memory. {start}
5572 gives the amount of memory in Kbyte that can be used before any
5573 compression is done. It should be a bit smaller than the amount of
5574 memory that is available to Vim.
5575
5576 When going over the {start} limit the {inc} number specifies the
5577 amount of memory in Kbyte that can be allocated before another
5578 compression is done. A low number means compression is done after
5579 less words are added, which is slow. A high number means more memory
5580 will be allocated.
5581
5582 After doing compression, {added} times 1024 words can be added before
5583 the {inc} limit is ignored and compression is done when any extra
5584 amount of memory is needed. A low number means there is a smaller
5585 chance of hitting the {inc} limit, less memory is used but it's
5586 slower.
5587
5588 The languages for which these numbers are important are Italian and
5589 Hungarian. The default works for when you have about 512 Mbyte. If
5590 you have 1 Gbyte you could use: >
5591 :set mkspellmem=900000,3000,800
5592< If you have less than 512 Mbyte |:mkspell| may fail for some
5593 languages, no matter what you set 'mkspellmem' to.
5594
dkearns8ebdbc92023-10-29 06:26:19 +11005595 This option cannot be set from a |modeline| or in the |sandbox|, for
5596 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005597
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005599'modeline' 'ml' boolean (Vim default: on (off for root),
5600 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005602 If 'modeline' is on 'modelines' gives the number of lines that is
5603 checked for set commands. If 'modeline' is off or 'modelines' is zero
5604 no lines are checked. See |modeline|.
5605
5606 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5607'modelineexpr' 'mle' boolean (default: off)
5608 global
5609 When on allow some options that are an expression to be set in the
5610 modeline. Check the option for whether it is affected by
5611 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005612 This option cannot be set from a |modeline| or in the |sandbox|, for
5613 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005614
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 *'modelines'* *'mls'*
5616'modelines' 'mls' number (default 5)
5617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 If 'modeline' is on 'modelines' gives the number of lines that is
5619 checked for set commands. If 'modeline' is off or 'modelines' is zero
5620 no lines are checked. See |modeline|.
5621 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5622 set and to the Vim default value when 'compatible' is reset.
5623
5624 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005625 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626'modifiable' 'ma' boolean (default on)
5627 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 When off the buffer contents cannot be changed. The 'fileformat' and
5629 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005630 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631
5632 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5633'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005634 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 When on, the buffer is considered to be modified. This option is set
5636 when:
5637 1. A change was made to the text since it was last written. Using the
5638 |undo| command to go back to the original text will reset the
5639 option. But undoing changes that were made before writing the
5640 buffer will set the option again, since the text is different from
5641 when it was written.
5642 2. 'fileformat' or 'fileencoding' is different from its original
5643 value. The original value is set when the buffer is read or
5644 written. A ":set nomodified" command also resets the original
5645 values to the current values and the 'modified' option will be
5646 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005647 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005648 This option is not set when a change is made to the buffer as the
5649 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5650 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5651 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5653 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005654 Note that the text may actually be the same, e.g. 'modified' is set
5655 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656
5657 *'more'* *'nomore'*
5658'more' boolean (Vim default: on, Vi default: off)
5659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660 When on, listings pause when the whole screen is filled. You will get
5661 the |more-prompt|. When this option is off there are no pauses, the
5662 listing continues until finished.
5663 NOTE: This option is set to the Vi default value when 'compatible' is
5664 set and to the Vim default value when 'compatible' is reset.
5665
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005666 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005667'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005668 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005670 Enable the use of the mouse. Works for most terminals (xterm, Win32
5671 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5672 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5673 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005674 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 v Visual mode
5676 i Insert mode
5677 c Command-line mode
5678 h all previous modes when editing a help file
5679 a all previous modes
5680 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005681 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005683< If your terminal can't overrule the mouse events going to the
5684 application, use: >
5685 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005686< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005687 back to Vim using the mouse events.
5688 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5689 "xterm".
5690
5691 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 modeless selection. This doesn't move the text cursor.
5693
5694 See |mouse-using|. Also see |'clipboard'|.
5695
5696 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005697 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 the mouse buttons can still be used by keeping the shift key pressed.
5699 Also see the 'clipboard' option.
5700
5701 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5702'mousefocus' 'mousef' boolean (default off)
5703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 {only works in the GUI}
5705 The window that the mouse pointer is on is automatically activated.
5706 When changing the window layout or window focus in another way, the
5707 mouse pointer is moved to the window with keyboard focus. Off is the
5708 default because it makes using the pull down menus a little goofy, as
5709 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005710 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005711 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712
5713 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5714'mousehide' 'mh' boolean (default on)
5715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 {only works in the GUI}
5717 When on, the mouse pointer is hidden when characters are typed.
5718 The mouse pointer is restored when the mouse is moved.
5719
5720 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005721'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 Sets the model to use for the mouse. The name mostly specifies what
5724 the right mouse button is used for:
5725 extend Right mouse button extends a selection. This works
5726 like in an xterm.
5727 popup Right mouse button pops up a menu. The shifted left
5728 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005729 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 popup_setpos Like "popup", but the cursor will be moved to the
5731 position where the mouse was clicked, and thus the
5732 selected operation will act upon the clicked object.
5733 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005734 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 course, that right clicking outside a selection will
5736 end Visual mode.
5737 Overview of what button does what for each model:
5738 mouse extend popup(_setpos) ~
5739 left click place cursor place cursor
5740 left drag start selection start selection
5741 shift-left search word extend selection
5742 right click extend selection popup menu (place cursor)
5743 right drag extend selection -
5744 middle click paste paste
5745
5746 In the "popup" model the right mouse button produces a pop-up menu.
5747 You need to define this first, see |popup-menu|.
5748
5749 Note that you can further refine the meaning of buttons with mappings.
5750 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5751 selection (because that's handled in the GUI code directly).
5752
5753 The 'mousemodel' option is set by the |:behave| command.
5754
h_east59858792023-10-25 22:47:05 +09005755 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005756'mousemoveevent' 'mousemev' boolean (default off)
5757 global
5758 {only works in the GUI}
5759 When on, mouse move events are delivered to the input queue and are
5760 available for mapping. The default, off, avoids the mouse movement
5761 overhead except when needed. See |gui-mouse-mapping|.
5762 Warning: Setting this option can make pending mappings to be aborted
5763 when the mouse is moved.
5764 Currently only works in the GUI, may be made to work in a terminal
5765 later.
5766
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005768'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5769 vs:leftright,vd:lrsizing,m:no,
5770 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 {only available when compiled with the |+mouseshape|
5773 feature}
5774 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005775 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776 like used for 'guicursor'. Each part consist of a mode/location-list
5777 and an argument-list:
5778 mode-list:shape,mode-list:shape,..
5779 The mode-list is a dash separated list of these modes/locations:
5780 In a normal window: ~
5781 n Normal mode
5782 v Visual mode
5783 ve Visual mode with 'selection' "exclusive" (same as 'v',
5784 if not specified)
5785 o Operator-pending mode
5786 i Insert mode
5787 r Replace mode
5788
5789 Others: ~
5790 c appending to the command-line
5791 ci inserting in the command-line
5792 cr replacing in the command-line
5793 m at the 'Hit ENTER' or 'More' prompts
5794 ml idem, but cursor in the last line
5795 e any mode, pointer below last window
5796 s any mode, pointer on a status line
5797 sd any mode, while dragging a status line
5798 vs any mode, pointer on a vertical separator line
5799 vd any mode, while dragging a vertical separator line
5800 a everywhere
5801
5802 The shape is one of the following:
5803 avail name looks like ~
5804 w x arrow Normal mouse pointer
5805 w x blank no pointer at all (use with care!)
5806 w x beam I-beam
5807 w x updown up-down sizing arrows
5808 w x leftright left-right sizing arrows
5809 w x busy The system's usual busy pointer
5810 w x no The system's usual 'no input' pointer
5811 x udsizing indicates up-down resizing
5812 x lrsizing indicates left-right resizing
5813 x crosshair like a big thin +
5814 x hand1 black hand
5815 x hand2 white hand
5816 x pencil what you write with
5817 x question big ?
5818 x rightup-arrow arrow pointing right-up
5819 w x up-arrow arrow pointing up
5820 x <number> any X11 pointer number (see X11/cursorfont.h)
5821
5822 The "avail" column contains a 'w' if the shape is available for Win32,
5823 x for X11.
5824 Any modes not specified or shapes not available use the normal mouse
5825 pointer.
5826
5827 Example: >
5828 :set mouseshape=s:udsizing,m:no
5829< will make the mouse turn to a sizing arrow over the status lines and
5830 indicate no input when the hit-enter prompt is displayed (since
5831 clicking the mouse has no effect in this state.)
5832
5833 *'mousetime'* *'mouset'*
5834'mousetime' 'mouset' number (default 500)
5835 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005836 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 time in msec between two mouse clicks for the second click to be
5838 recognized as a multi click.
5839
laburnumT3f7855a2023-12-05 18:37:03 +01005840 *'mzquantum'* *'mzq'*
5841'mzquantum' 'mzq' number (default 100)
5842 global
5843 {not available when compiled without the |+mzscheme|
5844 feature}
5845 The number of milliseconds between polls for MzScheme threads.
5846 Negative or zero value means no thread scheduling.
5847 NOTE: This option is set to the Vim default value when 'compatible'
5848 is reset.
5849
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005850 *'mzschemedll'*
5851'mzschemedll' string (default depends on the build)
5852 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005853 {only available when compiled with the |+mzscheme/dyn|
5854 feature}
5855 Specifies the name of the MzScheme shared library. The default is
5856 DYNAMIC_MZSCH_DLL which was specified at compile time.
5857 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005858 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005859 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005860 This option cannot be set from a |modeline| or in the |sandbox|, for
5861 security reasons.
5862
5863 *'mzschemegcdll'*
5864'mzschemegcdll' string (default depends on the build)
5865 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005866 {only available when compiled with the |+mzscheme/dyn|
5867 feature}
5868 Specifies the name of the MzScheme GC shared library. The default is
5869 DYNAMIC_MZGC_DLL which was specified at compile time.
5870 The value can be equal to 'mzschemedll' if it includes the GC code.
5871 Environment variables are expanded |:set_env|.
5872 This option cannot be set from a |modeline| or in the |sandbox|, for
5873 security reasons.
5874
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005876'nrformats' 'nf' string (default "bin,octal,hex",
5877 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 This defines what bases Vim will consider for numbers when using the
5880 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5881 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005882 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005884 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005885 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005887 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888 considered to be hexadecimal. Example: Using CTRL-X on
5889 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005890 bin If included, numbers starting with "0b" or "0B" will be
5891 considered to be binary. Example: Using CTRL-X on
5892 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005893 unsigned If included, numbers are recognized as unsigned. Thus a
5894 leading dash or negative sign won't be considered as part of
5895 the number. Examples:
5896 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5897 (without "unsigned" it would become "9-2021").
5898 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5899 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005900 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5901 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 Numbers which simply begin with a digit in the range 1-9 are always
5903 considered decimal. This also happens for numbers that are not
5904 recognized as octal or hex.
5905
5906 *'number'* *'nu'* *'nonumber'* *'nonu'*
5907'number' 'nu' boolean (default off)
5908 local to window
5909 Print the line number in front of each line. When the 'n' option is
5910 excluded from 'cpoptions' a wrapped line will not use the column of
5911 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005912 The 'numberwidth' option can be used to set the room used for the line
5913 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 When a long, wrapped line doesn't start with the first character, '-'
5915 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005916 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5917 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005918 *number_relativenumber*
5919 The 'relativenumber' option changes the displayed number to be
5920 relative to the cursor. Together with 'number' there are these
5921 four combinations (cursor in line 3):
5922
Bram Moolenaar3848e002016-03-19 18:42:29 +01005923 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005924 'nornu' 'nornu' 'rnu' 'rnu'
5925
5926 |apple | 1 apple | 2 apple | 2 apple
5927 |pear | 2 pear | 1 pear | 1 pear
5928 |nobody | 3 nobody | 0 nobody |3 nobody
5929 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005931 *'numberwidth'* *'nuw'*
5932'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5933 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005934 {only available when compiled with the |+linebreak|
5935 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005936 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005937 when the 'number' or 'relativenumber' option is set or printing lines
5938 with a line number. Since one space is always between the number and
5939 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005940 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005941 fit the highest line number in the buffer respectively the number of
5942 rows in the window, depending on whether 'number' or 'relativenumber'
5943 is set. Thus with the Vim default of 4 there is room for a line number
5944 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005945 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005946 NOTE: This option is set to the Vi default value when 'compatible' is
5947 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005948
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005949 *'omnifunc'* *'ofu'*
5950'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005951 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005952 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005953 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005954 This option specifies a function to be used for Insert mode omni
5955 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005956 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005957 invoked and what it should return. The value can be the name of a
5958 function, a |lambda| or a |Funcref|. See |option-value-function| for
5959 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005960 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005961 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005962 This option cannot be set from a |modeline| or in the |sandbox|, for
5963 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005964
Bram Moolenaar02467872007-05-06 13:22:01 +00005965 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005966'opendevice' 'odev' boolean (default off)
5967 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005968 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005969 Enable reading and writing from devices. This may get Vim stuck on a
5970 device that can be opened but doesn't actually do the I/O. Therefore
5971 it is off by default.
5972 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5973 result in editing a device.
5974
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005975 *'operatorfunc'* *'opfunc'*
5976'operatorfunc' 'opfunc' string (default: empty)
5977 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005978 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005979 See |:map-operator| for more info and an example. The value can be
5980 the name of a function, a |lambda| or a |Funcref|. See
5981 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005982
5983 This option cannot be set from a |modeline| or in the |sandbox|, for
5984 security reasons.
5985
Bram Moolenaar251e1912011-06-19 05:09:16 +02005986 *'osfiletype'* *'oft'*
5987'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005989 This option was supported on RISC OS, which has been removed.
5990
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005991 *'packpath'* *'pp'*
5992'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005993 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11005994 This option cannot be set from a |modeline| or in the |sandbox|, for
5995 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005996
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005998'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 global
6000 Specifies the nroff macros that separate paragraphs. These are pairs
6001 of two letters (see |object-motions|).
6002
6003 *'paste'* *'nopaste'*
6004'paste' boolean (default off)
6005 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006006 Put Vim in Paste mode. This is useful if you want to cut or copy
6007 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 unexpected effects.
6009 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006010 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 knows about pasting and will mostly do the right thing without 'paste'
6012 being set. The same is true for a terminal where Vim handles the
6013 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006014 This option is reset when starting the GUI. Thus if you set it in
6015 your .vimrc it will work in a terminal, but not in the GUI. Setting
6016 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6017 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 When the 'paste' option is switched on (also when it was already on):
6019 - mapping in Insert mode and Command-line mode is disabled
6020 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006022 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006023 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024 - 'revins' is reset
6025 - 'ruler' is reset
6026 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006027 - 'smarttab' is reset
6028 - 'softtabstop' is set to 0
6029 - 'textwidth' is set to 0
6030 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006031 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006034 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006035 - 'indentexpr'
6036 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006037 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 NOTE: When you start editing another file while the 'paste' option is
6039 on, settings from the modelines or autocommands may change the
6040 settings again, causing trouble when pasting text. You might want to
6041 set the 'paste' option again.
6042 When the 'paste' option is reset the mentioned options are restored to
6043 the value before the moment 'paste' was switched from off to on.
6044 Resetting 'paste' before ever setting it does not have any effect.
6045 Since mapping doesn't work while 'paste' is active, you need to use
6046 the 'pastetoggle' option to toggle the 'paste' option with some key.
6047
6048 *'pastetoggle'* *'pt'*
6049'pastetoggle' 'pt' string (default "")
6050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 When non-empty, specifies the key sequence that toggles the 'paste'
6052 option. This is like specifying a mapping: >
6053 :map {keys} :set invpaste<CR>
6054< Where {keys} is the value of 'pastetoggle'.
6055 The difference is that it will work even when 'paste' is set.
6056 'pastetoggle' works in Insert mode and Normal mode, but not in
6057 Command-line mode.
6058 Mappings are checked first, thus overrule 'pastetoggle'. However,
6059 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6060 this: >
6061 :map <F10> :set paste<CR>
6062 :map <F11> :set nopaste<CR>
6063 :imap <F10> <C-O>:set paste<CR>
6064 :imap <F11> <nop>
6065 :set pastetoggle=<F11>
6066< This will make <F10> start paste mode and <F11> stop paste mode.
6067 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6068 mode everything is inserted literally, except the 'pastetoggle' key
6069 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006070 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071
6072 *'pex'* *'patchexpr'*
6073'patchexpr' 'pex' string (default "")
6074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 {not available when compiled without the |+diff|
6076 feature}
6077 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006078 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006079 This option cannot be set from a |modeline| or in the |sandbox|, for
6080 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081
Bram Moolenaardbc28022014-07-26 13:40:44 +02006082 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083'patchmode' 'pm' string (default "")
6084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 When non-empty the oldest version of a file is kept. This can be used
6086 to keep the original version of a file if you are changing files in a
6087 source distribution. Only the first time that a file is written a
6088 copy of the original file will be kept. The name of the copy is the
6089 name of the original file with the string in the 'patchmode' option
6090 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006091 ".orig" or ".org". 'backupdir' must not be empty for this to work
6092 (Detail: The backup file is renamed to the patchmode file after the
6093 new file has been successfully written, that's why it must be possible
6094 to write a backup file). If there was no file to be backed up, an
6095 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 When the 'backupskip' pattern matches, a patchmode file is not made.
6097 Using 'patchmode' for compressed files appends the extension at the
6098 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6099 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006100 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006102 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 other systems: ".,,")
6105 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006107 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6108 provided that the file being searched for has a relative path (not
6109 starting with "/", "./" or "../"). The directories in the 'path'
6110 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 - Use commas to separate directory names: >
6112 :set path=.,/usr/local/include,/usr/include
6113< - Spaces can also be used to separate directory names (for backwards
6114 compatibility with version 3.0). To have a space in a directory
6115 name, precede it with an extra backslash, and escape the space: >
6116 :set path=.,/dir/with\\\ space
6117< - To include a comma in a directory name precede it with an extra
6118 backslash: >
6119 :set path=.,/dir/with\\,comma
6120< - To search relative to the directory of the current file, use: >
6121 :set path=.
6122< - To search in the current directory use an empty string between two
6123 commas: >
6124 :set path=,,
6125< - A directory name may end in a ':' or '/'.
6126 - Environment variables are expanded |:set_env|.
6127 - When using |netrw.vim| URLs can be used. For example, adding
6128 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006129 - Search upwards and downwards in a directory tree using "*", "**" and
6130 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131 - Careful with '\' characters, type two to get one in the option: >
6132 :set path=.,c:\\include
6133< Or just use '/' instead: >
6134 :set path=.,c:/include
6135< Don't forget "." or files won't even be found in the same directory as
6136 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006137 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 it is something like 256 or 1024 characters.
6139 You can check if all the include files are found, using the value of
6140 'path', see |:checkpath|.
6141 The use of |:set+=| and |:set-=| is preferred when adding or removing
6142 directories from the list. This avoids problems when a future version
6143 uses another default. To remove the current directory use: >
6144 :set path-=
6145< To add the current directory use: >
6146 :set path+=
6147< To use an environment variable, you probably need to replace the
6148 separator. Here is an example to append $INCL, in which directory
6149 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006150 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151< Replace the ';' with a ':' or whatever separator is used. Note that
6152 this doesn't work when $INCL contains a comma or white space.
6153
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006154 *'perldll'*
6155'perldll' string (default depends on the build)
6156 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006157 {only available when compiled with the |+perl/dyn|
6158 feature}
6159 Specifies the name of the Perl shared library. The default is
6160 DYNAMIC_PERL_DLL, which was specified at compile time.
6161 Environment variables are expanded |:set_env|.
6162 This option cannot be set from a |modeline| or in the |sandbox|, for
6163 security reasons.
6164
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6166'preserveindent' 'pi' boolean (default off)
6167 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 When changing the indent of the current line, preserve as much of the
6169 indent structure as possible. Normally the indent is replaced by a
6170 series of tabs followed by spaces as required (unless |'expandtab'| is
6171 enabled, in which case only spaces are used). Enabling this option
6172 means the indent will preserve as many existing characters as possible
6173 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006174 'expandtab' does not apply to the preserved white space, a Tab remains
6175 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 NOTE: When using ">>" multiple times the resulting indent is a mix of
6177 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006178 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 Also see 'copyindent'.
6180 Use |:retab| to clean up white space.
6181
6182 *'previewheight'* *'pvh'*
6183'previewheight' 'pvh' number (default 12)
6184 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006185 {not available when compiled without the |+quickfix|
6186 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006188 commands. Used for |CTRL-W_}| when no count is given. Not used when
6189 'previewpopup' is set.
6190
6191 *'previewpopup'* *'pvp'*
6192'previewpopup' 'pvp' string (default empty)
6193 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006194 {not available when compiled without the |+textprop|
6195 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006196 When not empty a popup window is used for commands that would open a
6197 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006198 Not used for the insert completion info, add "popup" to
6199 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200
6201 *'previewwindow'* *'nopreviewwindow'*
6202 *'pvw'* *'nopvw'* *E590*
6203'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006204 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006205 {not available when compiled without the |+quickfix|
6206 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006207 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 set. It's normally not set directly, but by using one of the commands
6209 |:ptag|, |:pedit|, etc.
6210
6211 *'printdevice'* *'pdev'*
6212'printdevice' 'pdev' string (default empty)
6213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 {only available when compiled with the |+printer|
6215 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006216 The name of the printer to be used for |:hardcopy|.
6217 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006218 This option cannot be set from a |modeline| or in the |sandbox|, for
6219 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220
Bram Moolenaar8299df92004-07-10 09:47:34 +00006221 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006222'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 {only available when compiled with the |+printer|
6225 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006226 Sets the character encoding used when printing.
6227 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228
6229 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006230'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 {only available when compiled with the |+printer|
6233 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006234 Expression used to print the PostScript produced with |:hardcopy|.
6235 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006236 This option cannot be set from a |modeline| or in the |sandbox|, for
6237 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238
Bram Moolenaar8299df92004-07-10 09:47:34 +00006239 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240'printfont' 'pfn' string (default "courier")
6241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 {only available when compiled with the |+printer|
6243 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006244 The name of the font that will be used for |:hardcopy|.
6245 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246
6247 *'printheader'* *'pheader'*
6248'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6249 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 {only available when compiled with the |+printer|
6251 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006252 The format of the header produced in |:hardcopy| output.
6253 See |pheader-option|.
6254
6255 *'printmbcharset'* *'pmbcs'*
6256'printmbcharset' 'pmbcs' string (default "")
6257 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006258 {only available when compiled with the |+printer|
6259 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006260 The CJK character set to be used for CJK output from |:hardcopy|.
6261 See |pmbcs-option|.
6262
6263 *'printmbfont'* *'pmbfn'*
6264'printmbfont' 'pmbfn' string (default "")
6265 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006266 {only available when compiled with the |+printer|
6267 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006268 List of font names to be used for CJK output from |:hardcopy|.
6269 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270
6271 *'printoptions'* *'popt'*
6272'printoptions' 'popt' string (default "")
6273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006275 List of items that control the format of the output of |:hardcopy|.
6276 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006278 *'prompt'* *'noprompt'*
6279'prompt' boolean (default on)
6280 global
6281 When on a ":" prompt is used in Ex mode.
6282
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006283 *'pumheight'* *'ph'*
6284'pumheight' 'ph' number (default 0)
6285 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006286 Determines the maximum number of items to show in the popup menu for
6287 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006288 |ins-completion-menu|.
6289
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006290 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006291'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006292 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006293 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006294 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006295
Bram Moolenaard94464e2015-11-02 15:28:18 +01006296 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006297'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006298 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006299 {only available when compiled with the |+python/dyn|
6300 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006301 Specifies the name of the Python 2.x shared library. The default is
6302 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006303 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006304 This option cannot be set from a |modeline| or in the |sandbox|, for
6305 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006306
Bram Moolenaar94073162018-01-31 21:49:05 +01006307 *'pythonhome'*
6308'pythonhome' string (default "")
6309 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006310 {only available when compiled with the |+python/dyn|
6311 feature}
6312 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6313 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6314 which was specified at compile time, will be used for the Python 2.x
6315 home directory.
6316 Environment variables are expanded |:set_env|.
6317 This option cannot be set from a |modeline| or in the |sandbox|, for
6318 security reasons.
6319
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006320 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006321'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006322 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006323 {only available when compiled with the |+python3/dyn|
6324 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006325 Specifies the name of the Python 3 shared library. The default is
6326 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006327 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006328 This option cannot be set from a |modeline| or in the |sandbox|, for
6329 security reasons.
6330
Bram Moolenaar94073162018-01-31 21:49:05 +01006331 *'pythonthreehome'*
6332'pythonthreehome' string (default "")
6333 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006334 {only available when compiled with the |+python3/dyn|
6335 feature}
6336 Specifies the name of the Python 3 home directory. When
6337 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6338 PYTHON3_HOME, which was specified at compile time, will be used for
6339 the Python 3 home directory.
6340 Environment variables are expanded |:set_env|.
6341 This option cannot be set from a |modeline| or in the |sandbox|, for
6342 security reasons.
6343
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006344 *'pyxversion'* *'pyx'*
6345'pyxversion' 'pyx' number (default depends on the build)
6346 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006347 {only available when compiled with the |+python| or
6348 the |+python3| feature}
6349 Specifies the python version used for pyx* functions and commands
6350 |python_x|. The default value is as follows:
6351
6352 Compiled with Default ~
6353 |+python| and |+python3| 0
6354 only |+python| 2
6355 only |+python3| 3
6356
6357 Available values are 0, 2 and 3.
6358 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6359 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6360 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6361 to 2 if Python 2 is available.
6362 See also: |has-pythonx|
6363
6364 If Vim is compiled with only |+python| or |+python3| setting
6365 'pyxversion' has no effect. The pyx* functions and commands are
6366 always the same as the compiled version.
6367
6368 This option cannot be set from a |modeline| or in the |sandbox|, for
6369 security reasons.
6370
Bram Moolenaar858ba062020-05-31 23:11:59 +02006371 *'quickfixtextfunc'* *'qftf'*
6372'quickfixtextfunc' 'qftf' string (default "")
6373 global
6374 {only available when compiled with the |+quickfix|
6375 feature}
6376 This option specifies a function to be used to get the text to display
6377 in the quickfix and location list windows. This can be used to
6378 customize the information displayed in the quickfix or location window
6379 for each entry in the corresponding quickfix or location list. See
6380 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006381 function and an example. The value can be the name of a function, a
6382 |lambda| or a |Funcref|. See |option-value-function| for more
6383 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006384
6385 This option cannot be set from a |modeline| or in the |sandbox|, for
6386 security reasons.
6387
Bram Moolenaar677ee682005-01-27 14:41:15 +00006388 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006389'quoteescape' 'qe' string (default "\")
6390 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006391 The characters that are used to escape quotes in a string. Used for
6392 objects like a', a" and a` |a'|.
6393 When one of the characters in this option is found inside a string,
6394 the following character will be skipped. The default value makes the
6395 text "foo\"bar\\" considered to be one string.
6396
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6398'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006399 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400 If on, writes fail unless you use a '!'. Protects you from
6401 accidentally overwriting a file. Default on when Vim is started
6402 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006403 When using ":w!" the 'readonly' option is reset for the current
6404 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006405 When using the ":view" command the 'readonly' option is set for the
6406 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006407 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006409 *'redrawtime'* *'rdt'*
6410'redrawtime' 'rdt' number (default 2000)
6411 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006412 {only available when compiled with the |+reltime|
6413 feature}
6414 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006415 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006416 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006417 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006418 matches will be highlighted.
6419 For syntax highlighting the time applies per window. When over the
6420 limit syntax highlighting is disabled until |CTRL-L| is used.
6421 This is used to avoid that Vim hangs when using a very complicated
6422 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006423
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006424 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006425'regexpengine' 're' number (default 0)
6426 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006427 This selects the default regexp engine. |two-engines|
6428 The possible values are:
6429 0 automatic selection
6430 1 old engine
6431 2 NFA engine
6432 Note that when using the NFA engine and the pattern contains something
6433 that is not supported the pattern will not match. This is only useful
6434 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006435 Using automatic selection enables Vim to switch the engine, if the
6436 default engine becomes too costly. E.g., when the NFA engine uses too
6437 many states. This should prevent Vim from hanging on a combination of
6438 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006439
Bram Moolenaar64486672010-05-16 15:46:46 +02006440 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6441'relativenumber' 'rnu' boolean (default off)
6442 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006443 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006444 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006445 precede some vertical motion commands (e.g. j k + -) with, without
6446 having to calculate it yourself. Especially useful in combination with
6447 other commands (e.g. y d c < > gq gw =).
6448 When the 'n' option is excluded from 'cpoptions' a wrapped
6449 line will not use the column of line numbers (this is the default when
6450 'compatible' isn't set).
6451 The 'numberwidth' option can be used to set the room used for the line
6452 number.
6453 When a long, wrapped line doesn't start with the first character, '-'
6454 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006455 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6456 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006457
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006458 The number in front of the cursor line also depends on the value of
6459 'number', see |number_relativenumber| for all combinations of the two
6460 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006461
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 *'remap'* *'noremap'*
6463'remap' boolean (default on)
6464 global
6465 Allows for mappings to work recursively. If you do not want this for
6466 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006467 NOTE: To avoid portability problems with Vim scripts, always keep
6468 this option at the default "on". Only switch it off when working with
6469 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470
zeertzjqd086b8f2024-02-25 15:42:52 +08006471 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006472'renderoptions' 'rop' string (default: empty)
6473 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006474 {only available when compiled with GUI and DIRECTX on
6475 MS-Windows}
6476 Select a text renderer and set its options. The options depend on the
6477 renderer.
6478
6479 Syntax: >
6480 set rop=type:{renderer}(,{name}:{value})*
6481<
6482 Currently, only one optional renderer is available.
6483
6484 render behavior ~
6485 directx Vim will draw text using DirectX (DirectWrite). It makes
6486 drawn glyphs more beautiful than default GDI.
6487 It requires 'encoding' is "utf-8", and only works on
6488 MS-Windows Vista or newer version.
6489
6490 Options:
6491 name meaning type value ~
6492 gamma gamma float 1.0 - 2.2 (maybe)
6493 contrast enhancedContrast float (unknown)
6494 level clearTypeLevel float (unknown)
6495 geom pixelGeometry int 0 - 2 (see below)
6496 renmode renderingMode int 0 - 6 (see below)
6497 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006498 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006499
Bram Moolenaar92467d32017-12-05 13:22:16 +01006500 See this URL for detail (except for scrlines):
6501 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006502
6503 For geom: structure of a device pixel.
6504 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6505 1 - DWRITE_PIXEL_GEOMETRY_RGB
6506 2 - DWRITE_PIXEL_GEOMETRY_BGR
6507
6508 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006509 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006510
6511 For renmode: method of rendering glyphs.
6512 0 - DWRITE_RENDERING_MODE_DEFAULT
6513 1 - DWRITE_RENDERING_MODE_ALIASED
6514 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6515 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6516 4 - DWRITE_RENDERING_MODE_NATURAL
6517 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6518 6 - DWRITE_RENDERING_MODE_OUTLINE
6519
6520 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006521 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006522
6523 For taamode: antialiasing mode used for drawing text.
6524 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6525 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6526 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6527 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6528
6529 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006530 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6531
Bram Moolenaara338adc2018-01-31 20:51:47 +01006532 For scrlines:
6533 This was used for optimizing scrolling behavior, however this
6534 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006535
6536 Example: >
6537 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006538 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006539 set rop=type:directx
6540<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006541 If select a raster font (Courier, Terminal or FixedSys which
6542 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006543 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006544
6545 NOTE: It is known that some fonts and options combination
6546 causes trouble on drawing glyphs.
6547
Bram Moolenaar92467d32017-12-05 13:22:16 +01006548 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006549 special made fonts (True-Type fonts which includes only
6550 bitmap glyphs).
6551 - 'taamode:3' will not work with some vector fonts.
6552
6553 NOTE: With this option, you can display colored emoji
6554 (emoticon) in Windows 8.1 or later. To display colored emoji,
6555 there are some conditions which you should notice.
6556
6557 - If your font includes non-colored emoji already, it will
6558 be used.
6559 - If your font doesn't have emoji, the system chooses an
6560 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6561 will be used.
6562 - When this alternative font didn't have fixed width glyph,
6563 emoji might be rendered beyond the bounding box of drawing
6564 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006565
6566 Other render types are currently not supported.
6567
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 *'report'*
6569'report' number (default 2)
6570 global
6571 Threshold for reporting number of lines changed. When the number of
6572 changed lines is more than 'report' a message will be given for most
6573 ":" commands. If you want it always, set 'report' to 0.
6574 For the ":substitute" command the number of substitutions is used
6575 instead of the number of lines.
6576
6577 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6578'restorescreen' 'rs' boolean (default on)
6579 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006580 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 When set, the screen contents is restored when exiting Vim. This also
6582 happens when executing external commands.
6583
6584 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6585 options in your .vimrc. To disable restoring:
6586 set t_ti= t_te=
6587 To enable restoring (for an xterm):
6588 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6589 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6590
6591 *'revins'* *'ri'* *'norevins'* *'nori'*
6592'revins' 'ri' boolean (default off)
6593 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 {only available when compiled with the |+rightleft|
6595 feature}
6596 Inserting characters in Insert mode will work backwards. See "typing
6597 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6598 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006599 NOTE: This option is reset when 'compatible' is set.
6600 This option is reset when 'paste' is set and restored when 'paste' is
6601 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602
6603 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6604'rightleft' 'rl' boolean (default off)
6605 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 {only available when compiled with the |+rightleft|
6607 feature}
6608 When on, display orientation becomes right-to-left, i.e., characters
6609 that are stored in the file appear from the right to the left.
6610 Using this option, it is possible to edit files for languages that
6611 are written from the right to the left such as Hebrew and Arabic.
6612 This option is per window, so it is possible to edit mixed files
6613 simultaneously, or to view the same file in both ways (this is
6614 useful whenever you have a mixed text file with both right-to-left
6615 and left-to-right strings so that both sets are displayed properly
6616 in different windows). Also see |rileft.txt|.
6617
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006618 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619'rightleftcmd' 'rlc' string (default "search")
6620 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 {only available when compiled with the |+rightleft|
6622 feature}
6623 Each word in this option enables the command line editing to work in
6624 right-to-left mode for a group of commands:
6625
6626 search "/" and "?" commands
6627
6628 This is useful for languages such as Hebrew, Arabic and Farsi.
6629 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6630
Bram Moolenaard94464e2015-11-02 15:28:18 +01006631 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006632'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006633 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006634 {only available when compiled with the |+ruby/dyn|
6635 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006636 Specifies the name of the Ruby shared library. The default is
6637 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006638 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006639 This option cannot be set from a |modeline| or in the |sandbox|, for
6640 security reasons.
6641
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006643'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006646 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 text in the file is shown on the far right:
6648 Top first line is visible
6649 Bot last line is visible
6650 All first and last line are visible
6651 45% relative position in the file
6652 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006653 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006654 ruler is shown there. Otherwise it is shown in the last line of the
6655 screen. If the statusline is given by 'statusline' (i.e. not empty),
6656 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006658 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 the text column (byte number) and the screen column are shown,
6660 separated with a dash.
6661 For an empty line "0-1" is shown.
6662 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006663 This option is reset when 'paste' is set and restored when 'paste' is
6664 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 If you don't want to see the ruler all the time but want to know where
6666 you are, use "g CTRL-G" |g_CTRL-G|.
6667 NOTE: This option is reset when 'compatible' is set.
6668
6669 *'rulerformat'* *'ruf'*
6670'rulerformat' 'ruf' string (default empty)
6671 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 {not available when compiled without the |+statusline|
6673 feature}
6674 When this option is not empty, it determines the content of the ruler
6675 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006676 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006677 This option cannot be set in a modeline when 'modelineexpr' is off.
6678
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 The default ruler width is 17 characters. To make the ruler 15
6680 characters wide, put "%15(" at the start and "%)" at the end.
6681 Example: >
6682 :set rulerformat=%15(%c%V\ %p%%%)
6683<
6684 *'runtimepath'* *'rtp'* *vimfiles*
6685'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006686 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 $VIM/vimfiles,
6688 $VIMRUNTIME,
6689 $VIM/vimfiles/after,
6690 $HOME/.vim/after"
6691 Amiga: "home:vimfiles,
6692 $VIM/vimfiles,
6693 $VIMRUNTIME,
6694 $VIM/vimfiles/after,
6695 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006696 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 $VIM/vimfiles,
6698 $VIMRUNTIME,
6699 $VIM/vimfiles/after,
6700 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006701 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 $VIMRUNTIME,
6703 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006704 Haiku: "$BE_USER_SETTINGS/vim,
6705 $VIM/vimfiles,
6706 $VIMRUNTIME,
6707 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006708 $BE_USER_SETTINGS/vim/after"
6709 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 $VIM/vimfiles,
6711 $VIMRUNTIME,
6712 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006713 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 This is a list of directories which will be searched for runtime
6716 files:
6717 filetype.vim filetypes by file name |new-filetype|
6718 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006719 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 colors/ color scheme files |:colorscheme|
6721 compiler/ compiler files |:compiler|
6722 doc/ documentation |write-local-help|
6723 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006724 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 indent/ indent scripts |indent-expression|
6726 keymap/ key mapping files |mbyte-keymap|
6727 lang/ menu translations |:menutrans|
6728 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006729 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 plugin/ plugin scripts |write-plugin|
6731 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006732 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 syntax/ syntax files |mysyntaxfile|
6734 tutor/ files for vimtutor |tutor|
6735
6736 And any other file searched for with the |:runtime| command.
6737
6738 The defaults for most systems are setup to search five locations:
6739 1. In your home directory, for your personal preferences.
6740 2. In a system-wide Vim directory, for preferences from the system
6741 administrator.
6742 3. In $VIMRUNTIME, for files distributed with Vim.
6743 *after-directory*
6744 4. In the "after" directory in the system-wide Vim directory. This is
6745 for the system administrator to overrule or add to the distributed
6746 defaults (rarely needed)
6747 5. In the "after" directory in your home directory. This is for
6748 personal preferences to overrule or add to the distributed defaults
6749 or system-wide settings (rarely needed).
6750
Bram Moolenaard0796902016-09-16 20:02:31 +02006751 More entries are added when using |packages|. If it gets very long
6752 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6753 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006754
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6756 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006757 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 wildcards.
6759 See |:runtime|.
6760 Example: >
6761 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6762< This will use the directory "~/vimruntime" first (containing your
6763 personal Vim runtime files), then "/mygroup/vim" (shared between a
6764 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6765 files).
6766 You probably should always include $VIMRUNTIME somewhere, to use the
6767 distributed runtime files. You can put a directory before $VIMRUNTIME
6768 to find files which replace a distributed runtime files. You can put
6769 a directory after $VIMRUNTIME to find files which add to distributed
6770 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006771 When Vim is started with |--clean| the home directory entries are not
6772 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 This option cannot be set from a |modeline| or in the |sandbox|, for
6774 security reasons.
6775
6776 *'scroll'* *'scr'*
6777'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006778 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6780 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006781 changes. This may happen when enabling the |status-line| or
6782 'tabline' option after setting the 'scroll' option.
6783 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006784 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006785 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786
6787 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6788'scrollbind' 'scb' boolean (default off)
6789 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006790 See also |scroll-binding|. When this option is set, scrolling the
6791 current window also scrolls other scrollbind windows (windows that
6792 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 differences between two versions of a file, see 'diff'.
6794 See |'scrollopt'| for options that determine how this option should be
6795 interpreted.
6796 This option is mostly reset when splitting a window to edit another
6797 file. This means that ":split | edit file" results in two windows
6798 with scroll-binding, but ":split file" does not.
6799
Bram Moolenaarae20f342019-11-05 21:09:23 +01006800 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6801'scrollfocus' 'scf' boolean (default off)
6802 global
6803 {only for MS-Windows GUI}
6804 When using the scroll wheel and this option is set, the window under
6805 the mouse pointer is scrolled. With this option off the current
6806 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006807 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006808
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 *'scrolljump'* *'sj'*
6810'scrolljump' 'sj' number (default 1)
6811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 Minimal number of lines to scroll when the cursor gets off the
6813 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6814 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006815 When set to a negative number from -1 to -100 this is used as the
6816 percentage of the window height. Thus -50 scrolls half the window
6817 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 NOTE: This option is set to 1 when 'compatible' is set.
6819
6820 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006821'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006822 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 Minimal number of screen lines to keep above and below the cursor.
6824 This will make some context visible around where you are working. If
6825 you set it to a very large value (999) the cursor line will always be
6826 in the middle of the window (except at the start or end of the file or
6827 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006828 After using the local value, go back the global value with one of
6829 these two: >
6830 setlocal scrolloff<
6831 setlocal scrolloff=-1
6832< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 NOTE: This option is set to 0 when 'compatible' is set.
6834
6835 *'scrollopt'* *'sbo'*
6836'scrollopt' 'sbo' string (default "ver,jump")
6837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006839 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6840 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 The following words are available:
6842 ver Bind vertical scrolling for 'scrollbind' windows
6843 hor Bind horizontal scrolling for 'scrollbind' windows
6844 jump Applies to the offset between two windows for vertical
6845 scrolling. This offset is the difference in the first
6846 displayed line of the bound windows. When moving
6847 around in a window, another 'scrollbind' window may
6848 reach a position before the start or after the end of
6849 the buffer. The offset is not changed though, when
6850 moving back the 'scrollbind' window will try to scroll
6851 to the desired position when possible.
6852 When now making that window the current one, two
6853 things can be done with the relative offset:
6854 1. When "jump" is not included, the relative offset is
6855 adjusted for the scroll position in the new current
6856 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006857 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 2. When "jump" is included, the other windows are
6859 scrolled to keep the same relative offset. When
6860 going back to the other window, it still uses the
6861 same relative offset.
6862 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006863 When 'diff' mode is active there always is vertical scroll binding,
6864 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865
6866 *'sections'* *'sect'*
6867'sections' 'sect' string (default "SHNHH HUnhsh")
6868 global
6869 Specifies the nroff macros that separate sections. These are pairs of
6870 two letters (See |object-motions|). The default makes a section start
6871 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6872
6873 *'secure'* *'nosecure'* *E523*
6874'secure' boolean (default off)
6875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 When on, ":autocmd", shell and write commands are not allowed in
6877 ".vimrc" and ".exrc" in the current directory and map commands are
6878 displayed. Switch it off only if you know that you will not run into
6879 problems, or when the 'exrc' option is off. On Unix this option is
6880 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006881 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 'secure' at the end of your ~/.vimrc then.
6883 This option cannot be set from a |modeline| or in the |sandbox|, for
6884 security reasons.
6885
6886 *'selection'* *'sel'*
6887'selection' 'sel' string (default "inclusive")
6888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 This option defines the behavior of the selection. It is only used
6890 in Visual and Select mode.
6891 Possible values:
6892 value past line inclusive ~
6893 old no yes
6894 inclusive yes yes
6895 exclusive yes no
6896 "past line" means that the cursor is allowed to be positioned one
6897 character past the line.
6898 "inclusive" means that the last character of the selection is included
6899 in an operation. For example, when "x" is used to delete the
6900 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006901 When "old" is used and 'virtualedit' allows the cursor to move past
6902 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 Note that when "exclusive" is used and selecting from the end
6904 backwards, you cannot include the last character of a line, when
6905 starting in Normal mode and 'virtualedit' empty.
6906
6907 The 'selection' option is set by the |:behave| command.
6908
6909 *'selectmode'* *'slm'*
6910'selectmode' 'slm' string (default "")
6911 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006912 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 Select mode instead of Visual mode, when a selection is started.
6914 Possible values:
6915 mouse when using the mouse
6916 key when using shifted special keys
6917 cmd when using "v", "V" or CTRL-V
6918 See |Select-mode|.
6919 The 'selectmode' option is set by the |:behave| command.
6920
6921 *'sessionoptions'* *'ssop'*
6922'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006923 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006925 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 feature}
6927 Changes the effect of the |:mksession| command. It is a comma
6928 separated list of words. Each word enables saving and restoring
6929 something:
6930 word save and restore ~
6931 blank empty windows
6932 buffers hidden and unloaded buffers, not just those in windows
6933 curdir the current directory
6934 folds manually created folds, opened/closed folds and local
6935 fold options
6936 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006937 and contain at least one lowercase letter. Only
6938 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 help the help window
6940 localoptions options and mappings local to a window or buffer (not
6941 global values for local options)
6942 options all options and mappings (also global values for local
6943 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006944 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 resize size of the Vim window: 'lines' and 'columns'
6946 sesdir the directory in which the session file is located
6947 will become the current directory (useful with
6948 projects accessed over a network from different
6949 systems)
6950 slash backslashes in file names replaced with forward
6951 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006952 tabpages all tab pages; without this only the current tab page
6953 is restored, so that you can make a session for each
6954 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006955 terminal include terminal windows where the command can be
6956 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 unix with Unix end-of-line format (single <NL>), even when
6958 on Windows or DOS
6959 winpos position of the whole Vim window
6960 winsize window sizes
6961
6962 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006963 When neither "curdir" nor "sesdir" is included, file names are stored
6964 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006965 If you leave out "options" many things won't work well after restoring
6966 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 "slash" and "unix" are useful on Windows when sharing session files
6968 with Unix. The Unix version of Vim cannot source dos format scripts,
6969 but the Windows version of Vim can source unix format scripts.
6970
6971 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006972'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 global
6974 Name of the shell to use for ! and :! commands. When changing the
6975 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6976 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006977 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 See |option-backslash| about including spaces and backslashes.
6979 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006980
Bram Moolenaara2baa732022-02-04 16:09:54 +00006981 In |restricted-mode| shell commands will not be possible. This mode
6982 is used if the value of $SHELL ends in "false" or "nologin".
6983
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006984 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006985 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6987< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006988 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006990 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006992 Example with escaped space (Vim will do this when initializing the
6993 option from $SHELL): >
6994 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006995< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006996 backslashes are consumed by `:set`.
6997
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 Under MS-Windows, when the executable ends in ".com" it must be
6999 included. Thus setting the shell to "command.com" or "4dos.com"
7000 works, but "command" and "4dos" do not work for all commands (e.g.,
7001 filtering).
7002 For unknown reasons, when using "4dos.com" the current directory is
7003 changed to "C:\". To avoid this set 'shell' like this: >
7004 :set shell=command.com\ /c\ 4dos
7005< This option cannot be set from a |modeline| or in the |sandbox|, for
7006 security reasons.
7007
7008 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007009'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007010 Win32, when 'shell' contains "powershell":
7011 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007012 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007015 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7016 For MS-Windows, the default is set according to the value of 'shell',
7017 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007018 On Unix it can have more than one flag. Each white space separated
7019 part is passed as an argument to the shell command.
7020 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007021 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 This option cannot be set from a |modeline| or in the |sandbox|, for
7023 security reasons.
7024
7025 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007026'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7027 "2>&1| tee", or
7028 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 {not available when compiled without the |+quickfix|
7031 feature}
7032 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007033 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 including spaces and backslashes.
7035 The name of the temporary file can be represented by "%s" if necessary
7036 (the file name is appended automatically if no %s appears in the value
7037 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007038 For the Amiga the default is ">". For MS-Windows using powershell the
7039 default is "2>&1 | Out-File -Encoding default", otherwise the default
7040 is ">%s 2>&1". The output is directly saved in a file and not echoed
7041 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007042 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 in a file and echoed to the screen. If the 'shell' option is "csh" or
7044 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007045 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007046 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7047 means that stderr is also included. Before using the 'shell' option a
7048 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007049 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7050 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 The initialization of this option is done after reading the ".vimrc"
7052 and the other initializations, so that when the 'shell' option is set
7053 there, the 'shellpipe' option changes automatically, unless it was
7054 explicitly set before.
7055 When 'shellpipe' is set to an empty string, no redirection of the
7056 ":make" output will be done. This is useful if you use a 'makeprg'
7057 that writes to 'makeef' by itself. If you want no piping, but do
7058 want to include the 'makeef', set 'shellpipe' to a single space.
7059 Don't forget to precede the space with a backslash: ":set sp=\ ".
7060 In the future pipes may be used for filtering and this option will
7061 become obsolete (at least for Unix).
7062 This option cannot be set from a |modeline| or in the |sandbox|, for
7063 security reasons.
7064
7065 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007066'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 Quoting character(s), put around the command passed to the shell, for
7069 the "!" and ":!" commands. The redirection is kept outside of the
7070 quoting. See 'shellxquote' to include the redirection. It's
7071 probably not useful to set both options.
7072 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007073 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007074 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 This option cannot be set from a |modeline| or in the |sandbox|, for
7076 security reasons.
7077
7078 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007079'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7080 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 String to be used to put the output of a filter command in a temporary
7083 file. See also |:!|. See |option-backslash| about including spaces
7084 and backslashes.
7085 The name of the temporary file can be represented by "%s" if necessary
7086 (the file name is appended automatically if no %s appears in the value
7087 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007088 The default is ">". For Unix, if the 'shell' option is "csh" or
7089 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007090 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007091 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7092 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007093 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7094 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007095 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7096 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 The initialization of this option is done after reading the ".vimrc"
7098 and the other initializations, so that when the 'shell' option is set
7099 there, the 'shellredir' option changes automatically unless it was
7100 explicitly set before.
7101 In the future pipes may be used for filtering and this option will
7102 become obsolete (at least for Unix).
7103 This option cannot be set from a |modeline| or in the |sandbox|, for
7104 security reasons.
7105
7106 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7107'shellslash' 'ssl' boolean (default off)
7108 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007109 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007111 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007112 powershell.exe. Backward slashes can still be typed, but they are
7113 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 Note that setting or resetting this option has no effect for some
7115 existing file names, thus this option needs to be set before opening
7116 any file for best results. This might change in the future.
7117 'shellslash' only works when a backslash can be used as a path
7118 separator. To test if this is so use: >
7119 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007120< Also see 'completeslash'.
7121
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007122 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7123'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7124 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007125 When on, use temp files for shell commands. When off use a pipe.
7126 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007127 Currently a pipe is only supported on Unix and MS-Windows 2K and
7128 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007129 :if has("filterpipe")
7130< The advantage of using a pipe is that nobody can read the temp file
7131 and the 'shell' command does not need to support redirection.
7132 The advantage of using a temp file is that the file type and encoding
7133 can be detected.
7134 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7135 |FilterWritePost| autocommands event are not triggered when
7136 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007137 The `system()` function does not respect this option and always uses
7138 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007139 NOTE: This option is set to the Vim default value when 'compatible'
7140 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007141
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 *'shelltype'* *'st'*
7143'shelltype' 'st' number (default 0)
7144 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007145 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 On the Amiga this option influences the way how the commands work
7147 which use a shell.
7148 0 and 1: always use the shell
7149 2 and 3: use the shell only to filter lines
7150 4 and 5: use shell only for ':sh' command
7151 When not using the shell, the command is executed directly.
7152
7153 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7154 1 and 3: use "shell cmd" to start external commands
7155
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007156 *'shellxescape'* *'sxe'*
7157'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007158 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007159 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007160 When 'shellxquote' is set to "(" then the characters listed in this
7161 option will be escaped with a '^' character. This makes it possible
7162 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007163 This option cannot be set from a |modeline| or in the |sandbox|, for
7164 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007165
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 *'shellxquote'* *'sxq'*
7167'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007168 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007169 for Win32, when 'shell' is
7170 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007171 for Win32, when 'shell' contains "sh"
7172 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 for Unix, when using system(): "\"")
7174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 Quoting character(s), put around the command passed to the shell, for
7176 the "!" and ":!" commands. Includes the redirection. See
7177 'shellquote' to exclude the redirection. It's probably not useful
7178 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007179 When the value is '(' then ')' is appended. When the value is '"('
7180 then ')"' is appended.
7181 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007182 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007183 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7184 pwsh.exe which automatically strips off the first and last quote on a
7185 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7186 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007187 'shell', to reduce the need to set this option by the user. See
7188 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 This option cannot be set from a |modeline| or in the |sandbox|, for
7190 security reasons.
7191
7192 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7193'shiftround' 'sr' boolean (default off)
7194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 Round indent to multiple of 'shiftwidth'. Applies to > and <
7196 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7197 a multiple of 'shiftwidth' (this is Vi compatible).
7198 NOTE: This option is reset when 'compatible' is set.
7199
7200 *'shiftwidth'* *'sw'*
7201'shiftwidth' 'sw' number (default 8)
7202 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007203 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007205 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007206 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207
7208 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007209'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7210 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007211 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 This option helps to avoid all the |hit-enter| prompts caused by file
7213 messages, for example with CTRL-G, and to avoid some other messages.
7214 It is a list of flags:
7215 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007216 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7217 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7218 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7219 m use "[+]" instead of "[Modified]" *shm-m*
7220 n use "[New]" instead of "[New File]" *shm-n*
7221 r use "[RO]" instead of "[readonly]" *shm-r*
7222 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007224 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7225 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007226 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007227 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007229 o overwrite message for writing a file with subsequent *shm-o*
7230 message for reading a file (useful for ":wn" or when
7231 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007232 O message for reading a file overwrites any previous *shm-O*
7233 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007234 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7235 "search hit TOP, continuing at BOTTOM" messages; when using
7236 the search count do not show "W" after the count message (see
7237 S below)
7238 t truncate file message at the start if it is too long *shm-t*
7239 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007240 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007241 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007242 long to fit on the command line; "..." will appear in the
7243 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007244 W don't give "written" or "[w]" when writing a file *shm-W*
7245 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007246 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007247 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007248 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007249 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007250 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7251 match", "Pattern not found", "Back at original", etc.
7252 C don't give messages while scanning for ins-completion *shm-C*
7253 items, for instance "scanning tags"
7254 q use "recording" instead of "recording @a" *shm-q*
7255 F don't give the file info when editing a file, like *shm-F*
7256 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007257 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007258 S do not show search count message when searching, e.g. *shm-S*
7259 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260
7261 This gives you the opportunity to avoid that a change between buffers
7262 requires you to hit <Enter>, but still gives as useful a message as
7263 possible for the space available. To get the whole message that you
7264 would have got with 'shm' empty, use ":file!"
7265 Useful values:
7266 shm= No abbreviation of message.
7267 shm=a Abbreviation, but no loss of information.
7268 shm=at Abbreviation, and truncate message when necessary.
7269
7270 NOTE: This option is set to the Vi default value when 'compatible' is
7271 set and to the Vim default value when 'compatible' is reset.
7272
7273 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7274'shortname' 'sn' boolean (default off)
7275 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 Filenames are assumed to be 8 characters plus one extension of 3
7277 characters. Multiple dots in file names are not allowed. When this
7278 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007279 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007281 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282
7283 *'showbreak'* *'sbr'* *E595*
7284'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007285 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007286 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 feature}
7288 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007289 values are "> " or "+++ ": >
7290 :set showbreak=>\
7291< Note the backslash to escape the trailing space. It's easier like
7292 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007293 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007294< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 comma (in a future version the comma might be used to separate the
7296 part that is shown at the end and at the start of a line).
7297 The characters are highlighted according to the '@' flag in
7298 'highlight'.
7299 Note that tabs after the showbreak will be displayed differently.
7300 If you want the 'showbreak' to appear in between line numbers, add the
7301 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007302 A window-local value overrules a global value. If the global value is
7303 set and you want no value in the current window use NONE: >
7304 :setlocal showbreak=NONE
7305<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007307'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7308 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007310 Show (partial) command in the last line of the screen. Set this
7311 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 In Visual mode the size of the selected area is shown:
7313 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007314 If the number of bytes is different it is also displayed: "2-6"
7315 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007317 - When selecting a block, the size in screen characters:
7318 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007319 This information can be displayed in an alternative location using the
7320 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 NOTE: This option is set to the Vi default value when 'compatible' is
7322 set and to the Vim default value when 'compatible' is reset.
7323
Luuk van Baalba936f62022-12-15 13:15:39 +00007324 *'showcmdloc'* *'sloc'*
7325'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007326 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007327 This option can be used to display the (partially) entered command in
7328 another location. Possible values are:
7329 last Last line of the screen (default).
7330 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007331 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007332 Setting this option to "statusline" or "tabline" means that these will
7333 be redrawn whenever the command changes, which can be on every key
7334 pressed.
7335 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7336 place the text. Without a custom 'statusline' or 'tabline' it will be
7337 displayed in a convenient location.
7338
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7340'showfulltag' 'sft' boolean (default off)
7341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 When completing a word in insert mode (see |ins-completion|) from the
7343 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007344 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 matched a C function, you can see a template for what arguments are
7346 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007347 Note that this doesn't work well together with having "longest" in
7348 'completeopt', because the completion from the search pattern may not
7349 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350
7351 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7352'showmatch' 'sm' boolean (default off)
7353 global
7354 When a bracket is inserted, briefly jump to the matching one. The
7355 jump is only done if the match can be seen on the screen. The time to
7356 show the match can be set with 'matchtime'.
7357 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007358 seen or not).
7359 This option is reset when 'paste' is set and restored when 'paste' is
7360 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 When the 'm' flag is not included in 'cpoptions', typing a character
7362 will immediately move the cursor back to where it belongs.
7363 See the "sm" field in 'guicursor' for setting the cursor shape and
7364 blinking when showing the match.
7365 The 'matchpairs' option can be used to specify the characters to show
7366 matches for. 'rightleft' and 'revins' are used to look for opposite
7367 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007368 Also see the matchparen plugin for highlighting the match when moving
7369 around |pi_paren.txt|.
7370 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371
7372 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7373'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7374 global
7375 If in Insert, Replace or Visual mode put a message on the last line.
7376 Use the 'M' flag in 'highlight' to set the type of highlighting for
7377 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007378 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 doesn't mean XIM is really active, especially when 'imactivatekey' is
7380 not set.
7381 NOTE: This option is set to the Vi default value when 'compatible' is
7382 set and to the Vim default value when 'compatible' is reset.
7383
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007384 *'showtabline'* *'stal'*
7385'showtabline' 'stal' number (default 1)
7386 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007387 The value of this option specifies when the line with tab page labels
7388 will be displayed:
7389 0: never
7390 1: only if there are at least two tab pages
7391 2: always
7392 This is both for the GUI and non-GUI implementation of the tab pages
7393 line.
7394 See |tab-page| for more information about tab pages.
7395
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 *'sidescroll'* *'ss'*
7397'sidescroll' 'ss' number (default 0)
7398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 The minimal number of columns to scroll horizontally. Used only when
7400 the 'wrap' option is off and the cursor is moved off of the screen.
7401 When it is zero the cursor will be put in the middle of the screen.
7402 When using a slow terminal set it to a large number or 0. When using
7403 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7404 commands.
7405
7406 *'sidescrolloff'* *'siso'*
7407'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007408 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007410 right of the cursor if 'nowrap' is set. Setting this option to a
7411 value greater than 0 while having |'sidescroll'| also at a non-zero
7412 value makes some context visible in the line you are scrolling in
7413 horizontally (except at beginning of the line). Setting this option
7414 to a large value (like 999) has the effect of keeping the cursor
7415 horizontally centered in the window, as long as one does not come too
7416 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007417 After using the local value, go back the global value with one of
7418 these two: >
7419 setlocal sidescrolloff<
7420 setlocal sidescrolloff=-1
7421< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422
7423 Example: Try this together with 'sidescroll' and 'listchars' as
7424 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007425 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426
7427 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7428 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007429<
7430 *'signcolumn'* *'scl'*
7431'signcolumn' 'scl' string (default "auto")
7432 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007433 {not available when compiled without the |+signs|
7434 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007435 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007436 "auto" only when there is a sign to display
7437 "no" never
7438 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007439 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007440 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7443'smartcase' 'scs' boolean (default off)
7444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 Override the 'ignorecase' option if the search pattern contains upper
7446 case characters. Only used when the search pattern is typed and
7447 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007448 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7450 recalling the search pattern from history and hitting <Enter>.
7451 NOTE: This option is reset when 'compatible' is set.
7452
7453 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7454'smartindent' 'si' boolean (default off)
7455 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 Do smart autoindenting when starting a new line. Works for C-like
7457 programs, but can also be used for other languages. 'cindent' does
7458 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007459 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007460 setting 'si' has no effect. 'indentexpr' is a more advanced
7461 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 Normally 'autoindent' should also be on when using 'smartindent'.
7463 An indent is automatically inserted:
7464 - After a line ending in '{'.
7465 - After a line starting with a keyword from 'cinwords'.
7466 - Before a line starting with '}' (only with the "O" command).
7467 When typing '}' as the first character in a new line, that line is
7468 given the same indent as the matching '{'.
7469 When typing '#' as the first character in a new line, the indent for
7470 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007471 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7473 When using the ">>" command, lines starting with '#' are not shifted
7474 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007475 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007476 This option is reset when 'paste' is set and restored when 'paste' is
7477 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478
7479 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7480'smarttab' 'sta' boolean (default off)
7481 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007483 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7484 <BS> will delete a 'shiftwidth' worth of space at the start of the
7485 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007486 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007487 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7488 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007489 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007491 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007492 This option is reset when 'paste' is set and restored when 'paste' is
7493 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 NOTE: This option is reset when 'compatible' is set.
7495
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007496 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7497'smoothscroll' 'sms' boolean (default off)
7498 local to window
7499 Scrolling works with screen lines. When 'wrap' is set and the first
7500 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007501 above the window. "<<<" is displayed at the start of the first line,
7502 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007503 You may also want to add "lastline" to the 'display' option to show as
7504 much of the last line as possible.
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007505 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
7506 and scrolling with the mouse.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007507
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 *'softtabstop'* *'sts'*
7509'softtabstop' 'sts' number (default 0)
7510 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 Number of spaces that a <Tab> counts for while performing editing
7512 operations, like inserting a <Tab> or using <BS>. It "feels" like
7513 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7514 used. This is useful to keep the 'ts' setting at its standard value
7515 of 8, while being able to edit like it is set to 'sts'. However,
7516 commands like "x" still work on the actual characters.
7517 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007518 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007519 'softtabstop' is set to 0 when the 'paste' option is set and restored
7520 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7522 spaces is minimized by using <Tab>s.
7523 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7524 set.
7525 NOTE: This option is set to 0 when 'compatible' is set.
7526
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007527 If Vim is compiled with the |+vartabs| feature then the value of
7528 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7529 anything other than an empty string.
7530
Bram Moolenaar217ad922005-03-20 22:37:15 +00007531 *'spell'* *'nospell'*
7532'spell' boolean (default off)
7533 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007534 {not available when compiled without the |+syntax|
7535 feature}
7536 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007537 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007538
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007539 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007540'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007541 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007542 {not available when compiled without the |+syntax|
7543 feature}
7544 Pattern to locate the end of a sentence. The following word will be
7545 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007546 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007547 When this check is not wanted make this option empty.
7548 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007549 Be careful with special characters, see |option-backslash| about
7550 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007551 To set this option automatically depending on the language, see
7552 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007553
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007554 *'spellfile'* *'spf'*
7555'spellfile' 'spf' string (default empty)
7556 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007557 {not available when compiled without the |+syntax|
7558 feature}
7559 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007560 commands. It must end in ".{encoding}.add". You need to include the
7561 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007562 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007563 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007564 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007565 |zg| and |zw| commands can be used to access each. This allows using
7566 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007567 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007568 you: Using the first directory in 'runtimepath' that is writable. If
7569 there is no "spell" directory yet it will be created. For the file
7570 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007571 ignoring the region.
7572 The resulting ".spl" file will be used for spell checking, it does not
7573 have to appear in 'spelllang'.
7574 Normally one file is used for all regions, but you can add the region
7575 name if you want to. However, it will then only be used when
7576 'spellfile' is set to it, for entries in 'spelllang' only files
7577 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007578 This option cannot be set from a |modeline| or in the |sandbox|, for
7579 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007580
Bram Moolenaar217ad922005-03-20 22:37:15 +00007581 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007582'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007583 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007584 {not available when compiled without the |+syntax|
7585 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007586 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007587 on spellchecking will be done for these languages. Example: >
7588 set spelllang=en_us,nl,medical
7589< This means US English, Dutch and medical words are recognized. Words
7590 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007591 The word list name must consist of alphanumeric characters, a dash or
7592 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007593 recommended to separate the two letter language name from a
7594 specification. Thus "en-rare" is used for rare English words.
7595 A region name must come last and have the form "_xx", where "xx" is
7596 the two-letter, lower case region name. You can use more than one
7597 region by listing them: "en_us,en_ca" supports both US and Canadian
7598 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007599 Britain. (Note: currently en_au and en_nz dictionaries are older than
7600 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007601 If the name "cjk" is included East Asian characters are excluded from
7602 spell checking. This is useful when editing text that also has Asian
7603 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007604 Note that the "medical" dictionary does not exist, it is just an
7605 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007606 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007607 As a special case the name of a .spl file can be given as-is. The
7608 first "_xx" in the name is removed and used as the region name
7609 (_xx is an underscore, two letters and followed by a non-letter).
7610 This is mainly for testing purposes. You must make sure the correct
7611 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007612 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007613 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7614 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007615 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007616
Bram Moolenaar98692072006-02-04 00:57:42 +00007617 If the |spellfile.vim| plugin is active and you use a language name
7618 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7619 will ask you if you want to download the file.
7620
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007621 After this option has been set successfully, Vim will source the files
7622 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007623 up to the first character that is not an ASCII letter or number and
7624 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007625
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007626 *'spelloptions'* *'spo'*
7627'spelloptions' 'spo' string (default "")
7628 local to buffer
7629 {not available when compiled without the |+syntax|
7630 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007631 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007632 camel When a word is CamelCased, assume "Cased" is a
7633 separate word: every upper-case character in a word
7634 that comes after a lower case character indicates the
7635 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007636
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007637 *'spellsuggest'* *'sps'*
7638'spellsuggest' 'sps' string (default "best")
7639 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007640 {not available when compiled without the |+syntax|
7641 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007642 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007643 the |spellsuggest()| function. This is a comma-separated list of
7644 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007645
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007646 best Internal method that works best for English. Finds
7647 changes like "fast" and uses a bit of sound-a-like
7648 scoring to improve the ordering.
7649
7650 double Internal method that uses two methods and mixes the
7651 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007652 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007653 word. That only works when the language specifies
7654 sound folding. Can be slow and doesn't always give
7655 better results.
7656
7657 fast Internal method that only checks for simple changes:
7658 character inserts/deletes/swaps. Works well for
7659 simple typing mistakes.
7660
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007661 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007662 Not used for |spellsuggest()|. The number of
7663 suggestions is never more than the value of 'lines'
7664 minus two.
7665
Bram Moolenaar585ee072022-01-29 11:22:17 +00007666 timeout:{millisec} Limit the time searching for suggestions to
7667 {millisec} milli seconds. Applies to the following
7668 methods. When omitted the limit is 5000. When
7669 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007670 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007671
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007672 file:{filename} Read file {filename}, which must have two columns,
7673 separated by a slash. The first column contains the
7674 bad word, the second column the suggested good word.
7675 Example:
7676 theribal/terrible ~
7677 Use this for common mistakes that do not appear at the
7678 top of the suggestion list with the internal methods.
7679 Lines without a slash are ignored, use this for
7680 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007681 The word in the second column must be correct,
7682 otherwise it will not be used. Add the word to an
7683 ".add" file if it is currently flagged as a spelling
7684 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007685 The file is used for all languages.
7686
7687 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007688 trouble with spaces. Best is to call a function
7689 without arguments, see |expr-option-function|.
7690 |v:val| holds the badly spelled word. The expression
7691 must evaluate to a List of Lists, each with a
7692 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007693 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007694 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007695 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007696 internal methods use. A lower score is better.
7697 This may invoke |spellsuggest()| if you temporarily
7698 set 'spellsuggest' to exclude the "expr:" part.
7699 Errors are silently ignored, unless you set the
7700 'verbose' option to a non-zero value.
7701
7702 Only one of "best", "double" or "fast" may be used. The others may
7703 appear several times in any order. Example: >
7704 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7705<
7706 This option cannot be set from a |modeline| or in the |sandbox|, for
7707 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007708
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7710'splitbelow' 'sb' boolean (default off)
7711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 When on, splitting a window will put the new window below the current
7713 one. |:split|
7714
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007715 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007716'splitkeep' 'spk' string (default "cursor")
7717 global
7718 The value of this option determines the scroll behavior when opening,
7719 closing or resizing horizontal splits.
7720
7721 Possible values are:
7722 cursor Keep the same relative cursor position.
7723 screen Keep the text on the same screen line.
7724 topline Keep the topline the same.
7725
7726 For the "screen" and "topline" values, the cursor position will be
7727 changed when necessary. In this case, the jumplist will be populated
7728 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007729 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007730
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7732'splitright' 'spr' boolean (default off)
7733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 When on, splitting a window will put the new window right of the
7735 current one. |:vsplit|
7736
7737 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7738'startofline' 'sol' boolean (default on)
7739 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007741 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007742 (if possible). This applies to the commands:
7743 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7744 - "d", "<<" and ">>" with a linewise operator
7745 - "%" with a count
7746 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7747 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748 In case of buffer changing commands the cursor is placed at the column
7749 where it was the last time the buffer was edited.
7750 NOTE: This option is set when 'compatible' is set.
7751
Bram Moolenaar00654022011-02-25 14:42:19 +01007752 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007754 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 {not available when compiled without the |+statusline|
7756 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007757 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 Also see |status-line|.
7759
7760 The option consists of printf style '%' items interspersed with
7761 normal text. Each status line item is of the form:
7762 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007763 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007764 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765
Bram Moolenaar238a5642006-02-21 22:12:05 +00007766 When the option starts with "%!" then it is used as an expression,
7767 evaluated and the result is used as the option value. Example: >
7768 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007769< The *g:statusline_winid* variable will be set to the |window-ID| of the
7770 window that the status line belongs to.
7771 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007772 Note that the "%!" expression is evaluated in the context of the
7773 current window and buffer, while %{} items are evaluated in the
7774 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007775
7776 When there is error while evaluating the option then it will be made
7777 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007778 When the result contains unprintable characters the result is
7779 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007780
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781 Note that the only effect of 'ruler' when this option is set (and
7782 'laststatus' is 2) is controlling the output of |CTRL-G|.
7783
7784 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007785 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007787 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 minwid Minimum width of the item, padding as set by '-' & '0'.
7789 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007790 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 on the left for text items. Numeric items will be
7792 shifted down to maxwid-2 digits followed by '>'number
7793 where number is the amount of missing digits, much like
7794 an exponential notation.
7795 item A one letter code as described below.
7796
7797 Following is a description of the possible statusline items. The
7798 second character in "item" is the type:
7799 N for number
7800 S for string
7801 F for flags as described below
7802 - not applicable
7803
7804 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007805 f S Path to the file in the buffer, as typed or relative to current
7806 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 F S Full path to the file in the buffer.
7808 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007809 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007810 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007811 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007813 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007814 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007815 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007817 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007819 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7821 being used: "<keymap>"
7822 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007823 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 B N As above, in hexadecimal.
7825 o N Byte number in file of byte under cursor, first byte is 1.
7826 Mnemonic: Offset from start of file (with one added)
7827 {not available when compiled without |+byte_offset| feature}
7828 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007829 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 l N Line number.
7831 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007832 c N Column number (byte index).
7833 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007834 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 p N Percentage through file in lines as in |CTRL-G|.
7836 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007837 percentage described for 'ruler'. Always 3 in length, unless
7838 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007839 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007840 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007842 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007843 Note that there is no '%' before the closing '}'. The
7844 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007845 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007846 {% - This is almost same as { except the result of the expression is
7847 re-evaluated as a statusline format string. Thus if the
7848 return value of expr contains % items they will get expanded.
7849 The expression can contain the } character, the end of
7850 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007851 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007852 func! Stl_filename() abort
7853 return "%t"
7854 endfunc
7855< `stl=%{Stl_filename()}` results in `"%t"`
7856 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007857 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 ( - Start of item group. Can be used for setting the width and
7859 alignment of a section. Must be followed by %) somewhere.
7860 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007861 T N For 'tabline': start of tab page N label. Use %T after the last
7862 label. This information is used for mouse clicks.
7863 X N For 'tabline': start of close tab N label. Use %X after the
7864 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7865 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866 < - Where to truncate line if too long. Default is at the start.
7867 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007868 = - Separation point between alignment sections. Each section will
7869 be separated by an equal number of spaces. With one %= what
7870 comes after it will be right-aligned. With two %= there is a
7871 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007873 # - Set highlight group. The name must follow and then a # again.
7874 Thus use %#HLname# for highlight group HLname. The same
7875 highlighting is used, also for the statusline of non-current
7876 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007878 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007879 The difference between User{N} and StatusLine will be applied to
7880 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 The number N must be between 1 and 9. See |hl-User1..9|
7882
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007883 When displaying a flag, Vim removes the leading comma, if any, when
7884 that flag comes right after plaintext. This will make a nice display
7885 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886
Bram Moolenaar582fd852005-03-28 20:58:01 +00007887 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 not set) and a minwid is not set for the group, the whole group will
7889 become empty. This will make a group like the following disappear
7890 completely from the statusline when none of the flags are set. >
7891 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007892< Beware that an expression is evaluated each and every time the status
7893 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007894 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007895 While evaluating %{} the current buffer and current window will be set
7896 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007897 currently being drawn. The expression will evaluate in this context.
7898 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7899 real current buffer and "g:actual_curwin" to the |window-ID| of the
7900 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007901
Bram Moolenaar30b65812012-07-12 22:01:11 +02007902 The 'statusline' option will be evaluated in the |sandbox| if set from
7903 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007904 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007905
7906 It is not allowed to change text or jump to another window while
7907 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908
7909 If the statusline is not updated when you want it (e.g., after setting
7910 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007911 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007913 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 Otherwise the result is taken as flag text and applied to the rules
7915 described above.
7916
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007917 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007919 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920
7921 Examples:
7922 Emulate standard status line with 'ruler' set >
7923 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7924< Similar, but add ASCII value of char under the cursor (like "ga") >
7925 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7926< Display byte count and byte value, modified flag in red. >
7927 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7928 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7929< Display a ,GZ flag if a compressed file is loaded >
7930 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7931< In the |:autocmd|'s: >
7932 :let b:gzflag = 1
7933< And: >
7934 :unlet b:gzflag
7935< And define this function: >
7936 :function VarExists(var, val)
7937 : if exists(a:var) | return a:val | else | return '' | endif
7938 :endfunction
7939<
7940 *'suffixes'* *'su'*
7941'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 Files with these suffixes get a lower priority when multiple files
7944 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007945 suffixes. Spaces after the comma are ignored. A dot is also seen as
7946 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 separator, precede it with a backslash (see |option-backslash| about
7948 including spaces and backslashes).
7949 See 'wildignore' for completely ignoring files.
7950 The use of |:set+=| and |:set-=| is preferred when adding or removing
7951 suffixes from the list. This avoids problems when a future version
7952 uses another default.
7953
7954 *'suffixesadd'* *'sua'*
7955'suffixesadd' 'sua' string (default "")
7956 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007957 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 file for the "gf", "[I", etc. commands. Example: >
7959 :set suffixesadd=.java
7960<
7961 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7962'swapfile' 'swf' boolean (default on)
7963 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007964 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 swapfile is not wanted for a specific buffer. For example, with
7966 confidential information that even root must not be able to access.
7967 Careful: All text will be in memory:
7968 - Don't use this for big files.
7969 - Recovery will be impossible!
7970 A swapfile will only be present when |'updatecount'| is non-zero and
7971 'swapfile' is set.
7972 When 'swapfile' is reset, the swap file for the current buffer is
7973 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7974 non-zero, a swap file is immediately created.
7975 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007976 If you want to open a new buffer without creating a swap file for it,
7977 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007978 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979
7980 This option is used together with 'bufhidden' and 'buftype' to
7981 specify special kinds of buffers. See |special-buffers|.
7982
7983 *'swapsync'* *'sws'*
7984'swapsync' 'sws' string (default "fsync")
7985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007987 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 When this option is empty parts of the swap file may be in memory and
7989 not written to disk. When the system crashes you may lose more work.
7990 On Unix the system does a sync now and then without Vim asking for it,
7991 so the disadvantage of setting this option off is small. On some
7992 systems the swap file will not be written at all. For a unix system
7993 setting it to "sync" will use the sync() call instead of the default
7994 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007995 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996
7997 *'switchbuf'* *'swb'*
7998'switchbuf' 'swb' string (default "")
7999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008001 This option is checked, when
8002 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008003 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008004 - jumping to a tag using the |:stag| command.
8005 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8006 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8007 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008008 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008009 useopen If included, jump to the first open window in the
8010 current tab page that contains the specified buffer
8011 (if there is one). Otherwise: Do not examine other
8012 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008013 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008014 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008016 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008017 Otherwise: do not split, use current window (when used
8018 in the quickfix window: the previously used window or
8019 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008020 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008021 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008022 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008023 uselast If included, jump to the previously used window when
8024 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008025 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8026 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008028 *'synmaxcol'* *'smc'*
8029'synmaxcol' 'smc' number (default 3000)
8030 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008031 {not available when compiled without the |+syntax|
8032 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008033 Maximum column in which to search for syntax items. In long lines the
8034 text after this column is not highlighted and following lines may not
8035 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008036 This helps to avoid very slow redrawing for an XML file that is one
8037 long line.
8038 Set to zero to remove the limit.
8039
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040 *'syntax'* *'syn'*
8041'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008042 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 {not available when compiled without the |+syntax|
8044 feature}
8045 When this option is set, the syntax with this name is loaded, unless
8046 syntax highlighting has been switched off with ":syntax off".
8047 Otherwise this option does not always reflect the current syntax (the
8048 b:current_syntax variable does).
8049 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008050 not automatically recognized. Example, in an IDL file:
8051 /* vim: set syntax=idl : */ ~
8052 When a dot appears in the value then this separates two filetype
8053 names. Example:
8054 /* vim: set syntax=c.doxygen : */ ~
8055 This will use the "c" syntax first, then the "doxygen" syntax.
8056 Note that the second one must be prepared to be loaded as an addition,
8057 otherwise it will be skipped. More than one dot may appear.
8058 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 :set syntax=OFF
8060< To switch syntax highlighting on according to the current value of the
8061 'filetype' option: >
8062 :set syntax=ON
8063< What actually happens when setting the 'syntax' option is that the
8064 Syntax autocommand event is triggered with the value as argument.
8065 This option is not copied to another buffer, independent of the 's' or
8066 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008067 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008069 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008070'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008071 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008072 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008073 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008074 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008075
8076 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008077 option and only when there is no GUI tab line. When 'e' is in
8078 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008079 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008080
8081 The value is evaluated like with 'statusline'. You can use
8082 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008083 the text to be displayed. Use "%1T" for the first label, "%2T" for
8084 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008085
Bram Moolenaare12bab32019-01-08 22:02:56 +01008086 When changing something that is used in 'tabline' that does not
8087 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008088 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008089
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008090 Keep in mind that only one of the tab pages is the current one, others
8091 are invisible and you can't jump to their windows.
8092
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008093 *'tabpagemax'* *'tpm'*
8094'tabpagemax' 'tpm' number (default 10)
8095 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008096 Maximum number of tab pages to be opened by the |-p| command line
8097 argument or the ":tab all" command. |tabpage|
8098
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008099 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008100'tabstop' 'ts' number (default 8)
8101 local to buffer
8102 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008103 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104
8105 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008106 appear wrong in many places, e.g., when printing it.
8107 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108
8109 There are four main ways to use tabs in Vim:
8110 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8111 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008112 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008114 This is the recommended way, the file will look the same with other
8115 tools and when listing it in a terminal.
8116 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8117 'expandtab'. This way you will always insert spaces. The
8118 formatting will never be messed up when 'tabstop' is changed (leave
8119 it at 8 just in case). The file will be a bit larger.
8120 You do need to check if no Tabs exist in the file. You can get rid
8121 of them by first setting 'expandtab' and using `%retab!`, making
8122 sure the value of 'tabstop' is set correctly.
8123 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 'expandtab'. This way you will always insert spaces. The
8125 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008126 You do need to check if no Tabs exist in the file, just like in the
8127 item just above.
8128 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008129 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008130 works when using Vim to edit the file, other tools assume a tabstop
8131 is worth 8 spaces.
8132 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 'noexpandtab'. This should then work (for initial indents only)
8134 for any tabstop setting that people use. It might be nice to have
8135 tabs after the first non-blank inserted as spaces if you do this
8136 though. Otherwise aligned comments will be wrong when 'tabstop' is
8137 changed.
8138
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008139 If Vim is compiled with the |+vartabs| feature then the value of
8140 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8141 than an empty string.
8142
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8144'tagbsearch' 'tbs' boolean (default on)
8145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008147 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 searching makes searching for a tag a LOT faster, but a linear search
8149 will find more tags if the tags file wasn't properly sorted.
8150 Vim normally assumes that your tags files are sorted, or indicate that
8151 they are not sorted. Only when this is not the case does the
8152 'tagbsearch' option need to be switched off.
8153
8154 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008155 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 certain files, or retry all files with a linear search. When
8157 'tagbsearch' is off, only a linear search is done.
8158
8159 Linear searching is done anyway, for one file, when Vim finds a line
8160 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008161 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162< [The whitespace before and after the '0' must be a single <Tab>]
8163
8164 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008165 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166 instead of a normal tag name, a retry is done with a linear search.
8167 Tags in unsorted tags files, and matches with different case will only
8168 be found in the retry.
8169
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008170 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008171 linear search can be avoided when case is ignored. Use a value of '2'
8172 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8173 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008174 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8175 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8176 used for this as well. Note that case must be folded to uppercase for
8177 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008178
8179 By default, tag searches are case-sensitive. Case is ignored when
8180 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8181 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008182 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8183 'tagcase' is "smart", and the pattern contains only lowercase
8184 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185
8186 When 'tagbsearch' is off, tags searching is slower when a full match
8187 exists, but faster when no full match exists. Tags in unsorted tags
8188 files may only be found with 'tagbsearch' off.
8189 When the tags file is not sorted, or sorted in a wrong way (not on
8190 ASCII byte value), 'tagbsearch' should be off, or the line given above
8191 must be included in the tags file.
8192 This option doesn't affect commands that find all matching tags (e.g.,
8193 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008195 *'tagcase'* *'tc'*
8196'tagcase' 'tc' string (default "followic")
8197 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008198 This option specifies how case is handled when searching the tags
8199 file:
8200 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008201 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008202 ignore Ignore case
8203 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008204 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008205 NOTE: This option is set to the Vi default value when 'compatible' is
8206 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008207
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008208 *'tagfunc'* *'tfu'*
8209'tagfunc' 'tfu' string (default: empty)
8210 local to buffer
8211 {not available when compiled without the |+eval|
8212 feature}
8213 This option specifies a function to be used to perform tag searches.
8214 The function gets the tag pattern and should return a List of matching
8215 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008216 function and an example. The value can be the name of a function, a
8217 |lambda| or a |Funcref|. See |option-value-function| for more
8218 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008219 This option cannot be set from a |modeline| or in the |sandbox|, for
8220 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008221
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 *'taglength'* *'tl'*
8223'taglength' 'tl' number (default 0)
8224 global
8225 If non-zero, tags are significant up to this number of characters.
8226
8227 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8228'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8229 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008230 If on and using a tags file in another directory, file names in that
8231 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 NOTE: This option is set to the Vi default value when 'compatible' is
8233 set and to the Vim default value when 'compatible' is reset.
8234
8235 *'tags'* *'tag'* *E433*
8236'tags' 'tag' string (default "./tags,tags", when compiled with
8237 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8238 global or local to buffer |global-local|
8239 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008240 include a space or comma in a file name, precede it with backslashes
8241 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 When a file name starts with "./", the '.' is replaced with the path
8243 of the current file. But only when the 'd' flag is not included in
8244 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8245 |tags-option|.
8246 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008247 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8248 find all files named "tags" below "/lib". The filename itself cannot
8249 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008250 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008251 The |tagfiles()| function can be used to get a list of the file names
8252 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8254 files are also supported. They are automatically recognized. The
8255 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8256 differences are ignored (MS-Windows). |emacs-tags|
8257 The use of |:set+=| and |:set-=| is preferred when adding or removing
8258 file names from the list. This avoids problems when a future version
8259 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260
8261 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8262'tagstack' 'tgst' boolean (default on)
8263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264 When on, the |tagstack| is used normally. When off, a ":tag" or
8265 ":tselect" command with an argument will not push the tag onto the
8266 tagstack. A following ":tag" without an argument, a ":pop" command or
8267 any other command that uses the tagstack will use the unmodified
8268 tagstack, but does change the pointer to the active entry.
8269 Resetting this option is useful when using a ":tag" command in a
8270 mapping which should not change the tagstack.
8271
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008272 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008273'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008274 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008275 {only available when compiled with the |+tcl/dyn|
8276 feature}
8277 Specifies the name of the Tcl shared library. The default is
8278 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008279 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008280 This option cannot be set from a |modeline| or in the |sandbox|, for
8281 security reasons.
8282
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 *'term'* *E529* *E530* *E531*
8284'term' string (default is $TERM, if that fails:
8285 in the GUI: "builtin_gui"
8286 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008287 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 on Unix: "ansi"
8290 on VMS: "ansi"
8291 on Win 32: "win32")
8292 global
8293 Name of the terminal. Used for choosing the terminal control
8294 characters. Environment variables are expanded |:set_env|.
8295 For example: >
8296 :set term=$TERM
8297< See |termcap|.
8298
8299 *'termbidi'* *'tbidi'*
8300 *'notermbidi'* *'notbidi'*
8301'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 {only available when compiled with the |+arabic|
8304 feature}
8305 The terminal is in charge of Bi-directionality of text (as specified
8306 by Unicode). The terminal is also expected to do the required shaping
8307 that some languages (such as Arabic) require.
8308 Setting this option implies that 'rightleft' will not be set when
8309 'arabic' is set and the value of 'arabicshape' will be ignored.
8310 Note that setting 'termbidi' has the immediate effect that
8311 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8312 This option is reset when the GUI is started.
8313 For further details see |arabic.txt|.
8314
8315 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008316'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 Encoding used for the terminal. This specifies what character
8319 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008320 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008321 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008322 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008323 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8325 Any attempts to set a different value will be rejected, and an error
8326 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008327 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008328 because the Win32 system always passes Unicode characters.
8329 When empty, the same encoding is used as for the 'encoding' option.
8330 This is the normal value.
8331 Not all combinations for 'termencoding' and 'encoding' are valid. See
8332 |encoding-table|.
8333 The value for this option must be supported by internal conversions or
8334 iconv(). When this is not possible no conversion will be done and you
8335 will probably experience problems with non-ASCII characters.
8336 Example: You are working with the locale set to euc-jp (Japanese) and
8337 want to edit a UTF-8 file: >
8338 :let &termencoding = &encoding
8339 :set encoding=utf-8
8340< You need to do this when your system has no locale support for UTF-8.
8341
Bram Moolenaar938ae282023-02-20 20:44:55 +00008342 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008343'termguicolors' 'tgc' boolean (default off)
8344 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008345 {not available when compiled without the
8346 |+termguicolors| feature}
8347 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008348 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008349
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008350 Requires a ISO-8613-3 compatible terminal. If setting this option
8351 does not work (produces a colorless UI) reading |xterm-true-color|
8352 might help.
8353
8354 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8355 is required. Use this check to find out: >
8356 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008357< This requires Vim to be built with the |+vtp| feature.
8358
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008359 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008360
8361 When using Vim with Windows Terminal, the background of Windows
8362 Terminal is normally filled with the Vim background color. Setting
8363 'termguicolors' and the guibg of the Normal highlight group to NONE
8364 will make the background transparent: >
8365 :hi Normal guibg=NONE
8366<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008367 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008368
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008369 *'termwinkey'* *'twk'*
8370'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008371 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008372 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008373 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008374 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008375 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008376< The string must be one key stroke but can be multiple bytes.
8377 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008378 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008379 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008380
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008381 *'termwinscroll'* *'twsl'*
8382'termwinscroll' 'twsl' number (default 10000)
8383 local to buffer
8384 {not available when compiled without the
8385 |+terminal| feature}
8386 Number of scrollback lines to keep. When going over this limit the
8387 first 10% of the scrollback lines are deleted. This is just to reduce
8388 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008389 Also used as a limit for text sent to the terminal in one write,
8390 multiplied by the number of columns times 3 (average number of bytes
8391 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008392
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008393 *'termwinsize'* *'tws'*
8394'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008395 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008396 Size used when opening the |terminal| window. Format:
8397 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008398 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008399 - When set with a "x" (e.g., "24x80") the terminal size is not
8400 adjusted to the window size. If the window is smaller only the
8401 top-left part is displayed.
8402 - When set with a "*" (e.g., "10*50") the terminal size follows the
8403 window size, but will not be smaller than the specified rows and/or
8404 columns.
8405 - When rows is zero then use the height of the window.
8406 - When columns is zero then use the width of the window.
8407 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008408 - Can be overruled in the |term_start()| options with "term_rows" and
8409 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008410
8411 Examples:
8412 "30x0" uses 30 rows and the current window width.
8413 "20*0" uses at least 20 rows and the current window width.
8414 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008415 Note that the command running in the terminal window may still change
8416 the size of the terminal. In that case the Vim window will be
8417 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008418
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008419 *'termwintype'* *'twt'*
8420'termwintype' 'twt' string (default "")
8421 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008422 {only available when compiled with the |terminal|
8423 feature on MS-Windows}
8424 Specify the virtual console (pty) used when opening the terminal
8425 window.
8426
8427 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008428 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008429 "winpty" use winpty, fail if not supported
8430 "conpty" use |ConPTY|, fail if not supported
8431
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008432 |ConPTY| support depends on the platform. Windows 10 October 2018
8433 Update is the first version that supports ConPTY, however it is still
8434 considered unstable. ConPTY might become stable in the next release
8435 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008436 supported then you cannot open a terminal window.
8437
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 *'terse'* *'noterse'*
8439'terse' boolean (default off)
8440 global
8441 When set: Add 's' flag to 'shortmess' option (this makes the message
8442 for a search that hits the start or end of the file not being
8443 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8444 shortens a lot of messages}
8445
8446 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8447'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8448 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 This option is obsolete. Use 'fileformats'.
8450 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8451 set to the default value for the current system. When 'textauto' is
8452 reset, 'fileformats' is made empty.
8453 NOTE: This option is set to the Vi default value when 'compatible' is
8454 set and to the Vim default value when 'compatible' is reset.
8455
8456 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008457'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 others: default off)
8459 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008460 This option is obsolete. Use 'fileformat'.
8461 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8462 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8463 "unix".
8464
8465 *'textwidth'* *'tw'*
8466'textwidth' 'tw' number (default 0)
8467 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 Maximum width of text that is being inserted. A longer line will be
8469 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008470 this.
8471 'textwidth' is set to 0 when the 'paste' option is set and restored
8472 when 'paste' is reset.
8473 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008475 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 NOTE: This option is set to 0 when 'compatible' is set.
8477
8478 *'thesaurus'* *'tsr'*
8479'thesaurus' 'tsr' string (default "")
8480 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008482 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8483 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008484
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008485 This option is not used if 'thesaurusfunc' is set, either for the
8486 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008487
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008488 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008490 name. See |option-backslash| about using backslashes. The use of
8491 |:set+=| and |:set-=| is preferred when adding or removing directories
8492 from the list. This avoids problems when a future version uses
8493 another default. Backticks cannot be used in this option for security
8494 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008496 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008497'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008498 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008499 {not available when compiled without the |+eval|
8500 feature}
8501 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008502 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008503 The value can be the name of a function, a |lambda| or a |Funcref|.
8504 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008505
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008506 This option cannot be set from a |modeline| or in the |sandbox|, for
8507 security reasons.
8508
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8510'tildeop' 'top' boolean (default off)
8511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 When on: The tilde command "~" behaves like an operator.
8513 NOTE: This option is reset when 'compatible' is set.
8514
8515 *'timeout'* *'to'* *'notimeout'* *'noto'*
8516'timeout' 'to' boolean (default on)
8517 global
laburnumT3f7855a2023-12-05 18:37:03 +01008518
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008520'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 These two options together determine the behavior when part of a
8523 mapped key sequence or keyboard code has been received:
8524
8525 'timeout' 'ttimeout' action ~
8526 off off do not time out
8527 on on or off time out on :mappings and key codes
8528 off on time out on key codes
8529
8530 If both options are off, Vim will wait until either the complete
8531 mapping or key sequence has been received, or it is clear that there
8532 is no mapping or key sequence for the received characters. For
8533 example: if you have mapped "vl" and Vim has received 'v', the next
8534 character is needed to see if the 'v' is followed by an 'l'.
8535 When one of the options is on, Vim will wait for about 1 second for
8536 the next character to arrive. After that the already received
8537 characters are interpreted as single characters. The waiting time can
8538 be changed with the 'timeoutlen' option.
8539 On slow terminals or very busy systems timing out may cause
8540 malfunctioning cursor keys. If both options are off, Vim waits
8541 forever after an entered <Esc> if there are key codes that start
8542 with <Esc>. You will have to type <Esc> twice. If you do not have
8543 problems with key codes, but would like to have :mapped key
8544 sequences not timing out in 1 second, set the 'ttimeout' option and
8545 reset the 'timeout' option.
8546
8547 NOTE: 'ttimeout' is reset when 'compatible' is set.
8548
8549 *'timeoutlen'* *'tm'*
8550'timeoutlen' 'tm' number (default 1000)
8551 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008552
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008554'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556 The time in milliseconds that is waited for a key code or mapped key
8557 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8558 when part of a command has been typed.
8559 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8560 different timeout value for key codes is desired set 'ttimeoutlen' to
8561 a non-negative number.
8562
8563 ttimeoutlen mapping delay key code delay ~
8564 < 0 'timeoutlen' 'timeoutlen'
8565 >= 0 'timeoutlen' 'ttimeoutlen'
8566
8567 The timeout only happens when the 'timeout' and 'ttimeout' options
8568 tell so. A useful setting would be >
8569 :set timeout timeoutlen=3000 ttimeoutlen=100
8570< (time out on mapping after three seconds, time out on key codes after
8571 a tenth of a second).
8572
8573 *'title'* *'notitle'*
8574'title' boolean (default off, on when title can be restored)
8575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576 When on, the title of the window will be set to the value of
8577 'titlestring' (if it is not empty), or to:
8578 filename [+=-] (path) - VIM
8579 Where:
8580 filename the name of the file being edited
8581 - indicates the file cannot be modified, 'ma' off
8582 + indicates the file was modified
8583 = indicates the file is read-only
8584 =+ indicates the file is read-only and modified
8585 (path) is the path of the file being edited
8586 - VIM the server name |v:servername| or "VIM"
8587 Only works if the terminal supports setting window titles
8588 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008589 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008590 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8591 *X11*
8592 When Vim was compiled with HAVE_X11 defined, the original title will
8593 be restored if possible. The output of ":version" will include "+X11"
8594 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8595 works for the icon name |'icon'|.
8596 But: When Vim was started with the |-X| argument, restoring the title
8597 will not work (except in the GUI).
8598 If the title cannot be restored, it is set to the value of 'titleold'.
8599 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008600 When using an xterm from a remote machine you can use this command: >
8601
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008603 ssh -X machine_name xterm &
8604<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 then the WINDOWID environment variable should be inherited and the
8606 title of the window should change back to what it should be after
8607 exiting Vim.
8608
8609 *'titlelen'*
8610'titlelen' number (default 85)
8611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008613 title. When the title is longer, only the end of the path name is
8614 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 Using a percentage makes this adapt to the width of the window. But
8616 it won't work perfectly, because the actual number of characters
8617 available also depends on the font used and other things in the title
8618 bar. When 'titlelen' is zero the full path is used. Otherwise,
8619 values from 1 to 30000 percent can be used.
8620 'titlelen' is also used for the 'titlestring' option.
8621
8622 *'titleold'*
8623'titleold' string (default "Thanks for flying Vim")
8624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 This option will be used for the window title when exiting Vim if the
8626 original title cannot be restored. Only happens if 'title' is on or
8627 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008628 This option cannot be set from a |modeline| or in the |sandbox|, for
8629 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 *'titlestring'*
8631'titlestring' string (default "")
8632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633 When this option is not empty, it will be used for the title of the
8634 window. This happens only when the 'title' option is on.
8635 Only works if the terminal supports setting window titles (currently
8636 Amiga console, Win32 console, all GUI versions and terminals with a
8637 non-empty 't_ts' option).
8638 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008639 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008640
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 When this option contains printf-style '%' items, they will be
8642 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008643 This option cannot be set in a modeline when 'modelineexpr' is off.
8644
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008646 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8648< The value of 'titlelen' is used to align items in the middle or right
8649 of the available space.
8650 Some people prefer to have the file name first: >
8651 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8652< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008653 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 separating space only when needed.
8655 NOTE: Use of special characters in 'titlestring' may cause the display
8656 to be garbled (e.g., when it contains a CR or NL character).
8657 {not available when compiled without the |+statusline| feature}
8658
8659 *'toolbar'* *'tb'*
8660'toolbar' 'tb' string (default "icons,tooltips")
8661 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008662 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008663 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 possible values are:
8665 icons Toolbar buttons are shown with icons.
8666 text Toolbar buttons shown with text.
8667 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008668 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 tooltips Tooltips are active for toolbar buttons.
8670 Tooltips refer to the popup help text which appears after the mouse
8671 cursor is placed over a toolbar button for a brief moment.
8672
8673 If you want the toolbar to be shown with icons as well as text, do the
8674 following: >
8675 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008676< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 will show icons if both are requested.
8678
8679 If none of the strings specified in 'toolbar' are valid or if
8680 'toolbar' is empty, this option is ignored. If you want to disable
8681 the toolbar, you need to set the 'guioptions' option. For example: >
8682 :set guioptions-=T
8683< Also see |gui-toolbar|.
8684
8685 *'toolbariconsize'* *'tbis'*
8686'toolbariconsize' 'tbis' string (default "small")
8687 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008688 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008690 tiny Use tiny icons.
8691 small Use small icons (default).
8692 medium Use medium-sized icons.
8693 large Use large icons.
8694 huge Use even larger icons.
8695 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008697 the current theme. Common dimensions are giant=48x48, huge=32x32,
8698 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699
8700 If 'toolbariconsize' is empty, the global default size as determined
8701 by user preferences or the current theme is used.
8702
8703 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8704'ttybuiltin' 'tbi' boolean (default on)
8705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 When on, the builtin termcaps are searched before the external ones.
8707 When off the builtin termcaps are searched after the external ones.
8708 When this option is changed, you should set the 'term' option next for
8709 the change to take effect, for example: >
8710 :set notbi term=$TERM
8711< See also |termcap|.
8712 Rationale: The default for this option is "on", because the builtin
8713 termcap entries are generally better (many systems contain faulty
8714 xterm entries...).
8715
8716 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008717'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 Indicates a fast terminal connection. More characters will be sent to
8720 the screen for redrawing, instead of using insert/delete line
8721 commands. Improves smoothness of redrawing when there are multiple
8722 windows and the terminal does not support a scrolling region.
8723 Also enables the extra writing of characters at the end of each screen
8724 line for lines that wrap. This helps when using copy/paste with the
8725 mouse in an xterm and other terminals.
8726
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008727 The default used to be set only for some terminal names, but these
8728 days nearly all terminals are fast, therefore the default is now "on".
8729 If you have a slow connection you may want to set this option off,
8730 e.g. depending on the host name: >
8731 if hostname() =~ 'faraway'
8732 set nottyfast
8733 endif
8734<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 *'ttymouse'* *'ttym'*
8736'ttymouse' 'ttym' string (default depends on 'term')
8737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 {only in Unix and VMS, doesn't work in the GUI; not
8739 available when compiled without |+mouse|}
8740 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008741 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 *xterm-mouse*
8743 xterm xterm-like mouse handling. The mouse generates
8744 "<Esc>[Mscr", where "scr" is three bytes:
8745 "s" = button state
8746 "c" = column plus 33
8747 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008748 This only works up to 223 columns! See "dec",
8749 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 xterm2 Works like "xterm", but with the xterm reporting the
8751 mouse position while the mouse is dragged. This works
8752 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008753 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 work. See below for how Vim detects this
8755 automatically.
8756 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008757 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008759 for the row and column. No other mouse events are
8760 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 *dec-mouse*
8762 dec DEC terminal mouse handling. The mouse generates a
8763 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008764 This is also available for an Xterm, if it was
8765 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 *jsbterm-mouse*
8767 jsbterm JSB term mouse handling.
8768 *pterm-mouse*
8769 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008770 *urxvt-mouse*
8771 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008772 The mouse works only if the terminal supports this
8773 encoding style, but it does not have 223 columns limit
8774 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008775 *sgr-mouse*
8776 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008777 mouse reporting. The mouse works even in columns
8778 beyond 223. This option is backward compatible with
8779 "xterm2" because it can also decode "xterm2" style
8780 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008781
8782 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008783 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8784 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8786 recognized, if enabled at compile time. DEC terminal mouse codes
8787 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008788 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8789 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008790 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008791 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8792 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8793 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008794 If the terminfo/termcap entry "XM" exists and the first number is
8795 "1006" then 'ttymouse' will be set to "sgr". This works for many
8796 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008797 Additionally, if vim is compiled with the |+termresponse| feature and
8798 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008799 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008801 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8802 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8803 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008804 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8805 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 :set t_RV=
8807<
8808 *'ttyscroll'* *'tsl'*
8809'ttyscroll' 'tsl' number (default 999)
8810 global
8811 Maximum number of lines to scroll the screen. If there are more lines
8812 to scroll the window is redrawn. For terminals where scrolling is
8813 very slow and redrawing is not slow this can be set to a small number,
8814 e.g., 3, to speed up displaying.
8815
8816 *'ttytype'* *'tty'*
8817'ttytype' 'tty' string (default from $TERM)
8818 global
8819 Alias for 'term', see above.
8820
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008821 *'undodir'* *'udir'*
8822'undodir' 'udir' string (default ".")
8823 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008824 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008825 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008826 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008827 "." means using the directory of the file. The undo file name for
8828 "file.txt" is ".file.txt.un~".
8829 For other directories the file name is the full path of the edited
8830 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008831 When writing: The first directory that exists is used. "." always
8832 works, no directories after "." will be used for writing.
8833 When reading all entries are tried to find an undo file. The first
8834 undo file that exists is used. When it cannot be read an error is
8835 given, no further entry is used.
8836 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008837 This option cannot be set from a |modeline| or in the |sandbox|, for
8838 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008839
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008840 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008841'undofile' 'udf' boolean (default off)
8842 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008843 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008844 When on, Vim automatically saves undo history to an undo file when
8845 writing a buffer to a file, and restores undo history from the same
8846 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008847 The directory where the undo file is stored is specified by 'undodir'.
8848 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008849 The undo file is not read when 'undoreload' causes the buffer from
8850 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008851 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008852 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008853
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008855'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008856 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008858 is kept in memory, higher numbers will cause more memory to be used.
8859 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008860 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8861 itself: >
8862 set ul=0
8863< But you can also get Vi compatibility by including the 'u' flag in
8864 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008865 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008866 Set to -1 for no undo at all. You might want to do this only for the
8867 current buffer: >
8868 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008870
8871 The local value is set to -123456 when the global value is to be used.
8872
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008873 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008875 *'undoreload'* *'ur'*
8876'undoreload' 'ur' number (default 10000)
8877 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008878 Save the whole buffer for undo when reloading it. This applies to the
8879 ":e!" command and reloading for when the buffer changed outside of
8880 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008881 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008882 of lines is smaller than the value of this option.
8883 Set this option to zero to disable undo for a reload.
8884
8885 When saving undo for a reload, any undo file is not read.
8886
8887 Note that this causes the whole buffer to be stored in memory. Set
8888 this option to a lower value if you run out of memory.
8889
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 *'updatecount'* *'uc'*
8891'updatecount' 'uc' number (default: 200)
8892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893 After typing this many characters the swap file will be written to
8894 disk. When zero, no swap file will be created at all (see chapter on
8895 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8896 Vim with the "-n" option, see |startup|. When editing in readonly
8897 mode this option will be initialized to 10000.
8898 The swapfile can be disabled per buffer with |'swapfile'|.
8899 When 'updatecount' is set from zero to non-zero, swap files are
8900 created for all buffers that have 'swapfile' set. When 'updatecount'
8901 is set to zero, existing swap files are not deleted.
8902 Also see |'swapsync'|.
8903 This option has no meaning in buffers where |'buftype'| is "nofile"
8904 or "nowrite".
8905
8906 *'updatetime'* *'ut'*
8907'updatetime' 'ut' number (default 4000)
8908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909 If this many milliseconds nothing is typed the swap file will be
8910 written to disk (see |crash-recovery|). Also used for the
8911 |CursorHold| autocommand event.
8912
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008913 *'varsofttabstop'* *'vsts'*
8914'varsofttabstop' 'vsts' string (default "")
8915 local to buffer
8916 {only available when compiled with the |+vartabs|
8917 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008918 A list of the number of spaces that a <Tab> counts for while editing,
8919 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8920 width <Tab>s are being inserted, while in fact a mixture of spaces
8921 and <Tab>s is used. Tab widths are separated with commas, with the
8922 final value applying to all subsequent tabs.
8923
8924 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008925 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008926 to use the following: >
8927 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008928< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8929 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008930
8931 Note that the value of |'softtabstop'| will be ignored while
8932 'varsofttabstop' is set.
8933
8934 *'vartabstop'* *'vts'*
8935'vartabstop' 'vts' string (default "")
8936 local to buffer
8937 {only available when compiled with the |+vartabs|
8938 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008939 A list of the number of spaces that a <Tab> in the file counts for,
8940 separated by commas. Each value corresponds to one tab, with the
8941 final value applying to all subsequent tabs. For example: >
8942 :set vartabstop=4,20,10,8
8943< This will make the first tab 4 spaces wide, the second 20 spaces,
8944 the third 10 spaces, and all following tabs 8 spaces.
8945
8946 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8947 is set.
8948
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 *'verbose'* *'vbs'*
8950'verbose' 'vbs' number (default 0)
8951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008952 When bigger than zero, Vim will give messages about what it is doing.
8953 Currently, these messages are given:
8954 >= 1 When the viminfo file is read or written.
8955 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008956 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008957 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 >= 8 Files for which a group of autocommands is executed.
8959 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008960 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 >= 12 Every executed function.
8962 >= 13 When an exception is thrown, caught, finished, or discarded.
8963 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008964 >= 15 Every executed Ex command from a script (truncated at 200
8965 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008966 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967
8968 This option can also be set with the "-V" argument. See |-V|.
8969 This option is also set by the |:verbose| command.
8970
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008971 When the 'verbosefile' option is set then the verbose messages are not
8972 displayed.
8973
8974 *'verbosefile'* *'vfile'*
8975'verbosefile' 'vfile' string (default empty)
8976 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008977 When not empty all messages are written in a file with this name.
8978 When the file exists messages are appended.
8979 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008980 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008981 Setting 'verbosefile' to a new value is like making it empty first.
8982 The difference with |:redir| is that verbose messages are not
8983 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11008984 This option cannot be set from a |modeline| or in the |sandbox|, for
8985 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008986
Bram Moolenaar071d4272004-06-13 20:20:40 +00008987 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09008988'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008989 for Win32: "$HOME/vimfiles/view",
Christian Brabandtb8b1c8e2023-06-23 22:23:01 +01008990 for Unix: "$HOME/.vim/view",
h_east59858792023-10-25 22:47:05 +09008991 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008992 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008994 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 feature}
8996 Name of the directory where to store files for |:mkview|.
8997 This option cannot be set from a |modeline| or in the |sandbox|, for
8998 security reasons.
8999
9000 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009001'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009002 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009003 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009005 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009006 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 word save and restore ~
9008 cursor cursor position in file and in window
9009 folds manually created folds, opened/closed folds and local
9010 fold options
9011 options options and mappings local to a window or buffer (not
9012 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009013 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009014 slash backslashes in file names replaced with forward
9015 slashes
9016 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009017 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009018 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009020 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009022 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023
9024 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009025'viminfo' 'vi' string (Vi default: "", Vim default for
9026 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009027 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9028 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009030 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 feature}
9032 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009033 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9034 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009035 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009036 consisting of a single character identifying the particular parameter,
9037 followed by a number or string which specifies the value of that
9038 parameter. If a particular character is left out, then the default
9039 value is used for that parameter. The following is a list of the
9040 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009041 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009042 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043 ! When included, save and restore global variables that start
9044 with an uppercase letter, and don't contain a lowercase
9045 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009046 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009047 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009048 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009049 " Maximum number of lines saved for each register. Old name of
9050 the '<' item, with the disadvantage that you need to put a
9051 backslash before the ", otherwise it will be recognized as the
9052 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009053 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009054 % When included, save and restore the buffer list. If Vim is
9055 started with a file name argument, the buffer list is not
9056 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009057 buffer list is restored from the viminfo file. Quickfix
9058 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9059 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009060 When followed by a number, the number specifies the maximum
9061 number of buffers that are stored. Without a number all
9062 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009063 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 ' Maximum number of previously edited files for which the marks
9065 are remembered. This parameter must always be included when
9066 'viminfo' is non-empty.
9067 Including this item also means that the |jumplist| and the
9068 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009069 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009071 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072 patterns are also saved. When not included, the value of
9073 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009074 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009076 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009077 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009078 < Maximum number of lines saved for each register. If zero then
9079 registers are not saved. When not included, all lines are
9080 saved. '"' is the old name for this item.
9081 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009082 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009084 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009085 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 c When included, convert the text in the viminfo file from the
9087 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009088 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009089 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009090 f Whether file marks need to be stored. If zero, file marks ('0
9091 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009092 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009093 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009094 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009095 h Disable the effect of 'hlsearch' when loading the viminfo
9096 file. When not included, it depends on whether ":nohlsearch"
9097 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009098 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009099 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009100 the 'n'. Must be at the end of the option! If the
9101 'viminfofile' option is set, that file name overrides the one
9102 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009103 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009104 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 r Removable media. The argument is a string (up to the next
9106 ','). This parameter can be given several times. Each
9107 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009108 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009109 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9110 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9111 ignored. Maximum length of each 'r' argument is 50
9112 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009113 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114 s Maximum size of an item in Kbyte. If zero then registers are
9115 not saved. Currently only applies to registers. The default
9116 "s10" will exclude registers with more than 10 Kbyte of text.
9117 Also see the '<' item above: line count limit.
9118
9119 Example: >
9120 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9121<
9122 '50 Marks will be remembered for the last 50 files you
9123 edited.
9124 <1000 Contents of registers (up to 1000 lines each) will be
9125 remembered.
9126 s100 Registers with more than 100 Kbyte text are skipped.
9127 :0 Command-line history will not be saved.
9128 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9129 no / Since '/' is not specified, the default will be used,
9130 that is, save all of the search history, and also the
9131 previous search and substitute patterns.
9132 no % The buffer list will not be saved nor read back.
9133 no h 'hlsearch' highlighting will be restored.
9134
9135 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9136 load the contents of the file, this is not done automatically.
9137
9138 This option cannot be set from a |modeline| or in the |sandbox|, for
9139 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009140 NOTE: This option is set to the Vim default value when 'compatible'
9141 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009142
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009143 *'viminfofile'* *'vif'*
9144'viminfofile' 'vif' string (default: "")
9145 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009146 {not available when compiled without the |+viminfo|
9147 feature}
9148 When non-empty, overrides the file name used for viminfo.
9149 When equal to "NONE" no viminfo file will be read or written.
9150 This option can be set with the |-i| command line flag. The |--clean|
9151 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009152 This option cannot be set from a |modeline| or in the |sandbox|, for
9153 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009154
Bram Moolenaar071d4272004-06-13 20:20:40 +00009155 *'virtualedit'* *'ve'*
9156'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009157 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009158 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159 block Allow virtual editing in Visual block mode.
9160 insert Allow virtual editing in Insert mode.
9161 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009162 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009163 none When used as the local value, do not allow virtual
9164 editing even when the global value is set. When used
9165 as the global value, "none" is the same as "".
9166 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009167
Bram Moolenaar071d4272004-06-13 20:20:40 +00009168 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009169 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170 of the line. Useful for selecting a rectangle in Visual mode and
9171 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009172 "onemore" is not the same, it will only allow moving the cursor just
9173 after the last character of the line. This makes some commands more
9174 consistent. Previously the cursor was always past the end of the line
9175 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009176 break some plugins or Vim scripts. For example because |l| can move
9177 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009178 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009179 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009180 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009181 It doesn't make sense to combine "all" with "onemore", but you will
9182 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009183 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009184 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009185
9186 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9187'visualbell' 'vb' boolean (default off)
9188 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009189 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009190 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009191 use: >
9192 :set vb t_vb=
9193< If you want a short flash, you can use this on many terminals: >
9194 :set vb t_vb=[?5h$<100>[?5l
9195< Here $<100> specifies the time, you can use a smaller or bigger value
9196 to get a shorter or longer flash.
9197
9198 Note: Vim will limit the bell to once per half a second. This avoids
9199 having to wait for the flashing to finish when there are lots of
9200 bells, e.g. on key repeat. This also happens without 'visualbell'
9201 set.
9202
Bram Moolenaar071d4272004-06-13 20:20:40 +00009203 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9204 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9205 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009206
9207 Note: When the GUI starts, 't_vb' is reset to its default value. You
9208 might want to set it again in your |gvimrc|.
9209
Bram Moolenaar071d4272004-06-13 20:20:40 +00009210 Does not work on the Amiga, you always get a screen flash.
9211 Also see 'errorbells'.
9212
9213 *'warn'* *'nowarn'*
9214'warn' boolean (default on)
9215 global
9216 Give a warning message when a shell command is used while the buffer
9217 has been changed.
9218
9219 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9220'weirdinvert' 'wiv' boolean (default off)
9221 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009222 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009223 It is provided for backwards compatibility with version 4.x.
9224 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9225 vice versa. Has no effect when the GUI is running.
9226
9227 *'whichwrap'* *'ww'*
9228'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009230 Allow specified keys that move the cursor left/right to move to the
9231 previous/next line when the cursor is on the first/last character in
9232 the line. Concatenate characters to allow this for these keys:
9233 char key mode ~
9234 b <BS> Normal and Visual
9235 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009236 h "h" Normal and Visual (not recommended)
9237 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009238 < <Left> Normal and Visual
9239 > <Right> Normal and Visual
9240 ~ "~" Normal
9241 [ <Left> Insert and Replace
9242 ] <Right> Insert and Replace
9243 For example: >
9244 :set ww=<,>,[,]
9245< allows wrap only when cursor keys are used.
9246 When the movement keys are used in combination with a delete or change
9247 operator, the <EOL> also counts for a character. This makes "3h"
9248 different from "3dh" when the cursor crosses the end of a line. This
9249 is also true for "x" and "X", because they do the same as "dl" and
9250 "dh". If you use this, you may also want to use the mapping
9251 ":map <BS> X" to make backspace delete the character in front of the
9252 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009253 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009254 line (not an empty line) then it will not move to the next line. This
9255 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009256 NOTE: This option is set to the Vi default value when 'compatible' is
9257 set and to the Vim default value when 'compatible' is reset.
9258
9259 *'wildchar'* *'wc'*
9260'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009262 Character you have to type to start wildcard expansion in the
9263 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009264 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009265 The character is not recognized when used inside a macro. See
9266 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009267 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009268 <Esc> can be used, but hitting it twice in a row will still exit
9269 command-line as a failsafe measure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009270 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009271 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009272< NOTE: This option is set to the Vi default value when 'compatible' is
9273 set and to the Vim default value when 'compatible' is reset.
9274
9275 *'wildcharm'* *'wcm'*
9276'wildcharm' 'wcm' number (default: none (0))
9277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009278 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009279 recognized when used inside a macro. You can find "spare" command-line
9280 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 you'll never actually type 'wildcharm', just use it in mappings that
9282 automatically invoke completion mode, e.g.: >
9283 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009284 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009285< Then after typing :ss you can use CTRL-P & CTRL-N.
9286
9287 *'wildignore'* *'wig'*
9288'wildignore' 'wig' string (default "")
9289 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009290 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009291 patterns is ignored when expanding |wildcards|, completing file or
9292 directory names, and influences the result of |expand()|, |glob()| and
9293 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009294 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9295 Also see 'suffixes'.
9296 Example: >
9297 :set wildignore=*.o,*.obj
9298< The use of |:set+=| and |:set-=| is preferred when adding or removing
9299 a pattern from the list. This avoids problems when a future version
9300 uses another default.
9301
h_east596a9f22023-11-21 21:24:23 +09009302 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009303'wildignorecase' 'wic' boolean (default off)
9304 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009305 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009306 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009307 Does not apply when the shell is used to expand wildcards, which
9308 happens when there are special characters.
9309
Bram Moolenaar071d4272004-06-13 20:20:40 +00009310 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009311'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313 When 'wildmenu' is on, command-line completion operates in an enhanced
9314 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009315 the possible matches are shown.
9316 When 'wildoptions' contains "pum", then the completion matches are
9317 shown in a popup menu. Otherwise they are displayed just above the
9318 command line, with the first match highlighted (overwriting the status
9319 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009320 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009321 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9322 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9323 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009324 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009325 If there are more matches than can fit in the line, a ">" is shown on
9326 the right and/or a "<" is shown on the left. The status line scrolls
9327 as needed.
9328 The "wildmenu" mode is abandoned when a key is hit that is not used
9329 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009330 While the "wildmenu" is active, the following keys have special
9331 meanings:
9332 CTRL-P - go to the previous entry
9333 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009334 <CR> - in menu completion, when the cursor is just after a
9335 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009336 CTRL-E - end completion, go back to what was there before
9337 selecting a match.
9338 CTRL-Y - accept the currently selected match and stop
9339 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009340
9341 When not using the popup menu for command line completion, the
9342 following keys have special meanings:
9343 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009344 <Up> - in filename/menu name completion: move up into
9345 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009346 <Down> - in filename/menu name completion: move into a
9347 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009348
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009349 When using the popup menu for command line completion, the following
9350 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009351 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009352 <PageUp> - select a match several entries back
9353 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009354 <Left> - in filename/menu name completion: move up into
9355 parent directory or parent menu.
9356 <Right> - in filename/menu name completion: move into a
9357 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009358
Bram Moolenaar071d4272004-06-13 20:20:40 +00009359 This makes the menus accessible from the console |console-menus|.
9360
9361 If you prefer the <Left> and <Right> keys to move the cursor instead
9362 of selecting a different match, use this: >
9363 :cnoremap <Left> <Space><BS><Left>
9364 :cnoremap <Right> <Space><BS><Right>
9365<
9366 The "WildMenu" highlighting is used for displaying the current match
9367 |hl-WildMenu|.
9368
9369 *'wildmode'* *'wim'*
9370'wildmode' 'wim' string (Vim default: "full")
9371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009372 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009373 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009374 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009375 first part specifies the behavior for the first use of 'wildchar',
9376 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009377
9378 Each part consists of a colon separated list consisting of the
9379 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009380 "" Complete only the first match.
9381 "full" Complete the next full match. After the last match,
9382 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009383 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009384 "longest" Complete till longest common string. If this doesn't
9385 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009386 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009387 "lastused" When completing buffer names and more than one buffer
9388 matches, sort buffers by time last used (other than
9389 the current buffer).
9390 When there is only a single match, it is fully completed in all cases.
9391
9392 Examples of useful colon-separated values:
9393 "longest:full" Like "longest", but also start 'wildmenu' if it is
9394 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009395 "list:full" When more than one match, list all matches and
9396 complete first match.
9397 "list:longest" When more than one match, list all matches and
9398 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009399 "list:lastused" When more than one buffer matches, list all matches
9400 and sort buffers by time last used (other than the
9401 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009402
9403 Examples: >
9404 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009405< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009406 :set wildmode=longest,full
9407< Complete longest common string, then each full match >
9408 :set wildmode=list:full
9409< List all matches and complete each full match >
9410 :set wildmode=list,full
9411< List all matches without completing, then each full match >
9412 :set wildmode=longest,list
9413< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009414 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009415
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009416 *'wildoptions'* *'wop'*
9417'wildoptions' 'wop' string (default "")
9418 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009419 A list of words that change how |cmdline-completion| is done.
9420 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009421 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009422 this value is specified, wildcard expansion will not
9423 be used for completion. The matches will be sorted by
9424 the "best match" rather than alphabetically sorted.
9425 This will find more matches than the wildcard
9426 expansion. Currently fuzzy matching based completion
9427 is not supported for file and directory names and
9428 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009429 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009430 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009431 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009432 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009433 is displayed per line. Often used tag kinds are:
9434 d #define
9435 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009436
Bram Moolenaar071d4272004-06-13 20:20:40 +00009437 *'winaltkeys'* *'wak'*
9438'winaltkeys' 'wak' string (default "menu")
9439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009440 {only used in Win32, Motif, GTK and Photon GUI}
9441 Some GUI versions allow the access to menu entries by using the ALT
9442 key in combination with a character that appears underlined in the
9443 menu. This conflicts with the use of the ALT key for mappings and
9444 entering special characters. This option tells what to do:
9445 no Don't use ALT keys for menus. ALT key combinations can be
9446 mapped, but there is no automatic handling. This can then be
9447 done with the |:simalt| command.
9448 yes ALT key handling is done by the windowing system. ALT key
9449 combinations cannot be mapped.
9450 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009451 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009452 keys can be mapped.
9453 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9454 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009455 This option is not used for <F10>; on Win32 and with GTK <F10> will
9456 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009458 *'wincolor'* *'wcr'*
9459'wincolor' 'wcr' string (default empty)
9460 local to window
9461 Highlight group name to use for this window instead of the Normal
9462 color |hl-Normal|.
9463
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009464 *'window'* *'wi'*
9465'window' 'wi' number (default screen height - 1)
9466 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009467 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9468 window and the value is smaller than 'lines' minus one. The screen
9469 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009470 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9471 in a much smarter way, taking care of wrapping lines.
9472 When resizing the Vim window, the value is smaller than 1 or more than
9473 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009474 Note: Do not confuse this with the height of the Vim window, use
9475 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009476
Colin Kennedy21570352024-03-03 16:16:47 +01009477 *'winfixbuf'*
9478'winfixbuf' 'wfb' boolean (default off)
9479 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009480 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009481 For example, attempting to change the buffer with |:edit| will fail.
9482 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009483 also skip any window with 'winfixbuf' enabled. However if an Ex
9484 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009485
laburnumT3f7855a2023-12-05 18:37:03 +01009486 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9487'winfixheight' 'wfh' boolean (default off)
9488 local to window |local-noglobal|
9489 Keep the window height when windows are opened or closed and
9490 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9491 |preview-window| and |quickfix-window|.
9492 The height may be changed anyway when running out of room.
9493
9494 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9495'winfixwidth' 'wfw' boolean (default off)
9496 local to window |local-noglobal|
9497 Keep the window width when windows are opened or closed and
9498 'equalalways' is set. Also for |CTRL-W_=|.
9499 The width may be changed anyway when running out of room.
9500
Bram Moolenaar071d4272004-06-13 20:20:40 +00009501 *'winheight'* *'wh'* *E591*
9502'winheight' 'wh' number (default 1)
9503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009504 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009505 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009506 focus goes to a window that is smaller, its size is increased, at the
9507 cost of the height of other windows.
9508 Set 'winheight' to a small number for normal editing.
9509 Set it to 999 to make the current window fill most of the screen.
9510 Other windows will be only 'winminheight' high. This has the drawback
9511 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9512 to create only two windows, set the option after startup is done,
9513 using the |VimEnter| event: >
9514 au VimEnter * set winheight=999
9515< Minimum value is 1.
9516 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009517 height of the current window.
9518 'winheight' applies to the current window. Use 'winminheight' to set
9519 the minimal height for other windows.
9520
Bram Moolenaar071d4272004-06-13 20:20:40 +00009521 *'winminheight'* *'wmh'*
9522'winminheight' 'wmh' number (default 1)
9523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009524 The minimal height of a window, when it's not the current window.
9525 This is a hard minimum, windows will never become smaller.
9526 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9527 status bar) if necessary. They will return to at least one line when
9528 they become active (since the cursor has to have somewhere to go.)
9529 Use 'winheight' to set the minimal height of the current window.
9530 This option is only checked when making a window smaller. Don't use a
9531 large number, it will cause errors when opening more than a few
9532 windows. A value of 0 to 3 is reasonable.
9533
9534 *'winminwidth'* *'wmw'*
9535'winminwidth' 'wmw' number (default 1)
9536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009537 The minimal width of a window, when it's not the current window.
9538 This is a hard minimum, windows will never become smaller.
9539 When set to zero, windows may be "squashed" to zero columns (i.e. just
9540 a vertical separator) if necessary. They will return to at least one
9541 line when they become active (since the cursor has to have somewhere
9542 to go.)
9543 Use 'winwidth' to set the minimal width of the current window.
9544 This option is only checked when making a window smaller. Don't use a
9545 large number, it will cause errors when opening more than a few
9546 windows. A value of 0 to 12 is reasonable.
9547
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009548 *'winptydll'*
9549'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9550 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009551 {only available when compiled with the |terminal|
9552 feature on MS-Windows}
9553 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009554 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009555 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009556 a fallback.
9557 Environment variables are expanded |:set_env|.
9558 This option cannot be set from a |modeline| or in the |sandbox|, for
9559 security reasons.
9560
Bram Moolenaar071d4272004-06-13 20:20:40 +00009561 *'winwidth'* *'wiw'* *E592*
9562'winwidth' 'wiw' number (default 20)
9563 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009564 Minimal number of columns for the current window. This is not a hard
9565 minimum, Vim will use fewer columns if there is not enough room. If
9566 the current window is smaller, its size is increased, at the cost of
9567 the width of other windows. Set it to 999 to make the current window
9568 always fill the screen. Set it to a small number for normal editing.
9569 The width is not adjusted after one of the commands to change the
9570 width of the current window.
9571 'winwidth' applies to the current window. Use 'winminwidth' to set
9572 the minimal width for other windows.
9573
9574 *'wrap'* *'nowrap'*
9575'wrap' boolean (default on)
9576 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009577 This option changes how text is displayed. It doesn't change the text
9578 in the buffer, see 'textwidth' for that.
9579 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009580 displaying continues on the next line. When off lines will not wrap
9581 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009582 moved to a part that is not shown, the screen will scroll
9583 horizontally.
9584 The line will be broken in the middle of a word if necessary. See
9585 'linebreak' to get the break at a word boundary.
9586 To make scrolling horizontally a bit more useful, try this: >
9587 :set sidescroll=5
9588 :set listchars+=precedes:<,extends:>
9589< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009590 This option can't be set from a |modeline| when the 'diff' option is
9591 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009592
9593 *'wrapmargin'* *'wm'*
9594'wrapmargin' 'wm' number (default 0)
9595 local to buffer
9596 Number of characters from the right window border where wrapping
9597 starts. When typing text beyond this limit, an <EOL> will be inserted
9598 and inserting continues on the next line.
9599 Options that add a margin, such as 'number' and 'foldcolumn', cause
9600 the text width to be further reduced. This is Vi compatible.
9601 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009602 This option is set to 0 when 'paste' is set and restored when 'paste'
9603 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009604 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009605
9606 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9607'wrapscan' 'ws' boolean (default on) *E384* *E385*
9608 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009609 Searches wrap around the end of the file. Also applies to |]s| and
9610 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009611
9612 *'write'* *'nowrite'*
9613'write' boolean (default on)
9614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009615 Allows writing files. When not set, writing a file is not allowed.
9616 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009617 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009618 argument. Filtering text is still possible, even though this requires
9619 writing a temporary file.
9620
9621 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9622'writeany' 'wa' boolean (default off)
9623 global
9624 Allows writing to any file with no need for "!" override.
9625
9626 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9627'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9628 otherwise)
9629 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009630 Make a backup before overwriting a file. The backup is removed after
9631 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009632 also on.
9633 WARNING: Switching this option off means that when Vim fails to write
9634 your buffer correctly and then, for whatever reason, Vim exits, you
9635 lose both the original file and what you were writing. Only reset
9636 this option if your file system is almost full and it makes the write
9637 fail (and make sure not to exit Vim until the write was successful).
9638 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009639 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009640 Depending on 'backupcopy' the backup is a new file or the original
9641 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009642 NOTE: This option is set to the default value when 'compatible' is
9643 set.
9644
9645 *'writedelay'* *'wd'*
9646'writedelay' 'wd' number (default 0)
9647 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009648 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009649 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009650 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009651
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009652 *'xtermcodes'* *'noxtermcodes'*
9653'xtermcodes' boolean (default on)
9654 global
9655 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009656 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009657 key codes and number of colors from the terminal. This takes care of
9658 various configuration options of the terminal that cannot be obtained
9659 from the termlib/terminfo entry, see |xterm-codes|.
9660 A side effect may be that t_Co changes and Vim will redraw the
9661 display.
9662
9663
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009664 vim:tw=78:ts=8:noet:ft=help:norl: