blob: 655fd6c52424581ef20f59c9d26a1f0dd415074f [file] [log] [blame]
zeertzjq529b9ad2024-06-05 20:27:06 +02001*options.txt* For Vim version 9.1. Last change: 2024 Jun 05
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*
Riley Bruins0a083062024-06-03 20:40:45 +02001912'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 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
Riley Bruins0a083062024-06-03 20:40:45 +02001917 comment text, and should be padded with a space when possible.
1918 Currently used to add markers for folding, see |fold-marker| also
1919 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920
1921 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001922'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001923 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 This option has the effect of making Vim either more Vi-compatible, or
1926 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001927
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001929 other options are also changed as a side effect.
1930 NOTE: Setting or resetting this option can have a lot of unexpected
1931 effects: Mappings are interpreted in another way, undo behaves
1932 differently, etc. If you set this option in your vimrc file, you
1933 should probably put it at the very start.
1934
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935 By default this option is on and the Vi defaults are used for the
1936 options. This default was chosen for those people who want to use Vim
1937 just like Vi, and don't even (want to) know about the 'compatible'
1938 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001939 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001940 this option is switched off, and all options that have not been
1941 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001942 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001943 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001944 happen for the system-wide vimrc or gvimrc file, nor for a file given
1945 with the |-u| argument). Also see |compatible-default| and
1946 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 You can also set this option with the "-C" argument, and reset it with
1948 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001949 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950
Bram Moolenaar214641f2017-03-05 17:04:09 +01001951 When this option is set, numerous other options are set to make Vim as
1952 Vi-compatible as possible. When this option is unset, various options
1953 are set to make Vim more useful. The table below lists all the
1954 options affected.
1955 The {?} column indicates when the options are affected:
1956 + Means that the option is set to the value given in {set value} when
1957 'compatible' is set.
1958 & Means that the option is set to the value given in {set value} when
1959 'compatible' is set AND is set to its Vim default value when
1960 'compatible' is unset.
1961 - Means the option is NOT changed when setting 'compatible' but IS
1962 set to its Vim default when 'compatible' is unset.
1963 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964
Bram Moolenaar036986f2017-03-16 17:41:02 +01001965 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001966
1967 'allowrevins' + off no CTRL-_ command
1968 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001969 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001970 'arabicshape' + on correct character shapes
1971 'backspace' + "" normal backspace
1972 'backup' + off no backup file
1973 'backupcopy' & Unix: "yes" backup file is a copy
1974 else: "auto" copy or rename backup file
1975 'balloonexpr' + "" text to show in evaluation balloon
1976 'breakindent' + off don't indent when wrapping lines
1977 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001978 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001979 'cindent' + off no C code indentation
1980 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1981 'copyindent' + off don't copy indent structure
1982 'cpoptions' & (all flags) Vi-compatible flags
1983 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001984 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001985 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001986 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001987 'cscopeverbose' + off see |cscopeverbose|
1988 'delcombine' + off unicode: delete whole char combination
1989 'digraph' + off no digraphs
1990 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001991 this also disables |modifyOtherKeys|
1992 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001993 'expandtab' + off tabs not expanded to spaces
1994 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001995 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001996 'formatexpr' + "" use 'formatprg' for auto-formatting
1997 'formatoptions' & "vt" Vi compatible formatting
1998 'gdefault' + off no default 'g' flag for ":s"
1999 'history' & 0 no commandline history
2000 'hkmap' + off no Hebrew keyboard mapping
2001 'hkmapp' + off no phonetic Hebrew keyboard mapping
2002 'hlsearch' + off no highlighting of search matches
2003 'incsearch' + off no incremental searching
2004 'indentexpr' + "" no indenting by expression
2005 'insertmode' + off do not start in Insert mode
2006 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002008 'joinspaces' + on insert 2 spaces after period
2009 'modeline' & off no modelines
2010 'more' & off no pauses in listings
2011 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2012 'numberwidth' & 8 min number of columns for line number
2013 'preserveindent'+ off don't preserve current indent structure
2014 when changing it
2015 'revins' + off no reverse insert
2016 'ruler' + off no ruler
2017 'scrolljump' + 1 no jump scroll
2018 'scrolloff' + 0 no scroll offset
2019 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2020 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002021 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002022 'showcmd' & off command characters not shown
2023 'showmode' & off current mode not shown
2024 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2025 'smartcase' + off no automatic ignore case switch
2026 'smartindent' + off no smart indentation
2027 'smarttab' + off no smart tab size
2028 'softtabstop' + 0 tabs are always 'tabstop' positions
2029 'startofline' + on goto startofline with some commands
2030 'tagcase' & "followic" 'ignorecase' when searching tags file
2031 'tagrelative' & off tag file names are not relative
2032 'termguicolors' + off don't use highlight-(guifg|guibg)
2033 'textauto' & off no automatic textmode detection
2034 'textwidth' + 0 no automatic line wrap
2035 'tildeop' + off tilde is not an operator
2036 'ttimeout' + off no terminal timeout
2037 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002038 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002039 'virtualedit' + "" cursor can only be placed on characters
2040 'whichwrap' & "" left-right movements don't wrap
2041 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002043 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044
2045 *'complete'* *'cpt'* *E535*
2046'complete' 'cpt' string (default: ".,w,b,u,t,i")
2047 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 This option specifies how keyword completion |ins-completion| works
2049 when CTRL-P or CTRL-N are used. It is also used for whole-line
2050 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002051 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002052 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 w scan buffers from other windows
2054 b scan other loaded buffers that are in the buffer list
2055 u scan the unloaded buffers that are in the buffer list
2056 U scan the buffers that are not in the buffer list
2057 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002058 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 k{dict} scan the file {dict}. Several "k" flags can be given,
2060 patterns are valid too. For example: >
2061 :set cpt=k/usr/dict/*,k~/spanish
2062< s scan the files given with the 'thesaurus' option
2063 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2064 are valid too.
2065 i scan current and included files
2066 d scan current and included files for defined name or macro
2067 |i_CTRL-X_CTRL-D|
2068 ] tag completion
2069 t same as "]"
2070
2071 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2072 not executed, this may lead to unexpected completions from some files
2073 (gzipped files for example). Unloaded buffers are not scanned for
2074 whole-line completion.
2075
2076 The default is ".,w,b,u,t,i", which means to scan:
2077 1. the current buffer
2078 2. buffers in other windows
2079 3. other loaded buffers
2080 4. unloaded buffers
2081 5. tags
2082 6. included files
2083
2084 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002085 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2086 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002088 *'completefunc'* *'cfu'*
2089'completefunc' 'cfu' string (default: empty)
2090 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002091 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002092 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002093 This option specifies a function to be used for Insert mode completion
2094 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002095 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002096 invoked and what it should return. The value can be the name of a
2097 function, a |lambda| or a |Funcref|. See |option-value-function| for
2098 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002099 This option cannot be set from a |modeline| or in the |sandbox|, for
2100 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002101
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002102 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002103'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002104 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002105 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002106 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002107
2108 menu Use a popup menu to show the possible completions. The
2109 menu is only shown when there is more than one match and
2110 sufficient colors are available. |ins-completion-menu|
2111
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002112 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002113 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002114 match, e.g., what file it comes from.
2115
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002116 longest Only insert the longest common text of the matches. If
2117 the menu is displayed you can use CTRL-L to add more
2118 characters. Whether case is ignored depends on the kind
2119 of completion. For buffer text the 'ignorecase' option is
2120 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002121
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002122 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002123 completion in the preview window. Only works in
2124 combination with "menu" or "menuone".
2125
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002126 popup Show extra information about the currently selected
2127 completion in a popup window. Only works in combination
2128 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002129 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002130 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002131
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002132 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002133 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002134 |CompleteChanged| autocommand to fetch the info and call
2135 |popup_show()| once the popup has been filled.
2136 See the example at |complete-popuphidden|.
2137 {only works when compiled with the |+textprop| feature}
2138
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002139 noinsert Do not insert any text for a match until the user selects
2140 a match from the menu. Only works in combination with
2141 "menu" or "menuone". No effect if "longest" is present.
2142
2143 noselect Do not select a match in the menu, force the user to
2144 select one from the menu. Only works in combination with
2145 "menu" or "menuone".
2146
glepnira218cc62024-06-03 19:32:39 +02002147 fuzzy Enable |fuzzy-matching| for completion candidates. This
2148 allows for more flexible and intuitive matching, where
2149 characters can be skipped and matches can be found even
Christian Brabandt2a2c4ff2024-06-04 20:27:18 +02002150 if the exact sequence is not typed. Only makes a
2151 difference how completion candidates are reduced from the
2152 list of alternatives, but not how the candidates are
2153 collected (using different completion types).
glepnira218cc62024-06-03 19:32:39 +02002154
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002155 *'completepopup'* *'cpp'*
2156'completepopup' 'cpp' string (default empty)
2157 global
2158 {not available when compiled without the |+textprop|
2159 or |+quickfix| feature}
2160 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002161 properties of the info popup when it is created. If an info popup
2162 window already exists it is closed, so that the option value is
2163 applied when it is created again.
2164 You can also use |popup_findinfo()| and then set properties for an
2165 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002166
laburnumT3f7855a2023-12-05 18:37:03 +01002167 *'completeslash'* *'csl'*
2168'completeslash' 'csl' string (default: "")
2169 local to buffer
2170 {only for MS-Windows}
2171 When this option is set it overrules 'shellslash' for completion:
2172 - When this option is set to "slash", a forward slash is used for path
2173 completion in insert mode. This is useful when editing HTML tag, or
2174 Makefile with 'noshellslash' on MS-Windows.
2175 - When this option is set to "backslash", backslash is used. This is
2176 useful when editing a batch file with 'shellslash' set on MS-Windows.
2177 - When this option is empty, same character is used as for
2178 'shellslash'.
2179 For Insert mode completion the buffer-local value is used. For
2180 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002181
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002182 *'concealcursor'* *'cocu'*
2183'concealcursor' 'cocu' string (default: "")
2184 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002185 {not available when compiled without the |+conceal|
2186 feature}
2187 Sets the modes in which text in the cursor line can also be concealed.
2188 When the current mode is listed then concealing happens just like in
2189 other lines.
2190 n Normal mode
2191 v Visual mode
2192 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002193 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002194
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002195 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002196 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002197 are moving around text is concealed, but when starting to insert text
2198 or selecting a Visual area the concealed text is displayed, so that
2199 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002200 Keep in mind that the cursor position is not always where it's
2201 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002202
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002203 *'conceallevel'* *'cole'*
2204'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002205 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002206 {not available when compiled without the |+conceal|
2207 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002208 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2209 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002210
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002211 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002212 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002213 1 Each block of concealed text is replaced with one
2214 character. If the syntax item does not have a custom
2215 replacement character defined (see |:syn-cchar|) the
2216 character defined in 'listchars' is used (default is a
2217 space).
2218 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002219 2 Concealed text is completely hidden unless it has a
2220 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002221 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002222 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002223
Bram Moolenaara7781e02010-07-19 20:13:22 +02002224 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002225 edit and copy the text. This can be changed with the 'concealcursor'
2226 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002227
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2229'confirm' 'cf' boolean (default off)
2230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 When 'confirm' is on, certain operations that would normally
2232 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2233 instead raise a |dialog| asking if you wish to save the current
2234 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2235 If 'confirm' is off you can still activate confirmation for one
2236 command only (this is most useful in mappings) with the |:confirm|
2237 command.
2238 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2239
2240 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2241'conskey' 'consk' boolean (default off)
2242 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002243 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244
2245 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2246'copyindent' 'ci' boolean (default off)
2247 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 Copy the structure of the existing lines indent when autoindenting a
2249 new line. Normally the new indent is reconstructed by a series of
2250 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2251 in which case only spaces are used). Enabling this option makes the
2252 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002253 existing line. 'expandtab' has no effect on these characters, a Tab
2254 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002256 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 Also see 'preserveindent'.
2258
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002259 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260'cpoptions' 'cpo' string (Vim default: "aABceFs",
2261 Vi default: all flags)
2262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002264 this indicates Vi-compatible behavior. This is used for things where
2265 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 'cpoptions' stands for "compatible-options".
2267 Commas can be added for readability.
2268 To avoid problems with flags that are added in the future, use the
2269 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002270
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 NOTE: This option is set to the Vi default value when 'compatible' is
2272 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002273
2274 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2275 is saved, 'cpoptions' is set to the Vim default, and the saved value
2276 is restored at the end of the script. Changes to the value of
2277 'cpoptions' will be applied to the saved value, but keep in mind that
2278 removing a flag that is not present when 'cpoptions' is changed has no
2279 effect. In the |.vimrc| file the value is not restored, thus using
2280 `vim9script` in the |.vimrc| file results in using the Vim default.
2281
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002282 NOTE: This option is set to the POSIX default value at startup when
2283 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002284 variable exists |posix|. This means Vim tries to behave like the
2285 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286
2287 contains behavior ~
2288 *cpo-a*
2289 a When included, a ":read" command with a file name
2290 argument will set the alternate file name for the
2291 current window.
2292 *cpo-A*
2293 A When included, a ":write" command with a file name
2294 argument will set the alternate file name for the
2295 current window.
2296 *cpo-b*
2297 b "\|" in a ":map" command is recognized as the end of
2298 the map command. The '\' is included in the mapping,
2299 the text after the '|' is interpreted as the next
2300 command. Use a CTRL-V instead of a backslash to
2301 include the '|' in the mapping. Applies to all
2302 mapping, abbreviation, menu and autocmd commands.
2303 See also |map_bar|.
2304 *cpo-B*
2305 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002306 abbreviations, user commands and the "to" part of the
2307 menu commands. Remove this flag to be able to use a
2308 backslash like a CTRL-V. For example, the command
2309 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 'B' included: "\^[" (^[ is a real <Esc>)
2311 'B' excluded: "<Esc>" (5 characters)
2312 ('<' excluded in both cases)
2313 *cpo-c*
2314 c Searching continues at the end of any match at the
2315 cursor position, but not further than the start of the
2316 next line. When not present searching continues
2317 one character from the cursor position. With 'c'
2318 "abababababab" only gets three matches when repeating
2319 "/abab", without 'c' there are five matches.
2320 *cpo-C*
2321 C Do not concatenate sourced lines that start with a
2322 backslash. See |line-continuation|.
2323 *cpo-d*
2324 d Using "./" in the 'tags' option doesn't mean to use
2325 the tags file relative to the current file, but the
2326 tags file in the current directory.
2327 *cpo-D*
2328 D Can't use CTRL-K to enter a digraph after Normal mode
2329 commands with a character argument, like |r|, |f| and
2330 |t|.
2331 *cpo-e*
2332 e When executing a register with ":@r", always add a
2333 <CR> to the last line, also when the register is not
2334 linewise. If this flag is not present, the register
2335 is not linewise and the last line does not end in a
2336 <CR>, then the last line is put on the command-line
2337 and can be edited before hitting <CR>.
2338 *cpo-E*
2339 E It is an error when using "y", "d", "c", "g~", "gu" or
2340 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002341 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342 This makes "y0" fail in the first column.
2343 *cpo-f*
2344 f When included, a ":read" command with a file name
2345 argument will set the file name for the current buffer,
2346 if the current buffer doesn't have a file name yet.
2347 *cpo-F*
2348 F When included, a ":write" command with a file name
2349 argument will set the file name for the current
2350 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002351 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 *cpo-g*
2353 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002354 *cpo-H*
2355 H When using "I" on a line with only blanks, insert
2356 before the last blank. Without this flag insert after
2357 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 *cpo-i*
2359 i When included, interrupting the reading of a file will
2360 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002361 *cpo-I*
2362 I When moving the cursor up or down just after inserting
2363 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 *cpo-j*
2365 j When joining lines, only add two spaces after a '.',
2366 not after '!' or '?'. Also see 'joinspaces'.
2367 *cpo-J*
2368 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002369 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 white space.
2371 *cpo-k*
2372 k Disable the recognition of raw key codes in
2373 mappings, abbreviations, and the "to" part of menu
2374 commands. For example, if <Key> sends ^[OA (where ^[
2375 is <Esc>), the command ":map X ^[OA" results in X
2376 being mapped to:
2377 'k' included: "^[OA" (3 characters)
2378 'k' excluded: "<Key>" (one key code)
2379 Also see the '<' flag below.
2380 *cpo-K*
2381 K Don't wait for a key code to complete when it is
2382 halfway a mapping. This breaks mapping <F1><F1> when
2383 only part of the second <F1> has been read. It
2384 enables cancelling the mapping by typing <F1><Esc>.
2385 *cpo-l*
2386 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002387 literally, only "\]", "\^", "\-" and "\\" are special.
2388 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2390 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002391 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 *cpo-L*
2393 L When the 'list' option is set, 'wrapmargin',
2394 'textwidth', 'softtabstop' and Virtual Replace mode
2395 (see |gR|) count a <Tab> as two characters, instead of
2396 the normal behavior of a <Tab>.
2397 *cpo-m*
2398 m When included, a showmatch will always wait half a
2399 second. When not included, a showmatch will wait half
2400 a second or until a character is typed. |'showmatch'|
2401 *cpo-M*
2402 M When excluded, "%" matching will take backslashes into
2403 account. Thus in "( \( )" and "\( ( \)" the outer
2404 parenthesis match. When included "%" ignores
2405 backslashes, which is Vi compatible.
2406 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002407 n When included, the column used for 'number' and
2408 'relativenumber' will also be used for text of wrapped
2409 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 *cpo-o*
2411 o Line offset to search command is not remembered for
2412 next search.
2413 *cpo-O*
2414 O Don't complain if a file is being overwritten, even
2415 when it didn't exist when editing it. This is a
2416 protection against a file unexpectedly created by
2417 someone else. Vi didn't complain about this.
2418 *cpo-p*
2419 p Vi compatible Lisp indenting. When not present, a
2420 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002421 *cpo-P*
2422 P When included, a ":write" command that appends to a
2423 file will set the file name for the current buffer, if
2424 the current buffer doesn't have a file name yet and
2425 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002426 *cpo-q*
2427 q When joining multiple lines leave the cursor at the
2428 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 *cpo-r*
2430 r Redo ("." command) uses "/" to repeat a search
2431 command, instead of the actually used search string.
2432 *cpo-R*
2433 R Remove marks from filtered lines. Without this flag
2434 marks are kept like |:keepmarks| was used.
2435 *cpo-s*
2436 s Set buffer options when entering the buffer for the
2437 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002438 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 set when the buffer is created.
2440 *cpo-S*
2441 S Set buffer options always when entering a buffer
2442 (except 'readonly', 'fileformat', 'filetype' and
2443 'syntax'). This is the (most) Vi compatible setting.
2444 The options are set to the values in the current
2445 buffer. When you change an option and go to another
2446 buffer, the value is copied. Effectively makes the
2447 buffer options global to all buffers.
2448
2449 's' 'S' copy buffer options
2450 no no when buffer created
2451 yes no when buffer first entered (default)
2452 X yes each time when buffer entered (vi comp.)
2453 *cpo-t*
2454 t Search pattern for the tag command is remembered for
2455 "n" command. Otherwise Vim only puts the pattern in
2456 the history for search pattern, but doesn't change the
2457 last used search pattern.
2458 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002459 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 *cpo-v*
2461 v Backspaced characters remain visible on the screen in
2462 Insert mode. Without this flag the characters are
2463 erased from the screen right away. With this flag the
2464 screen newly typed text overwrites backspaced
2465 characters.
2466 *cpo-w*
2467 w When using "cw" on a blank character, only change one
2468 character and not all blanks until the start of the
2469 next word.
2470 *cpo-W*
2471 W Don't overwrite a readonly file. When omitted, ":w!"
2472 overwrites a readonly file, if possible.
2473 *cpo-x*
2474 x <Esc> on the command-line executes the command-line.
2475 The default in Vim is to abandon the command-line,
2476 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002477 *cpo-X*
2478 X When using a count with "R" the replaced text is
2479 deleted only once. Also when repeating "R" with "."
2480 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002482 y A yank command can be redone with ".". Think twice if
2483 you really want to use this, it may break some
2484 plugins, since most people expect "." to only repeat a
2485 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002486 *cpo-Z*
2487 Z When using "w!" while the 'readonly' option is set,
2488 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 *cpo-!*
2490 ! When redoing a filter command, use the last used
2491 external command, whatever it was. Otherwise the last
2492 used -filter- command is used.
2493 *cpo-$*
2494 $ When making a change to one line, don't redisplay the
2495 line, but put a '$' at the end of the changed text.
2496 The changed text will be overwritten when you type the
2497 new text. The line is redisplayed if you type any
2498 command that moves the cursor from the insertion
2499 point.
2500 *cpo-%*
2501 % Vi-compatible matching is done for the "%" command.
2502 Does not recognize "#if", "#endif", etc.
2503 Does not recognize "/*" and "*/".
2504 Parens inside single and double quotes are also
2505 counted, causing a string that contains a paren to
2506 disturb the matching. For example, in a line like
2507 "if (strcmp("foo(", s))" the first paren does not
2508 match the last one. When this flag is not included,
2509 parens inside single and double quotes are treated
2510 specially. When matching a paren outside of quotes,
2511 everything inside quotes is ignored. When matching a
2512 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002513 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002514 This flag is also used for other features, such as
2515 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002516 *cpo--*
2517 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002518 it would go above the first line or below the last
2519 line. Without it the cursor moves to the first or
2520 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002521 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002522 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002523 *cpo-+*
2524 + When included, a ":write file" command will reset the
2525 'modified' flag of the buffer, even though the buffer
2526 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002527 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 * Use ":*" in the same way as ":@". When not included,
2529 ":*" is an alias for ":'<,'>", select the Visual area.
2530 *cpo-<*
2531 < Disable the recognition of special key codes in |<>|
2532 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002533 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 ":map X <Tab>" results in X being mapped to:
2535 '<' included: "<Tab>" (5 characters)
2536 '<' excluded: "^I" (^I is a real <Tab>)
2537 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002538 *cpo->*
2539 > When appending to a register, put a line break before
2540 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002541 *cpo-;*
2542 ; When using |,| or |;| to repeat the last |t| search
2543 and the cursor is right in front of the searched
2544 character, the cursor won't move. When not included,
2545 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002546 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002547
2548 POSIX flags. These are not included in the Vi default value, except
2549 when $VIM_POSIX was set on startup. |posix|
2550
2551 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002552 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002553 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002554 *cpo-&*
2555 & When ":preserve" was used keep the swap file when
2556 exiting normally while this buffer is still loaded.
2557 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002558 *cpo-\*
2559 \ Backslash in a [] range in a search pattern is taken
2560 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002561 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2562 '\' excluded: "/[ \-]" finds <Space> and '-'
2563 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002564 *cpo-/*
2565 / When "%" is used as the replacement string in a |:s|
2566 command, use the previous replacement string. |:s%|
2567 *cpo-{*
2568 { The |{| and |}| commands also stop at a "{" character
2569 at the start of a line.
2570 *cpo-.*
2571 . The ":chdir" and ":cd" commands fail if the current
2572 buffer is modified, unless ! is used. Vim doesn't
2573 need this, since it remembers the full path of an
2574 opened file.
2575 *cpo-bar*
2576 | The value of the $LINES and $COLUMNS environment
2577 variables overrule the terminal size values obtained
2578 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002579
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002580 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002581'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002582 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002583 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002584 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002585 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002586 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002587 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002588 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002589 blowfish Blowfish method. Medium strong encryption but it has
2590 an implementation flaw. Requires Vim 7.3 or later,
2591 files can NOT be read by Vim 7.2 and older. This adds
2592 a "seed" to the file, every time you write the file
2593 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002594 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002595 *blowfish2*
2596 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002597 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002598 and older. This adds a "seed" to the file, every time
2599 you write the file the encrypted bytes will be
2600 different. The whole undo file is encrypted, not just
2601 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002602 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002603 *E1197* *E1198* *E1199* *E1200* *E1201*
2604 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2605 Code. Medium strong till strong encryption.
2606 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002607 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002608 It adds a seed and a message authentication code (MAC)
2609 to the file. This needs at least a Vim 8.2.3022 to
2610 read the encrypted file.
2611 Encryption of swap files is not supported, therefore
2612 no swap file will be used when xchacha20 encryption is
2613 enabled.
2614 Encryption of undo files is not yet supported,
2615 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002616 CAREFUL: Files written with this method might have to
2617 be read back with the same version of Vim if the
2618 binary format changes later.
2619 Obsolete, please do no longer use.
2620 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2621 stores the key derivation parameters together with the
2622 encrypted file. Should work better in case the
2623 parameters in the libsodium library ever change.
2624 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002625 might have to be read back with the same version of
2626 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002627
Christian Brabandtaae58342023-04-23 17:50:22 +01002628 You should use "blowfish2", also to re-encrypt older files. The
2629 "xchacha20" method provides better encryption, but it does not work
2630 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002631
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002632 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002633 to the detected method of the file being read. Thus if you write it
2634 without changing 'cryptmethod' the same method will be used.
2635 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002636 explicitly write it, you don't get a warning unless there are other
2637 modifications. Also see |:X|.
2638
2639 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002640 the value "blowfish2". When setting the local value to an empty
2641 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002642
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002643 When a new encryption method is added in a later version of Vim, and
2644 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002645 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002646
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 *'cscopepathcomp'* *'cspc'*
2648'cscopepathcomp' 'cspc' number (default 0)
2649 global
2650 {not available when compiled without the |+cscope|
2651 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 Determines how many components of the path to show in a list of tags.
2653 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002654 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655
2656 *'cscopeprg'* *'csprg'*
2657'cscopeprg' 'csprg' string (default "cscope")
2658 global
2659 {not available when compiled without the |+cscope|
2660 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 Specifies the command to execute cscope. See |cscopeprg|.
2662 This option cannot be set from a |modeline| or in the |sandbox|, for
2663 security reasons.
2664
2665 *'cscopequickfix'* *'csqf'*
2666'cscopequickfix' 'csqf' string (default "")
2667 global
2668 {not available when compiled without the |+cscope|
2669 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 Specifies whether to use quickfix window to show cscope results.
2671 See |cscopequickfix|.
2672
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002673 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002674'cscoperelative' 'csre' boolean (default off)
2675 global
2676 {not available when compiled without the |+cscope|
2677 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002678 In the absence of a prefix (-P) for cscope. setting this option enables
2679 to use the basename of cscope.out path as the prefix.
2680 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002681 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002682
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2684'cscopetag' 'cst' boolean (default off)
2685 global
2686 {not available when compiled without the |+cscope|
2687 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 Use cscope for tag commands. See |cscope-options|.
2689 NOTE: This option is reset when 'compatible' is set.
2690
2691 *'cscopetagorder'* *'csto'*
2692'cscopetagorder' 'csto' number (default 0)
2693 global
2694 {not available when compiled without the |+cscope|
2695 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 Determines the order in which ":cstag" performs a search. See
2697 |cscopetagorder|.
2698 NOTE: This option is set to 0 when 'compatible' is set.
2699
2700 *'cscopeverbose'* *'csverb'*
2701 *'nocscopeverbose'* *'nocsverb'*
2702'cscopeverbose' 'csverb' boolean (default off)
2703 global
2704 {not available when compiled without the |+cscope|
2705 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 Give messages when adding a cscope database. See |cscopeverbose|.
2707 NOTE: This option is reset when 'compatible' is set.
2708
Bram Moolenaar860cae12010-06-05 23:22:07 +02002709 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2710'cursorbind' 'crb' boolean (default off)
2711 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002712 When this option is set, as the cursor in the current
2713 window moves other cursorbound windows (windows that also have
2714 this option set) move their cursors to the corresponding line and
2715 column. This option is useful for viewing the
2716 differences between two versions of a file (see 'diff'); in diff mode,
2717 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002718 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002719
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002720 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2721'cursorcolumn' 'cuc' boolean (default off)
2722 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002723 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002724 feature}
2725 Highlight the screen column of the cursor with CursorColumn
2726 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2727 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002728 If you only want the highlighting in the current window you can use
2729 these autocommands: >
2730 au WinLeave * set nocursorline nocursorcolumn
2731 au WinEnter * set cursorline cursorcolumn
2732<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002733
2734 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2735'cursorline' 'cul' boolean (default off)
2736 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002737 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002738 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002739 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2740 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002741 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002742 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002743
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002744 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002745'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002746 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002747 {not available when compiled without the |+syntax|
2748 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002749 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002750 Valid values:
2751 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002752 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002753 "screenline" Highlight only the screen line of the cursor with
2754 CursorLine |hl-CursorLine|.
2755 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002756 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002757
2758 Special value:
2759 "both" Alias for the values "line,number".
2760
2761 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002762
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 *'debug'*
2764'debug' string (default "")
2765 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002766 These values can be used:
2767 msg Error messages that would otherwise be omitted will be given
2768 anyway.
2769 throw Error messages that would otherwise be omitted will be given
2770 anyway and also throw an exception and set |v:errmsg|.
2771 beep A message will be given when otherwise only a beep would be
2772 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002773 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002774 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2775 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776
2777 *'define'* *'def'*
2778'define' 'def' string (default "^\s*#\s*define")
2779 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002780 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 pattern, just like for the "/" command. This option is used for the
2782 commands like "[i" and "[d" |include-search|. The 'isident' option is
2783 used to recognize the defined name after the match:
2784 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2785 See |option-backslash| about inserting backslashes to include a space
2786 or backslash.
2787 The default value is for C programs. For C++ this value would be
2788 useful, to include const type declarations: >
2789 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002790< You can also use "\ze" just before the name and continue the pattern
2791 to check what is following. E.g. for Javascript, if a function is
2792 defined with "func_name = function(args)": >
2793 ^\s*\ze\i\+\s*=\s*function(
2794< If the function is defined with "func_name : function() {...": >
2795 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002797 To avoid that use `:let` with a single quote string: >
2798 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002799<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800
2801 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2802'delcombine' 'deco' boolean (default off)
2803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 If editing Unicode and this option is set, backspace and Normal mode
2805 "x" delete each combining character on its own. When it is off (the
2806 default) the character along with its combining characters are
2807 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002808 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809
2810 This is useful for Arabic, Hebrew and many other languages where one
2811 may have combining characters overtop of base characters, and want
2812 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002813 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814
2815 *'dictionary'* *'dict'*
2816'dictionary' 'dict' string (default "")
2817 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 List of file names, separated by commas, that are used to lookup words
2819 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2820 contain a list of words. This can be one word per line, or several
2821 words per line, separated by non-keyword characters (white space is
2822 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002823
2824 When this option is empty or an entry "spell" is present, and spell
2825 checking is enabled, words in the word lists for the currently active
2826 'spelllang' are used. See |spell|.
2827
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002828 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 after a comma are ignored, otherwise spaces are included in the file
2830 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002831 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832 Where to find a list of words?
2833 - On FreeBSD, there is the file "/usr/share/dict/words".
2834 - In the Simtel archive, look in the "msdos/linguist" directory.
2835 - In "miscfiles" of the GNU collection.
2836 The use of |:set+=| and |:set-=| is preferred when adding or removing
2837 directories from the list. This avoids problems when a future version
2838 uses another default.
2839 Backticks cannot be used in this option for security reasons.
2840
2841 *'diff'* *'nodiff'*
2842'diff' boolean (default off)
2843 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 {not available when compiled without the |+diff|
2845 feature}
2846 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002847 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848
2849 *'dex'* *'diffexpr'*
2850'diffexpr' 'dex' string (default "")
2851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 {not available when compiled without the |+diff|
2853 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002854 Expression which is evaluated to obtain a diff file (either ed-style
2855 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 This option cannot be set from a |modeline| or in the |sandbox|, for
2857 security reasons.
2858
2859 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002860'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 {not available when compiled without the |+diff|
2863 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002864 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 All are optional. Items must be separated by a comma.
2866
2867 filler Show filler lines, to keep the text
2868 synchronized with a window that has inserted
2869 lines at the same position. Mostly useful
2870 when windows are side-by-side and 'scrollbind'
2871 is set.
2872
2873 context:{n} Use a context of {n} lines between a change
2874 and a fold that contains unchanged lines.
2875 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002876 When using zero the context is actually one,
2877 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002878 for a deleted line. Set it to a very large
2879 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 See |fold-diff|.
2881
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002882 iblank Ignore changes where lines are all blank. Adds
2883 the "-B" flag to the "diff" command if
2884 'diffexpr' is empty. Check the documentation
2885 of the "diff" command for what this does
2886 exactly.
2887 NOTE: the diff windows will get out of sync,
2888 because no differences between blank lines are
2889 taken into account.
2890
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 icase Ignore changes in case of text. "a" and "A"
2892 are considered the same. Adds the "-i" flag
2893 to the "diff" command if 'diffexpr' is empty.
2894
2895 iwhite Ignore changes in amount of white space. Adds
2896 the "-b" flag to the "diff" command if
2897 'diffexpr' is empty. Check the documentation
2898 of the "diff" command for what this does
2899 exactly. It should ignore adding trailing
2900 white space, but not leading white space.
2901
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002902 iwhiteall Ignore all white space changes. Adds
2903 the "-w" flag to the "diff" command if
2904 'diffexpr' is empty. Check the documentation
2905 of the "diff" command for what this does
2906 exactly.
2907
2908 iwhiteeol Ignore white space changes at end of line.
2909 Adds the "-Z" flag to the "diff" command if
2910 'diffexpr' is empty. Check the documentation
2911 of the "diff" command for what this does
2912 exactly.
2913
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002914 horizontal Start diff mode with horizontal splits (unless
2915 explicitly specified otherwise).
2916
2917 vertical Start diff mode with vertical splits (unless
2918 explicitly specified otherwise).
2919
Bram Moolenaarc8234772019-11-10 21:00:27 +01002920 closeoff When a window is closed where 'diff' is set
2921 and there is only one window remaining in the
2922 same tab page with 'diff' set, execute
2923 `:diffoff` in that window. This undoes a
2924 `:diffsplit` command.
2925
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002926 hiddenoff Do not use diff mode for a buffer when it
2927 becomes hidden.
2928
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002929 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2930 starting diff mode. Without this 2 is used.
2931
Bram Moolenaar4223d432021-02-10 13:18:17 +01002932 followwrap Follow the 'wrap' option and leave as it is.
2933
Bram Moolenaare828b762018-09-10 17:51:58 +02002934 internal Use the internal diff library. This is
2935 ignored when 'diffexpr' is set. *E960*
2936 When running out of memory when writing a
2937 buffer this item will be ignored for diffs
2938 involving that buffer. Set the 'verbose'
2939 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940
Bram Moolenaare828b762018-09-10 17:51:58 +02002941 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002942 Use the indent heuristic for the internal
2943 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002944
zeertzjqd086b8f2024-02-25 15:42:52 +08002945 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002946 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002947 algorithms are:
2948 myers the default algorithm
2949 minimal spend extra time to generate the
2950 smallest possible diff
2951 patience patience diff algorithm
2952 histogram histogram diff algorithm
2953
2954 Examples: >
2955 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002957 :set diffopt=internal,filler,foldcolumn:3
2958 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959<
2960 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2961'digraph' 'dg' boolean (default off)
2962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 {not available when compiled without the |+digraphs|
2964 feature}
2965 Enable the entering of digraphs in Insert mode with {char1} <BS>
2966 {char2}. See |digraphs|.
2967 NOTE: This option is reset when 'compatible' is set.
2968
2969 *'directory'* *'dir'*
2970'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002971 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 for Unix: ".,~/tmp,/var/tmp,/tmp")
2973 global
2974 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002975 Recommended value: ".,~/vimswap//" - this will put the swap file next
2976 to the edited file if possible, and in your personal swap directory
2977 otherwise. Make sure "~/vimswap//" is only readable for you.
2978
2979 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 - The swap file will be created in the first directory where this is
2981 possible.
2982 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002983 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 - A directory "." means to put the swap file in the same directory as
2985 the edited file. On Unix, a dot is prepended to the file name, so
2986 it doesn't show in a directory listing. On MS-Windows the "hidden"
2987 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002988 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2989 the swap file relative to where the edited file is. The leading "."
2990 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002991 - For Unix and Win32, if a directory ends in two path separators "//",
2992 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002993 with all path separators replaced by percent '%' signs (including
2994 the colon following the drive letter on Win32). This will ensure
2995 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002996 On Win32, it is also possible to end with "\\". However, When a
2997 separating comma is following, you must use "//", since "\\" will
2998 include the comma in the file name. Therefore it is recommended to
2999 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 - Spaces after the comma are ignored, other spaces are considered part
3001 of the directory name. To have a space at the start of a directory
3002 name, precede it with a backslash.
3003 - To include a comma in a directory name precede it with a backslash.
3004 - A directory name may end in an ':' or '/'.
3005 - Environment variables are expanded |:set_env|.
3006 - Careful with '\' characters, type one before a space, type two to
3007 get one in the option (see |option-backslash|), for example: >
3008 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3009< - For backwards compatibility with Vim version 3.0 a '>' at the start
3010 of the option is removed.
3011 Using "." first in the list is recommended. This means that editing
3012 the same file twice will result in a warning. Using "/tmp" on Unix is
3013 discouraged: When the system crashes you lose the swap file.
3014 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003015 choice than "/tmp". But others on the computer may be able to see the
3016 files, and it can contain a lot of files, your swap files get lost in
3017 the crowd. That is why a "tmp" directory in your home directory is
3018 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 The use of |:set+=| and |:set-=| is preferred when adding or removing
3020 directories from the list. This avoids problems when a future version
3021 uses another default.
3022 This option cannot be set from a |modeline| or in the |sandbox|, for
3023 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024
3025 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003026'display' 'dy' string (default "", set to "truncate" in
3027 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003029 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 flags:
3031 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003032 in a window will be displayed. "@@@" is put in the
3033 last columns of the last screen line to indicate the
3034 rest of the line is not displayed.
3035 truncate Like "lastline", but "@@@" is displayed in the first
3036 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 uhex Show unprintable characters hexadecimal as <xx>
3038 instead of using ^C and ~C.
3039
Bram Moolenaard0796902016-09-16 20:02:31 +02003040 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003041 doesn't fit is replaced with "@" lines.
3042
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003043 The "@" character can be changed by setting the "lastline" item in
3044 'fillchars'. The character is highlighted with |hl-NonText|.
3045
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 *'eadirection'* *'ead'*
3047'eadirection' 'ead' string (default "both")
3048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 Tells when the 'equalalways' option applies:
3050 ver vertically, width of windows is not affected
3051 hor horizontally, height of windows is not affected
3052 both width and height of windows is affected
3053
3054 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3055'edcompatible' 'ed' boolean (default off)
3056 global
3057 Makes the 'g' and 'c' flags of the ":substitute" command to be
3058 toggled each time the flag is given. See |complex-change|. See
3059 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003060 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003061 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062
Bram Moolenaar03413f42016-04-12 21:07:15 +02003063 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003064'emoji' 'emo' boolean (default: on)
3065 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003066 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003067 This excludes "text emoji" characters, which are normally displayed as
3068 single width. Unfortunately there is no good specification for this
3069 and it has been determined on trial-and-error basis. Use the
3070 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003071
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003073'encoding' 'enc' string (default for MS-Windows: "utf-8",
3074 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 Sets the character encoding used inside Vim. It applies to text in
3077 the buffers, registers, Strings in expressions, text stored in the
3078 viminfo file, etc. It sets the kind of characters which Vim can work
3079 with. See |encoding-names| for the possible values.
3080
3081 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003082 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003084 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085
Bram Moolenaar865242e2010-07-14 21:12:05 +02003086 This option cannot be set from a |modeline|. It would most likely
3087 corrupt the text.
3088
Bram Moolenaar3df01732017-02-17 22:47:16 +01003089 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3090 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 'encoding', "utf-8" is the natural choice for the environment and
3092 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003093 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 versions, and to avoid changing the encoding of newly created files
3095 without your knowledge (in case 'fileencodings' is empty).
3096
3097 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003098 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 iconv() or as specified with 'charconvert'.
3100
Bram Moolenaar207f0092020-08-30 17:20:20 +02003101 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003102 can use: >
3103 if has("multi_byte_encoding")
3104<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 Normally 'encoding' will be equal to your current locale. This will
3106 be the default if Vim recognizes your environment settings. If
3107 'encoding' is not set to the current locale, 'termencoding' must be
3108 set to convert typed and displayed text. See |encoding-table|.
3109
3110 When you set this option, it fires the |EncodingChanged| autocommand
3111 event so that you can set up fonts if necessary.
3112
3113 When the option is set, the value is converted to lowercase. Thus
3114 you can set it with uppercase values too. Underscores are translated
3115 to '-' signs.
3116 When the encoding is recognized, it is changed to the standard name.
3117 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3118 "iso-8859-2" and "utf8" becomes "utf-8".
3119
3120 Note: "latin1" is also used when the encoding could not be detected.
3121 This only works when editing files in the same encoding! When the
3122 actual character set is not latin1, make sure 'fileencoding' and
3123 'fileencodings' are empty. When conversion is needed, switch to using
3124 utf-8.
3125
3126 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3127 You don't notice this while editing, but it does matter for the
3128 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3129 setting 'encoding' to one of these values instead of utf-8 only has
3130 effect for encoding used for files when 'fileencoding' is empty.
3131
Bram Moolenaar661b1822005-07-28 22:36:45 +00003132 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3133 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003135 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003136'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003138 Indicates that a CTRL-Z character was found at the end of the file
3139 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003141 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003142 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003143 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003144
3145 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3146'endofline' 'eol' boolean (default on)
3147 local to buffer
3148 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003149 is on, or 'fixeol' option is off, no <EOL> will be written for the
3150 last line in the file. This option is automatically set or reset when
3151 starting to edit a new file, depending on whether file has an <EOL>
3152 for the last line in the file. Normally you don't have to set or
3153 reset this option.
3154 When 'binary' is off and 'fixeol' is on the value is not used when
3155 writing the file. When 'binary' is on or 'fixeol' is off it is used
3156 to remember the presence of a <EOL> for the last line in the file, so
3157 that when you write the file the situation from the original file can
3158 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003159 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160
3161 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3162'equalalways' 'ea' boolean (default on)
3163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003165 splitting or closing a window. This also happens the moment the
3166 option is switched on. When off, splitting a window will reduce the
3167 size of the current window and leave the other windows the same. When
3168 closing a window the extra lines are given to the window next to it
3169 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 When mixing vertically and horizontally split windows, a minimal size
3171 is computed and some windows may be larger if there is room. The
3172 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003173 Changing the height and width of a window can be avoided by setting
3174 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003175 If a window size is specified when creating a new window sizes are
3176 currently not equalized (it's complicated, but may be implemented in
3177 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178
3179 *'equalprg'* *'ep'*
3180'equalprg' 'ep' string (default "")
3181 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003183 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003184 or 'indentexpr'. When Vim was compiled without internal formatting,
3185 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003186 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 about including spaces and backslashes.
3188 This option cannot be set from a |modeline| or in the |sandbox|, for
3189 security reasons.
3190
3191 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3192'errorbells' 'eb' boolean (default off)
3193 global
3194 Ring the bell (beep or screen flash) for error messages. This only
3195 makes a difference for error messages, the bell will be used always
3196 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003197 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003198 screen flash or do nothing. See 'belloff' to finetune when to ring the
3199 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200
3201 *'errorfile'* *'ef'*
3202'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3203 others: "errors.err")
3204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 {not available when compiled without the |+quickfix|
3206 feature}
3207 Name of the errorfile for the QuickFix mode (see |:cf|).
3208 When the "-q" command-line argument is used, 'errorfile' is set to the
3209 following argument. See |-q|.
3210 NOT used for the ":make" command. See 'makeef' for that.
3211 Environment variables are expanded |:set_env|.
3212 See |option-backslash| about including spaces and backslashes.
3213 This option cannot be set from a |modeline| or in the |sandbox|, for
3214 security reasons.
3215
3216 *'errorformat'* *'efm'*
3217'errorformat' 'efm' string (default is very long)
3218 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 {not available when compiled without the |+quickfix|
3220 feature}
3221 Scanf-like description of the format for the lines in the error file
3222 (see |errorformat|).
3223
3224 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3225'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 Function keys that start with an <Esc> are recognized in Insert
3228 mode. When this option is off, the cursor and function keys cannot be
3229 used in Insert mode if they start with an <Esc>. The advantage of
3230 this is that the single <Esc> is recognized immediately, instead of
3231 after one second. Instead of resetting this option, you might want to
3232 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3233 when 'esckeys' is off, you can still map anything, but the cursor keys
3234 won't work by default.
3235 NOTE: This option is set to the Vi default value when 'compatible' is
3236 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003237 NOTE: when this option is off then the |modifyOtherKeys| and
3238 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3239 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240
3241 *'eventignore'* *'ei'*
3242'eventignore' 'ei' string (default "")
3243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003245 When set to "all" or when "all" is one of the items, all autocommand
3246 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003247 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 :set ei=WinEnter,WinLeave
3249<
3250 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3251'expandtab' 'et' boolean (default off)
3252 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003254 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3256 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003257 This option is reset when the 'paste' option is set and restored when
3258 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 NOTE: This option is reset when 'compatible' is set.
3260
3261 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3262'exrc' 'ex' boolean (default off)
3263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003265 directory.
3266
3267 Setting this option is a potential security leak. E.g., consider
3268 unpacking a package or fetching files from github, a .vimrc in there
3269 might be a trojan horse. BETTER NOT SET THIS OPTION!
3270 Instead, define an autocommand in your .vimrc to set options for a
3271 matching directory.
3272
3273 If you do switch this option on you should also consider setting the
3274 'secure' option (see |initialization|).
3275 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 This option cannot be set from a |modeline| or in the |sandbox|, for
3277 security reasons.
3278
3279 *'fileencoding'* *'fenc'* *E213*
3280'fileencoding' 'fenc' string (default: "")
3281 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003283
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003285 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 When 'fileencoding' is empty, the same value as 'encoding' will be
3287 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003288 No error will be given when the value is set, only when it is used,
3289 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003290 Conversion will also be done when 'encoding' and 'fileencoding' are
3291 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3292 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003294 'encoding' is "utf-8" or another Unicode encoding, conversion
3295 is most likely done in a way that the reverse conversion
3296 results in the same text. When 'encoding' is not "utf-8" some
3297 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003298
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 See 'encoding' for the possible values. Additionally, values may be
3300 specified that can be handled by the converter, see
3301 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003302
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 When reading a file 'fileencoding' will be set from 'fileencodings'.
3304 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003305 'fileencoding', use the |++enc| argument. One exception: when
3306 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003307 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003308
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3310 When the option is set, the value is converted to lowercase. Thus
3311 you can set it with uppercase values too. '_' characters are
3312 replaced with '-'. If a name is recognized from the list for
3313 'encoding', it is replaced by the standard name. For example
3314 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003315
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 When this option is set, after starting to edit a file, the 'modified'
3317 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003318
3319 Keep in mind that changing 'fenc' from a modeline happens
3320 AFTER the text has been read, thus it applies to when the file will be
3321 written. If you do set 'fenc' in a modeline, you might want to set
3322 'nomodified' to avoid not being able to ":q".
3323
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 This option can not be changed when 'modifiable' is off.
3325
3326 *'fe'*
3327 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003328 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 old short name was 'fe', which is no longer used.
3330
3331 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003332'fileencodings' 'fencs' string (default: "ucs-bom",
3333 "ucs-bom,utf-8,default,latin1" when
3334 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 This is a list of character encodings considered when starting to edit
3337 an existing file. When a file is read, Vim tries to use the first
3338 mentioned character encoding. If an error is detected, the next one
3339 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003340 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 an empty string, which means the value of 'encoding' is used.
3342 WARNING: Conversion can cause loss of information! When
3343 'encoding' is "utf-8" (or one of the other Unicode variants)
3344 conversion is most likely done in a way that the reverse
3345 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003346 "utf-8" some non-ASCII characters may be lost! You can use
3347 the |++bad| argument to specify what is done with characters
3348 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 For an empty file or a file with only ASCII characters most encodings
3350 will work and the first entry of 'fileencodings' will be used (except
3351 "ucs-bom", which requires the BOM to be present). If you prefer
3352 another encoding use an BufReadPost autocommand event to test if your
3353 preferred encoding is to be used. Example: >
3354 au BufReadPost * if search('\S', 'w') == 0 |
3355 \ set fenc=iso-2022-jp | endif
3356< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3357 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003358 When the |++enc| argument is used then the value of 'fileencodings' is
3359 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003360 Note that 'fileencodings' is not used for a new file, the global value
3361 of 'fileencoding' is used instead. You can set it with: >
3362 :setglobal fenc=iso-8859-2
3363< This means that a non-existing file may get a different encoding than
3364 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 The special value "ucs-bom" can be used to check for a Unicode BOM
3366 (Byte Order Mark) at the start of the file. It must not be preceded
3367 by "utf-8" or another Unicode encoding for this to work properly.
3368 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3369 because Vim cannot detect an error, thus the encoding is always
3370 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003371 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003372 environment. On MS-Windows this is the system encoding. Otherwise
3373 this is the default value for 'encoding'. It is useful when
3374 'encoding' is set to "utf-8" and your environment uses a non-latin1
3375 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003376 When 'encoding' is "utf-8" and a file contains an illegal byte
3377 sequence it won't be recognized as UTF-8. You can use the |8g8|
3378 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 WRONG VALUES: WHAT'S WRONG:
3380 latin1,utf-8 "latin1" will always be used
3381 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3382 file
3383 cp1250,latin1 "cp1250" will always be used
3384 If 'fileencodings' is empty, 'fileencoding' is not modified.
3385 See 'fileencoding' for the possible values.
3386 Setting this option does not have an effect until the next time a file
3387 is read.
3388
3389 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003390'fileformat' 'ff' string (MS-Windows default: "dos",
3391 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 This gives the <EOL> of the current buffer, which is used for
3394 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003395 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 unix <NL>
3397 mac <CR>
3398 When "dos" is used, CTRL-Z at the end of a file is ignored.
3399 See |file-formats| and |file-read|.
3400 For the character encoding of the file see 'fileencoding'.
3401 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003402 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 This option is set automatically when starting to edit a file and
3404 'fileformats' is not empty and 'binary' is off.
3405 When this option is set, after starting to edit a file, the 'modified'
3406 option is set, because the file would be different when written.
3407 This option can not be changed when 'modifiable' is off.
3408 For backwards compatibility: When this option is set to "dos",
3409 'textmode' is set, otherwise 'textmode' is reset.
3410
3411 *'fileformats'* *'ffs'*
3412'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003413 Vim+Vi MS-Windows: "dos,unix",
3414 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 Vi Cygwin: "unix,dos",
3416 Vi others: "")
3417 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 This gives the end-of-line (<EOL>) formats that will be tried when
3419 starting to edit a new buffer and when reading a file into an existing
3420 buffer:
3421 - When empty, the format defined with 'fileformat' will be used
3422 always. It is not set automatically.
3423 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003424 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 'fileformats' name will be used when a file is read into an existing
3426 buffer, no matter what 'fileformat' for that buffer is set to.
3427 - When more than one name is present, separated by commas, automatic
3428 <EOL> detection will be done when reading a file. When starting to
3429 edit a file, a check is done for the <EOL>:
3430 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3431 'fileformat' is set to "dos".
3432 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003433 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003435 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3436 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003437 This means that "mac" is only chosen when:
3438 "unix" is not present or no <NL> is found in the file, and
3439 "dos" is not present or no <CR><NL> is found in the file.
3440 Except: if "unix" was chosen, but there is a <CR> before
3441 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003442 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 4. If 'fileformat' is still not set, the first name from
3444 'fileformats' is used.
3445 When reading a file into an existing buffer, the same is done, but
3446 this happens like 'fileformat' has been set appropriately for that
3447 file only, the option is not changed.
3448 When 'binary' is set, the value of 'fileformats' is not used.
3449
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003450 When Vim starts up with an empty buffer the first item is used. You
3451 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003452
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3454 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3455 done:
3456 - When 'fileformats' is empty, there is no automatic detection. Dos
3457 format will be used.
3458 - When 'fileformats' is set to one or more names, automatic detection
3459 is done. This is based on the first <NL> in the file: If there is a
3460 <CR> in front of it, Dos format is used, otherwise Unix format is
3461 used.
3462 Also see |file-formats|.
3463 For backwards compatibility: When this option is set to an empty
3464 string or one format (no comma is included), 'textauto' is reset,
3465 otherwise 'textauto' is set.
3466 NOTE: This option is set to the Vi default value when 'compatible' is
3467 set and to the Vim default value when 'compatible' is reset.
3468
Bram Moolenaarbf884932013-04-05 22:26:15 +02003469 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3470'fileignorecase' 'fic' boolean (default on for systems where case in file
3471 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003472 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003473 When set case is ignored when using file names and directories.
3474 See 'wildignorecase' for only ignoring case when doing completion.
3475
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 *'filetype'* *'ft'*
3477'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003478 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 When this option is set, the FileType autocommand event is triggered.
3480 All autocommands that match with the value of this option will be
3481 executed. Thus the value of 'filetype' is used in place of the file
3482 name.
3483 Otherwise this option does not always reflect the current file type.
3484 This option is normally set when the file type is detected. To enable
3485 this use the ":filetype on" command. |:filetype|
3486 Setting this option to a different value is most useful in a modeline,
3487 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003488 Example, for in an IDL file:
3489 /* vim: set filetype=idl : */ ~
3490 |FileType| |filetypes|
3491 When a dot appears in the value then this separates two filetype
3492 names. Example:
3493 /* vim: set filetype=c.doxygen : */ ~
3494 This will use the "c" filetype first, then the "doxygen" filetype.
3495 This works both for filetype plugins and for syntax files. More than
3496 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 This option is not copied to another buffer, independent of the 's' or
3498 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003499 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500
3501 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003502'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003503 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003504 Characters to fill the statuslines, vertical separators and special
3505 lines in the window.
3506 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003507 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003509 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003510 stl ' ' statusline of the current window
3511 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003512 vert '|' vertical separators |:vsplit|
3513 fold '-' filling 'foldtext'
3514 foldopen '-' mark the beginning of a fold
3515 foldclose '+' show a closed fold
3516 foldsep '|' open fold middle character
3517 diff '-' deleted lines of the 'diff' option
3518 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003519 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003521 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522
3523 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003524 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3525<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003526 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3527 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003528 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003529
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003531 item name highlight group ~
3532 stl StatusLine |hl-StatusLine|
3533 stlnc StatusLineNC |hl-StatusLineNC|
3534 vert VertSplit |hl-VertSplit|
3535 fold Folded |hl-Folded|
3536 diff DiffDelete |hl-DiffDelete|
3537 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003538 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003540 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3541'fixendofline' 'fixeol' boolean (default on)
3542 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003543 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003544 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003545 preserve the situation from the original file.
3546 When the 'binary' option is set the value of this option doesn't
3547 matter.
3548 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003549 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003550
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003552'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 {only available when compiled with the |+rightleft|
3555 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003556 This option was for using Farsi, which has been removed. See
3557 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558
3559 *'foldclose'* *'fcl'*
3560'foldclose' 'fcl' string (default "")
3561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 {not available when compiled without the |+folding|
3563 feature}
3564 When set to "all", a fold is closed when the cursor isn't in it and
3565 its level is higher than 'foldlevel'. Useful if you want folds to
3566 automatically close when moving out of them.
3567
3568 *'foldcolumn'* *'fdc'*
3569'foldcolumn' 'fdc' number (default 0)
3570 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 {not available when compiled without the |+folding|
3572 feature}
3573 When non-zero, a column with the specified width is shown at the side
3574 of the window which indicates open and closed folds. The maximum
3575 value is 12.
3576 See |folding|.
3577
3578 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3579'foldenable' 'fen' boolean (default on)
3580 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 {not available when compiled without the |+folding|
3582 feature}
3583 When off, all folds are open. This option can be used to quickly
3584 switch between showing all text unfolded and viewing the text with
3585 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003586 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 'foldenable' is off.
3588 This option is set by commands that create a new fold or close a fold.
3589 See |folding|.
3590
3591 *'foldexpr'* *'fde'*
3592'foldexpr' 'fde' string (default: "0")
3593 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003595 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003597 for each line to obtain its fold level. The context is set to the
3598 script where 'foldexpr' was set, script-local items can be accessed.
3599 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003600
Bram Moolenaar30b65812012-07-12 22:01:11 +02003601 The expression will be evaluated in the |sandbox| if set from a
3602 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003603 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003604 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003605
3606 It is not allowed to change text or jump to another window while
3607 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608
3609 *'foldignore'* *'fdi'*
3610'foldignore' 'fdi' string (default: "#")
3611 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 {not available when compiled without the |+folding|
3613 feature}
3614 Used only when 'foldmethod' is "indent". Lines starting with
3615 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003616 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 The default "#" works well for C programs. See |fold-indent|.
3618
3619 *'foldlevel'* *'fdl'*
3620'foldlevel' 'fdl' number (default: 0)
3621 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 {not available when compiled without the |+folding|
3623 feature}
3624 Sets the fold level: Folds with a higher level will be closed.
3625 Setting this option to zero will close all folds. Higher numbers will
3626 close fewer folds.
3627 This option is set by commands like |zm|, |zM| and |zR|.
3628 See |fold-foldlevel|.
3629
3630 *'foldlevelstart'* *'fdls'*
3631'foldlevelstart' 'fdls' number (default: -1)
3632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 {not available when compiled without the |+folding|
3634 feature}
3635 Sets 'foldlevel' when starting to edit another buffer in a window.
3636 Useful to always start editing with all folds closed (value zero),
3637 some folds closed (one) or no folds closed (99).
3638 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003639 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 ignores this option and closes all folds.
3641 It is also done before BufReadPre autocommands, to allow an autocmd to
3642 overrule the 'foldlevel' value for specific files.
3643 When the value is negative, it is not used.
3644
3645 *'foldmarker'* *'fmr'* *E536*
3646'foldmarker' 'fmr' string (default: "{{{,}}}")
3647 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 {not available when compiled without the |+folding|
3649 feature}
3650 The start and end marker used when 'foldmethod' is "marker". There
3651 must be one comma, which separates the start and end marker. The
3652 marker is a literal string (a regular expression would be too slow).
3653 See |fold-marker|.
3654
3655 *'foldmethod'* *'fdm'*
3656'foldmethod' 'fdm' string (default: "manual")
3657 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658 {not available when compiled without the |+folding|
3659 feature}
3660 The kind of folding used for the current window. Possible values:
3661 |fold-manual| manual Folds are created manually.
3662 |fold-indent| indent Lines with equal indent form a fold.
3663 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3664 |fold-marker| marker Markers are used to specify folds.
3665 |fold-syntax| syntax Syntax highlighting items specify folds.
3666 |fold-diff| diff Fold text that is not changed.
3667
3668 *'foldminlines'* *'fml'*
3669'foldminlines' 'fml' number (default: 1)
3670 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 {not available when compiled without the |+folding|
3672 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003673 Sets the number of screen lines above which a fold can be displayed
3674 closed. Also for manually closed folds. With the default value of
3675 one a fold can only be closed if it takes up two or more screen lines.
3676 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003677 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 "zc" to close a fold, which is displayed open because it's smaller
3679 than 'foldminlines', a following "zc" may close a containing fold.
3680
3681 *'foldnestmax'* *'fdn'*
3682'foldnestmax' 'fdn' number (default: 20)
3683 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 {not available when compiled without the |+folding|
3685 feature}
3686 Sets the maximum nesting of folds for the "indent" and "syntax"
3687 methods. This avoids that too many folds will be created. Using more
3688 than 20 doesn't work, because the internal limit is 20.
3689
3690 *'foldopen'* *'fdo'*
3691'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3692 search,tag,undo")
3693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 {not available when compiled without the |+folding|
3695 feature}
3696 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003697 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003699 NOTE: When the command is part of a mapping this option is not used.
3700 Add the |zv| command to the mapping to get the same effect.
3701 (rationale: the mapping may want to control opening folds itself)
3702
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 item commands ~
3704 all any
3705 block "(", "{", "[[", "[{", etc.
3706 hor horizontal movements: "l", "w", "fx", etc.
3707 insert any command in Insert mode
3708 jump far jumps: "G", "gg", etc.
3709 mark jumping to a mark: "'m", CTRL-O, etc.
3710 percent "%"
3711 quickfix ":cn", ":crew", ":make", etc.
3712 search search for a pattern: "/", "n", "*", "gd", etc.
3713 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003714 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 tag jumping to a tag: ":ta", CTRL-T, etc.
3716 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 When a movement command is used for an operator (e.g., "dl" or "y%")
3718 this option is not used. This means the operator will include the
3719 whole closed fold.
3720 Note that vertical movements are not here, because it would make it
3721 very difficult to move onto a closed fold.
3722 In insert mode the folds containing the cursor will always be open
3723 when text is inserted.
3724 To close folds you can re-apply 'foldlevel' with the |zx| command or
3725 set the 'foldclose' option to "all".
3726
3727 *'foldtext'* *'fdt'*
3728'foldtext' 'fdt' string (default: "foldtext()")
3729 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 {not available when compiled without the |+folding|
3731 feature}
3732 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003733 fold. The context is set to the script where 'foldexpr' was set,
3734 script-local items can be accessed. See |fold-foldtext| for the
3735 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736
Bram Moolenaar30b65812012-07-12 22:01:11 +02003737 The expression will be evaluated in the |sandbox| if set from a
3738 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003739 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003740
3741 It is not allowed to change text or jump to another window while
3742 evaluating 'foldtext' |textlock|.
3743
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003744 *'formatexpr'* *'fex'*
3745'formatexpr' 'fex' string (default "")
3746 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003747 {not available when compiled without the |+eval|
3748 feature}
3749 Expression which is evaluated to format a range of lines for the |gq|
3750 operator or automatic formatting (see 'formatoptions'). When this
3751 option is empty 'formatprg' is used.
3752
3753 The |v:lnum| variable holds the first line to be formatted.
3754 The |v:count| variable holds the number of lines to be formatted.
3755 The |v:char| variable holds the character that is going to be
3756 inserted if the expression is being evaluated due to
3757 automatic formatting. This can be empty. Don't insert
3758 it yet!
3759
3760 Example: >
3761 :set formatexpr=mylang#Format()
3762< This will invoke the mylang#Format() function in the
3763 autoload/mylang.vim file in 'runtimepath'. |autoload|
3764
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003765 The advantage of using a function call without arguments is that it is
3766 faster, see |expr-option-function|.
3767
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003768 The expression is also evaluated when 'textwidth' is set and adding
3769 text beyond that limit. This happens under the same conditions as
3770 when internal formatting is used. Make sure the cursor is kept in the
3771 same spot relative to the text then! The |mode()| function will
3772 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003773
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003774 When the expression evaluates to non-zero Vim will fall back to using
3775 the internal format mechanism.
3776
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003777 If the expression starts with s: or |<SID>|, then it is replaced with
3778 the script ID (|local-function|). Example: >
3779 set formatexpr=s:MyFormatExpr()
3780 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003781< Otherwise, the expression is evaluated in the context of the script
3782 where the option was set, thus script-local items are available.
3783
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003784 The expression will be evaluated in the |sandbox| when set from a
3785 modeline, see |sandbox-option|. That stops the option from working,
3786 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003787 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003788 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003789
Bram Moolenaar86b68352004-12-27 21:59:20 +00003790 *'formatlistpat'* *'flp'*
3791'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3792 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003793 A pattern that is used to recognize a list header. This is used for
3794 the "n" flag in 'formatoptions'.
3795 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003796 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003797 while still checking more characters. There must be a character
3798 following the pattern, when it matches the whole line it is handled
3799 like there is no match.
3800 The default recognizes a number, followed by an optional punctuation
3801 character and white space.
3802
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003803 *'formatoptions'* *'fo'*
3804'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3805 local to buffer
3806 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003807 formatting is to be done.
3808 See |fo-table| for possible values and |gq| for how to format text.
3809 When the 'paste' option is on, no formatting is done (like
3810 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003811 To avoid problems with flags that are added in the future, use the
3812 "+=" and "-=" feature of ":set" |add-option-flags|.
3813 NOTE: This option is set to the Vi default value when 'compatible' is
3814 set and to the Vim default value when 'compatible' is reset.
3815
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 *'formatprg'* *'fp'*
3817'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003818 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003820 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003822 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003823 If the 'formatexpr' option is not empty it will be used instead.
3824 Otherwise, if 'formatprg' option is an empty string, the internal
3825 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003826 Environment variables are expanded |:set_env|. See |option-backslash|
3827 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003828 This option cannot be set from a |modeline| or in the |sandbox|, for
3829 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830
Bram Moolenaard94464e2015-11-02 15:28:18 +01003831 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003832'fsync' 'fs' boolean (default on)
3833 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003834 When on, the library function fsync() will be called after writing a
3835 file. This will flush a file to disk, ensuring that it is safely
3836 written even on filesystems which do metadata-only journaling. This
3837 will force the harddrive to spin up on Linux systems running in laptop
3838 mode, so it may be undesirable in some situations. Be warned that
3839 turning this off increases the chances of data loss after a crash. On
3840 systems without an fsync() implementation, this variable is always
3841 off.
3842 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003843 'fsync' also applies to |writefile()| (unless a flag is used to
3844 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003845 This option cannot be set from a |modeline| or in the |sandbox|, for
3846 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003847
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3849'gdefault' 'gd' boolean (default off)
3850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 When on, the ":substitute" flag 'g' is default on. This means that
3852 all matches in a line are substituted instead of one. When a 'g' flag
3853 is given to a ":substitute" command, this will toggle the substitution
3854 of all or one match. See |complex-change|.
3855
3856 command 'gdefault' on 'gdefault' off ~
3857 :s/// subst. all subst. one
3858 :s///g subst. one subst. all
3859 :s///gg subst. all subst. one
3860
3861 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003862 Setting this option may break plugins that rely on the default
3863 behavior of the 'g' flag. This will also make the 'g' flag have the
3864 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003865 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866
3867 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003868'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 Format to recognize for the ":grep" command output.
3871 This is a scanf-like string that uses the same format as the
3872 'errorformat' option: see |errorformat|.
3873
3874 *'grepprg'* *'gp'*
3875'grepprg' 'gp' string (default "grep -n ",
3876 Unix: "grep -n $* /dev/null",
3877 Win32: "findstr /n" or "grep -n",
3878 VMS: "SEARCH/NUMBERS ")
3879 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003880 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 and '#' characters, which are expanded like when used in a command-
3882 line. The placeholder "$*" is allowed to specify where the arguments
3883 will be included. Environment variables are expanded |:set_env|. See
3884 |option-backslash| about including spaces and backslashes.
3885 When your "grep" accepts the "-H" argument, use this to make ":grep"
3886 also work well with a single file: >
3887 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003888< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003889 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3890 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003891 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 apply equally to 'grepprg'.
3893 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3894 otherwise it's "grep -n".
3895 This option cannot be set from a |modeline| or in the |sandbox|, for
3896 security reasons.
3897
3898 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3899'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3900 ve:ver35-Cursor,
3901 o:hor50-Cursor,
3902 i-ci:ver25-Cursor/lCursor,
3903 r-cr:hor20-Cursor/lCursor,
3904 sm:block-Cursor
3905 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003906 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 "n-v-c:block,o:hor50,i-ci:hor15,
3908 r-cr:hor30,sm:block")
3909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003911 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003913 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003914 height of the cursor can be changed. This can be done by specifying a
3915 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003916 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3917 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003919 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 mode-list and an argument-list:
3921 mode-list:argument-list,mode-list:argument-list,..
3922 The mode-list is a dash separated list of these modes:
3923 n Normal mode
3924 v Visual mode
3925 ve Visual mode with 'selection' "exclusive" (same as 'v',
3926 if not specified)
3927 o Operator-pending mode
3928 i Insert mode
3929 r Replace mode
3930 c Command-line Normal (append) mode
3931 ci Command-line Insert mode
3932 cr Command-line Replace mode
3933 sm showmatch in Insert mode
3934 a all modes
3935 The argument-list is a dash separated list of these arguments:
3936 hor{N} horizontal bar, {N} percent of the character height
3937 ver{N} vertical bar, {N} percent of the character width
3938 block block cursor, fills the whole character
3939 [only one of the above three should be present]
3940 blinkwait{N} *cursor-blinking*
3941 blinkon{N}
3942 blinkoff{N}
3943 blink times for cursor: blinkwait is the delay before
3944 the cursor starts blinking, blinkon is the time that
3945 the cursor is shown and blinkoff is the time that the
3946 cursor is not shown. The times are in msec. When one
3947 of the numbers is zero, there is no blinking. The
3948 default is: "blinkwait700-blinkon400-blinkoff250".
3949 These numbers are used for a missing entry. This
3950 means that blinking is enabled by default. To switch
3951 blinking off you can use "blinkon0". The cursor only
3952 blinks when Vim is waiting for input, not while
3953 executing a command.
3954 To make the cursor blink in an xterm, see
3955 |xterm-blink|.
3956 {group-name}
3957 a highlight group name, that sets the color and font
3958 for the cursor
3959 {group-name}/{group-name}
3960 Two highlight group names, the first is used when
3961 no language mappings are used, the other when they
3962 are. |language-mapping|
3963
3964 Examples of parts:
3965 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3966 block cursor with colors from the "nCursor"
3967 highlight group
3968 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3969 In Insert and Command-line Insert mode, use a
3970 30% vertical bar cursor with colors from the
3971 "iCursor" highlight group. Blink a bit
3972 faster.
3973
3974 The 'a' mode is different. It will set the given argument-list for
3975 all modes. It does not reset anything to defaults. This can be used
3976 to do a common setting for all modes. For example, to switch off
3977 blinking: "a:blinkon0"
3978
3979 Examples of cursor highlighting: >
3980 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3981 :highlight Cursor gui=NONE guifg=bg guibg=fg
3982<
3983 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003984 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985'guifont' 'gfn' string (default "")
3986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 {only available when compiled with GUI enabled}
3988 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003989 In its simplest form the value is just one font name.
3990 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991
3992 *'guifontset'* *'gfs'*
3993 *E250* *E252* *E234* *E597* *E598*
3994'guifontset' 'gfs' string (default "")
3995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 {only available when compiled with GUI enabled and
3997 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003998 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 When not empty, specifies two (or more) fonts to be used. The first
4000 one for normal English, the second one for your special language. See
4001 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004002
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4004'guifontwide' 'gfw' string (default "")
4005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 {only available when compiled with GUI enabled}
4007 When not empty, specifies a comma-separated list of fonts to be used
4008 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004009 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004010
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 *'guiheadroom'* *'ghr'*
4012'guiheadroom' 'ghr' number (default 50)
4013 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004014 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 The number of pixels subtracted from the screen height when fitting
4016 the GUI window on the screen. Set this before the GUI is started,
4017 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004018 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 lines will be left for window decorations and other items on the
4020 screen. Set it to a negative value to allow windows taller than the
4021 screen.
4022
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004023 *'guiligatures'* *'gli'* *E1243*
4024'guiligatures' 'gli' string (default "")
4025 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004026 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004027 List of ASCII characters that, when combined together, can create more
4028 complex shapes. Each character must be a printable ASCII character
4029 with a value in the 32-127 range.
4030 Example: >
4031 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4032< Changing this option updates screen output immediately. Set it to an
4033 empty string to disable ligatures.
4034
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004036'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4037 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004038 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004039 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004042 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 sequence of letters which describes what components and options of the
4044 GUI should be used.
4045 To avoid problems with flags that are added in the future, use the
4046 "+=" and "-=" feature of ":set" |add-option-flags|.
4047
Bram Moolenaar13568252018-03-16 20:46:58 +01004048 Valid characters are as follows:
4049 *'go-!'*
4050 '!' External commands are executed in a terminal window. Without
4051 this flag the MS-Windows GUI will open a console window to
4052 execute the command. The Unix GUI will simulate a dumb
4053 terminal to list the command output.
4054 The terminal window will be positioned at the bottom, and grow
4055 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004056 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 'a' Autoselect: If present, then whenever VISUAL mode is started,
4058 or the Visual area extended, Vim tries to become the owner of
4059 the windowing system's global selection. This means that the
4060 Visually highlighted text is available for pasting into other
4061 applications as well as into Vim itself. When the Visual mode
4062 ends, possibly due to an operation on the text, or when an
4063 application wants to paste the selection, the highlighted text
4064 is automatically yanked into the "* selection register.
4065 Thus the selection is still available for pasting into other
4066 applications after the VISUAL mode has ended.
4067 If not present, then Vim won't become the owner of the
4068 windowing system's global selection unless explicitly told to
4069 by a yank or delete operation for the "* register.
4070 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004071 *'go-P'*
4072 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004073 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004074 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004075 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 applies to the modeless selection.
4077
4078 'guioptions' autoselect Visual autoselect modeless ~
4079 "" - -
4080 "a" yes yes
4081 "A" - yes
4082 "aA" yes yes
4083
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004084 When using a terminal see the 'clipboard' option.
4085
Bram Moolenaar02467872007-05-06 13:22:01 +00004086 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004087 'c' Use console dialogs instead of popup dialogs for simple
4088 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004089 *'go-d'*
4090 'd' Use dark theme variant if available. Currently only works for
4091 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004092 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004093 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004094 'guitablabel' can be used to change the text in the labels.
4095 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004096 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004097 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004098 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 'f' Foreground: Don't use fork() to detach the GUI from the shell
4100 where it was started. Use this for programs that wait for the
4101 editor to finish (e.g., an e-mail program). Alternatively you
4102 can use "gvim -f" or ":gui -f" to start the GUI in the
4103 foreground. |gui-fork|
4104 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004105 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004106 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4108 corner of the window. It's black&white on non-GTK, because of
4109 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004110 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004112 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004113 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004115 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004117 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004118 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 'g' Grey menu items: Make menu items that are not active grey. If
4120 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004121 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 't' Include tearoff menu items. Currently only works for Win32,
4123 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004124 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004125 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4126 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004127 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004129 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 'R' Right-hand scrollbar is present when there is a vertically
4131 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004132 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004134 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 'L' Left-hand scrollbar is present when there is a vertically
4136 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004137 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4139 the longest visible line, or on the cursor line if the 'h'
4140 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004141 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 'h' Limit horizontal scrollbar size to the length of the cursor
4143 line. Reduces computations. |gui-horiz-scroll|
4144
4145 And yes, you may even have scrollbars on the left AND the right if
4146 you really want to :-). See |gui-scrollbars| for more information.
4147
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004148 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 'v' Use a vertical button layout for dialogs. When not included,
4150 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004151 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004152 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 'p' Use Pointer callbacks for X11 GUI. This is required for some
4154 window managers. If the cursor is not blinking or hollow at
4155 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004156 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004158 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004159 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004160 *'go-k'*
4161 'k' Keep the GUI window size when adding/removing a scrollbar, or
4162 toolbar, tabline, etc. Instead, the behavior is similar to
4163 when the window is maximized and will adjust 'lines' and
4164 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004165 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004166 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004167
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 *'guipty'* *'noguipty'*
4169'guipty' boolean (default on)
4170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 {only available when compiled with GUI enabled}
4172 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4173 I/O to/from shell commands. See |gui-pty|.
4174
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004175 *'guitablabel'* *'gtl'*
4176'guitablabel' 'gtl' string (default empty)
4177 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004178 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004179 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004180 pages line. When empty and when the result is empty Vim will use a
4181 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004182
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004183 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004184 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004185 The expression will be evaluated in the |sandbox| when set from a
4186 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004187 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004188
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004189 Only used when the GUI tab pages line is displayed. 'e' must be
4190 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4191 used.
4192
Bram Moolenaar57657d82006-04-21 22:12:41 +00004193 *'guitabtooltip'* *'gtt'*
4194'guitabtooltip' 'gtt' string (default empty)
4195 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004196 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004197 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004198 pages line. When empty Vim will use a default tooltip.
4199 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004200 You can include a line break. Simplest method is to use |:let|: >
4201 :let &guitabtooltip = "line one\nline two"
4202<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004203
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004205'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 (others) "$VIMRUNTIME/doc/help.txt")
4207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 Name of the main help file. All distributed help files should be
4209 placed together in one directory. Additionally, all "doc" directories
4210 in 'runtimepath' will be used.
4211 Environment variables are expanded |:set_env|. For example:
4212 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004213 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 spaces and backslashes.
4215 This option cannot be set from a |modeline| or in the |sandbox|, for
4216 security reasons.
4217
4218 *'helpheight'* *'hh'*
4219'helpheight' 'hh' number (default 20)
4220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 Minimal initial height of the help window when it is opened with the
4222 ":help" command. The initial height of the help window is half of the
4223 current window, or (when the 'ea' option is on) the same as other
4224 windows. When the height is less than 'helpheight', the height is
4225 set to 'helpheight'. Set to zero to disable.
4226
4227 *'helplang'* *'hlg'*
4228'helplang' 'hlg' string (default: messages language or empty)
4229 global
4230 {only available when compiled with the |+multi_lang|
4231 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004232 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 for which the desired help can be found. The English help will always
4234 be used as a last resort. You can add "en" to prefer English over
4235 another language, but that will only find tags that exist in that
4236 language and not in the English help.
4237 Example: >
4238 :set helplang=de,it
4239< This will first search German, then Italian and finally English help
4240 files.
4241 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4242 try to find the tag in the current language before using this option.
4243 See |help-translated|.
4244
4245 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4246'hidden' 'hid' boolean (default off)
4247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 When off a buffer is unloaded when it is |abandon|ed. When on a
4249 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4250 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004251
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004253 hidden even if the 'hidden' option is off when these three are true:
4254 - the buffer is modified
4255 - 'autowrite' is off or writing is not possible
4256 - the '!' flag was used
4257 Also see |windows.txt|.
4258
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004259 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 This option is set for one command with ":hide {command}" |:hide|.
4261 WARNING: It's easy to forget that you have changes in hidden buffers.
4262 Think twice when using ":q!" or ":qa!".
4263
4264 *'highlight'* *'hl'*
4265'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004266 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4267 d:Directory,e:ErrorMsg,i:IncSearch,
4268 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004269 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004270 N:CursorLineNr,r:Question,s:StatusLine,
4271 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004272 v:Visual,V:VisualNOS,w:WarningMsg,
4273 W:WildMenu,f:Folded,F:FoldColumn,
4274 A:DiffAdd,C:DiffChange,D:DiffDelete,
4275 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004276 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004277 L:SpellLocal,+:Pmenu,=:PmenuSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004278 [:PmenuKind,]:PmenuKindSel,
4279 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004280 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4281 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004282 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004283 z:StatusLineTerm,Z:StatusLineTermNC,
4284 g:MsgArea")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004287 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004289 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004291 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4292 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 characters from 'showbreak'
4294 |hl-Directory| d directories in CTRL-D listing and other special
4295 things in listings
4296 |hl-ErrorMsg| e error messages
4297 h (obsolete, ignored)
4298 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004299 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4301 |hl-MoreMsg| m |more-prompt|
4302 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004303 |hl-MsgArea| g |Command-line| and message area
Bram Moolenaar64486672010-05-16 15:46:46 +02004304 |hl-LineNr| n line number for ":number" and ":#" commands, and
4305 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004306 |hl-LineNrAbove| a line number above the cursor for when the
4307 'relativenumber' option is set.
4308 |hl-LineNrBelow| b line number below the cursor for when the
4309 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004310 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4311 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 |hl-Question| r |hit-enter| prompt and yes/no questions
4313 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004314 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4316 |hl-VertSplit| c column used to separate vertically split windows
4317 |hl-Visual| v Visual mode
4318 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4319 Selection" Only X11 Gui's |gui-x11| and
4320 |xterm-clipboard|.
4321 |hl-WarningMsg| w warning messages
4322 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4323 |hl-Folded| f line used for closed folds
4324 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004325 |hl-DiffAdd| A added line in diff mode
4326 |hl-DiffChange| C changed line in diff mode
4327 |hl-DiffDelete| D deleted line in diff mode
4328 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004330 |hl-Conceal| - the placeholders used for concealed characters
4331 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004332 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004333 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004334 |hl-SpellRare| R rare word |spell|
4335 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004336 |hl-Pmenu| + popup menu normal line
4337 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004338 |hl-PmenuKind| [ popup menu "kind" normal line
4339 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004340 |hl-PmenuExtra| { popup menu "extra" normal line
4341 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004342 |hl-PmenuSbar| x popup menu scrollbar
4343 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344
4345 The display modes are:
4346 r reverse (termcap entry "mr" and "me")
4347 i italic (termcap entry "ZH" and "ZR")
4348 b bold (termcap entry "md" and "me")
4349 s standout (termcap entry "so" and "se")
4350 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004351 c undercurl (termcap entry "Us" and "Ce")
4352 2 double underline (termcap entry "Ds" and "Ce")
4353 d dotted underline (termcap entry "ds" and "Ce")
4354 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004355 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 n no highlighting
4357 - no highlighting
4358 : use a highlight group
4359 The default is used for occasions that are not included.
4360 If you want to change what the display modes do, see |dos-colors|
4361 for an example.
4362 When using the ':' display mode, this must be followed by the name of
4363 a highlight group. A highlight group can be used to define any type
4364 of highlighting, including using color. See |:highlight| on how to
4365 define one. The default uses a different group for each occasion.
4366 See |highlight-default| for the default highlight groups.
4367
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004369'history' 'hi' number (Vim default: 50, Vi default: 0,
4370 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004373 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004375 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 NOTE: This option is set to the Vi default value when 'compatible' is
4377 set and to the Vim default value when 'compatible' is reset.
4378
4379 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4380'hkmap' 'hk' boolean (default off)
4381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 {only available when compiled with the |+rightleft|
4383 feature}
4384 When on, the keyboard is mapped for the Hebrew character set.
4385 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4386 toggle this option. See |rileft.txt|.
4387 NOTE: This option is reset when 'compatible' is set.
4388
4389 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4390'hkmapp' 'hkp' boolean (default off)
4391 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392 {only available when compiled with the |+rightleft|
4393 feature}
4394 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4395 This is useful if you have a non-Hebrew keyboard.
4396 See |rileft.txt|.
4397 NOTE: This option is reset when 'compatible' is set.
4398
Bram Moolenaar036986f2017-03-16 17:41:02 +01004399 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4400'hlsearch' 'hls' boolean (default off)
4401 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004402 {not available when compiled without the
4403 |+extra_search| feature}
4404 When there is a previous search pattern, highlight all its matches.
4405 The type of highlighting used can be set with the 'l' occasion in the
4406 'highlight' option. This uses the "Search" highlight group by
4407 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004408 are not applied. If the "CurSearch" highlight group is set then the
4409 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004410 See also: 'incsearch' and |:match|.
4411 When you get bored looking at the highlighted matches, you can turn it
4412 off with |:nohlsearch|. This does not change the option value, as
4413 soon as you use a search command, the highlighting comes back.
4414 'redrawtime' specifies the maximum time spent on finding matches.
4415 When the search pattern can match an end-of-line, Vim will try to
4416 highlight all of the matched text. However, this depends on where the
4417 search starts. This will be the first line in the window or the first
4418 line below a closed fold. A match in a previous line which is not
4419 drawn may not continue in a newly drawn line.
4420 You can specify whether the highlight status is restored on startup
4421 with the 'h' flag in 'viminfo' |viminfo-h|.
4422 NOTE: This option is reset when 'compatible' is set.
4423
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 *'icon'* *'noicon'*
4425'icon' boolean (default off, on when title can be restored)
4426 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 When on, the icon text of the window will be set to the value of
4428 'iconstring' (if it is not empty), or to the name of the file
4429 currently being edited. Only the last part of the name is used.
4430 Overridden by the 'iconstring' option.
4431 Only works if the terminal supports setting window icons (currently
4432 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4433 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4434 builtin termcap).
4435 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004436 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004438 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439
4440 *'iconstring'*
4441'iconstring' string (default "")
4442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 When this option is not empty, it will be used for the icon text of
4444 the window. This happens only when the 'icon' option is on.
4445 Only works if the terminal supports setting window icon text
4446 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004447 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 When Vim was compiled with HAVE_X11 defined, the original icon will be
4449 restored if possible |X11|.
4450 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004451 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004453 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 {not available when compiled without the |+statusline| feature}
4455
4456 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4457'ignorecase' 'ic' boolean (default off)
4458 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004459 Ignore case in search patterns, |cmdline-completion|, when
4460 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004461 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 Can be overruled by using "\c" or "\C" in the pattern, see
4463 |/ignorecase|.
4464
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004465 *'imactivatefunc'* *'imaf'*
4466'imactivatefunc' 'imaf' string (default "")
4467 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004468 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004469 activate or deactivate the Input Method. The value can be the name of
4470 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4471 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004472 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004473 The expression will be evaluated in the |sandbox| when set from a
4474 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004475
4476 Example: >
4477 function ImActivateFunc(active)
4478 if a:active
4479 ... do something
4480 else
4481 ... do something
4482 endif
4483 " return value is not used
4484 endfunction
4485 set imactivatefunc=ImActivateFunc
4486<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 *'imactivatekey'* *'imak'*
4488'imactivatekey' 'imak' string (default "")
4489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004491 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 Specifies the key that your Input Method in X-Windows uses for
4493 activation. When this is specified correctly, vim can fully control
4494 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4495 You can't use this option to change the activation key, the option
4496 tells Vim what the key is.
4497 Format:
4498 [MODIFIER_FLAG-]KEY_STRING
4499
4500 These characters can be used for MODIFIER_FLAG (case is ignored):
4501 S Shift key
4502 L Lock key
4503 C Control key
4504 1 Mod1 key
4505 2 Mod2 key
4506 3 Mod3 key
4507 4 Mod4 key
4508 5 Mod5 key
4509 Combinations are allowed, for example "S-C-space" or "SC-space" are
4510 both shift+ctrl+space.
4511 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4512
4513 Example: >
4514 :set imactivatekey=S-space
4515< "S-space" means shift+space. This is the activation key for kinput2 +
4516 canna (Japanese), and ami (Korean).
4517
4518 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4519'imcmdline' 'imc' boolean (default off)
4520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 When set the Input Method is always on when starting to edit a command
4522 line, unless entering a search pattern (see 'imsearch' for that).
4523 Setting this option is useful when your input method allows entering
4524 English characters directly, e.g., when it's used to type accented
4525 characters with dead keys.
4526
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004527 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 When set the Input Method is never used. This is useful to disable
4531 the IM when it doesn't work properly.
4532 Currently this option is on by default for SGI/IRIX machines. This
4533 may change in later releases.
4534
4535 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004536'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 Specifies whether :lmap or an Input Method (IM) is to be used in
4539 Insert mode. Valid values:
4540 0 :lmap is off and IM is off
4541 1 :lmap is ON and IM is off
4542 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 To always reset the option to zero when leaving Insert mode with <Esc>
4544 this can be used: >
4545 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4546< This makes :lmap and IM turn off automatically when leaving Insert
4547 mode.
4548 Note that this option changes when using CTRL-^ in Insert mode
4549 |i_CTRL-^|.
4550 The value is set to 1 when setting 'keymap' to a valid keymap name.
4551 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004552 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 methods. Use 'imdisable' to disable XIM then.
4554
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004555 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004556 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004557 |+multi_byte_ime| or |global-ime|.
4558
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004560'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 Specifies whether :lmap or an Input Method (IM) is to be used when
4563 entering a search pattern. Valid values:
4564 -1 the value of 'iminsert' is used, makes it look like
4565 'iminsert' is also used when typing a search pattern
4566 0 :lmap is off and IM is off
4567 1 :lmap is ON and IM is off
4568 2 :lmap is off and IM is ON
4569 Note that this option changes when using CTRL-^ in Command-line mode
4570 |c_CTRL-^|.
4571 The value is set to 1 when it is not -1 and setting the 'keymap'
4572 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004573 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 methods. Use 'imdisable' to disable XIM then.
4575
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004576 *'imstatusfunc'* *'imsf'*
4577'imstatusfunc' 'imsf' string (default "")
4578 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004579 This option specifies a function that is called to obtain the status
4580 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004581 The value can be the name of a function, a |lambda| or a |Funcref|.
4582 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004583 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004584
4585 Example: >
4586 function ImStatusFunc()
4587 let is_active = ...do something
4588 return is_active ? 1 : 0
4589 endfunction
4590 set imstatusfunc=ImStatusFunc
4591<
4592 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004593 The expression will be evaluated in the |sandbox| when set from a
4594 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004595
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004596 *'imstyle'* *'imst'*
4597'imstyle' 'imst' number (default 1)
4598 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004599 {only available when compiled with |+xim| and
4600 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004601 This option specifies the input style of Input Method:
4602 0 use on-the-spot style
4603 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004604 See: |xim-input-style|
4605
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004606 For a long time on-the-spot style had been used in the GTK version of
4607 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004608 |single-repeat|, etc. Therefore over-the-spot style becomes the
4609 default now. This should work fine for most people, however if you
4610 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004611 The expression will be evaluated in the |sandbox| when set from a
4612 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004613
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 *'include'* *'inc'*
4615'include' 'inc' string (default "^\s*#\s*include")
4616 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 {not available when compiled without the
4618 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004619 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 pattern, just like for the "/" command (See |pattern|). The default
4621 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004622 "]I", "[d", etc.
4623 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004624 comes after the matched pattern. But if "\zs" appears in the pattern
4625 then the text matched from "\zs" to the end, or until "\ze" if it
4626 appears, is used as the file name. Use this to include characters
4627 that are not in 'isfname', such as a space. You can then use
4628 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004629 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630
4631 *'includeexpr'* *'inex'*
4632'includeexpr' 'inex' string (default "")
4633 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004635 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004637 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004638 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004640 Note the double backslash: the `:set` command first halves them, then
4641 one remains it the value, where "\." matches a dot literally. For
4642 simple character replacements `tr()` avoids the need for escaping: >
4643 :setlocal includeexpr=tr(v:fname,'.','/')
4644<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004646 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 Also used for |<cfile>|.
4648
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004649 If the expression starts with s: or |<SID>|, then it is replaced with
4650 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004651 setlocal includeexpr=s:MyIncludeExpr()
4652 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004653< Otherwise, the expression is evaluated in the context of the script
4654 where the option was set, thus script-local items are available.
4655
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004656 It is more efficient if the value is just a function call without
4657 arguments, see |expr-option-function|.
4658
Bram Moolenaar30b65812012-07-12 22:01:11 +02004659 The expression will be evaluated in the |sandbox| when set from a
4660 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004661 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004662
4663 It is not allowed to change text or jump to another window while
4664 evaluating 'includeexpr' |textlock|.
4665
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004667'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004668 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004671 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004672 While typing a search command, show where the pattern, as it was typed
4673 so far, matches. The matched string is highlighted. If the pattern
4674 is invalid or not found, nothing is shown. The screen will be updated
4675 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004676 Also applies to the pattern in commands: >
4677 :global
4678 :lvimgrep
4679 :lvimgrepadd
4680 :smagic
4681 :snomagic
4682 :sort
4683 :substitute
4684 :vglobal
4685 :vimgrep
4686 :vimgrepadd
4687< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004688 original position when no match is found and when pressing <Esc>. You
4689 still need to finish the search command with <Enter> to move the
4690 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004691 You can use the CTRL-G and CTRL-T keys to move to the next and
4692 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004693 When compiled with the |+reltime| feature Vim only searches for about
4694 half a second. With a complicated pattern and/or a lot of text the
4695 match may not be found. This is to avoid that Vim hangs while you
4696 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004697 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004698 When 'hlsearch' is on, all matched strings are highlighted too while
4699 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004700 If you don't want to turn 'hlsearch' on, but want to highlight all
4701 matches while searching, you can turn on and off 'hlsearch' with
4702 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004703 augroup vimrc-incsearch-highlight
4704 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004705 autocmd CmdlineEnter /,\? :set hlsearch
4706 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004707 augroup END
4708<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004709 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004710 to the command line. If 'ignorecase' and 'smartcase' are set and the
4711 command line has no uppercase characters, the added character is
4712 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004713 CTRL-R CTRL-W can be used to add the word at the end of the current
4714 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 NOTE: This option is reset when 'compatible' is set.
4716
4717 *'indentexpr'* *'inde'*
4718'indentexpr' 'inde' string (default "")
4719 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004720 {not available when compiled without the |+eval|
4721 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 Expression which is evaluated to obtain the proper indent for a line.
4723 It is used when a new line is created, for the |=| operator and
4724 in Insert mode as specified with the 'indentkeys' option.
4725 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004726 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004727 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 When 'paste' is set this option is not used for indenting.
4729 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004730 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004732
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004733 If the expression starts with s: or |<SID>|, then it is replaced with
4734 the script ID (|local-function|). Example: >
4735 set indentexpr=s:MyIndentExpr()
4736 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004737< Otherwise, the expression is evaluated in the context of the script
4738 where the option was set, thus script-local items are available.
4739
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004740 The advantage of using a function call without arguments is that it is
4741 faster, see |expr-option-function|.
4742
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 The expression must return the number of spaces worth of indent. It
4744 can return "-1" to keep the current indent (this means 'autoindent' is
4745 used for the indent).
4746 Functions useful for computing the indent are |indent()|, |cindent()|
4747 and |lispindent()|.
4748 The evaluation of the expression must not have side effects! It must
4749 not change the text, jump to another window, etc. Afterwards the
4750 cursor position is always restored, thus the cursor may be moved.
4751 Normally this option would be set to call a function: >
4752 :set indentexpr=GetMyIndent()
4753< Error messages will be suppressed, unless the 'debug' option contains
4754 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004755 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004756 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757
Bram Moolenaar30b65812012-07-12 22:01:11 +02004758 The expression will be evaluated in the |sandbox| when set from a
4759 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004760 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004761
4762 It is not allowed to change text or jump to another window while
4763 evaluating 'indentexpr' |textlock|.
4764
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004766'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 A list of keys that, when typed in Insert mode, cause reindenting of
4769 the current line. Only happens if 'indentexpr' isn't empty.
4770 The format is identical to 'cinkeys', see |indentkeys-format|.
4771 See |C-indenting| and |indent-expression|.
4772
4773 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4774'infercase' 'inf' boolean (default off)
4775 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004777 'ignorecase' is also on, the case of the match is adjusted depending
4778 on the typed text. If the typed text contains a lowercase letter
4779 where the match has an upper case letter, the completed part is made
4780 lowercase. If the typed text has no lowercase letters and the match
4781 has a lowercase letter where the typed text has an uppercase letter,
4782 and there is a letter before it, the completed part is made uppercase.
4783 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784
4785 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4786'insertmode' 'im' boolean (default off)
4787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 Makes Vim work in a way that Insert mode is the default mode. Useful
4789 if you want to use Vim as a modeless editor. Used for |evim|.
4790 These Insert mode commands will be useful:
4791 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004792 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 this is a mapping, it is executed as if 'insertmode' was off.
4794 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004796 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4797 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798
4799 These items change when 'insertmode' is set:
4800 - when starting to edit of a file, Vim goes to Insert mode.
4801 - <Esc> in Insert mode is a no-op and beeps.
4802 - <Esc> in Normal mode makes Vim go to Insert mode.
4803 - CTRL-L in Insert mode is a command, it is not inserted.
4804 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4805 However, when <Esc> is used inside a mapping, it behaves like
4806 'insertmode' was not set. This was done to be able to use the same
4807 mappings with 'insertmode' set or not set.
4808 When executing commands with |:normal| 'insertmode' is not used.
4809
4810 NOTE: This option is reset when 'compatible' is set.
4811
4812 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004813'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4815 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4816 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4817 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4818 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 The characters specified by this option are included in file names and
4821 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004822 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 Multi-byte characters 256 and above are always included, only the
4824 characters up to 255 are specified with this option.
4825 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004826 Think twice before adding white space to this option. Although a
4827 space may appear inside a file name, the effect will be that Vim
4828 doesn't know where a file name starts or ends when doing completion.
4829 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830
4831 Note that on systems using a backslash as path separator, Vim tries to
4832 do its best to make it work as you would expect. That is a bit
4833 tricky, since Vi originally used the backslash to escape special
4834 characters. Vim will not remove a backslash in front of a normal file
4835 name character on these systems, but it will on Unix and alikes. The
4836 '&' and '^' are not included by default, because these are special for
4837 cmd.exe.
4838
4839 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004840 Each part can be a single character number or a range. A range is two
4841 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 decimal number between 0 and 255 or the ASCII character itself (does
4843 not work for digits). Example:
4844 "_,-,128-140,#-43" (include '_' and '-' and the range
4845 128 to 140 and '#' to 43)
4846 If a part starts with '^', the following character number or range
4847 will be excluded from the option. The option is interpreted from left
4848 to right. Put the excluded character after the range where it is
4849 included. To include '^' itself use it as the last character of the
4850 option or the end of a range. Example:
4851 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4852 If the character is '@', all characters where isalpha() returns TRUE
4853 are included. Normally these are the characters a to z and A to Z,
4854 plus accented characters. To include '@' itself use "@-@". Examples:
4855 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004856 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 "a-z,A-Z,@-@" All letters plus the '@' character.
4858 A comma can be included by using it where a character number is
4859 expected. Example:
4860 "48-57,,,_" Digits, comma and underscore.
4861 A comma can be excluded by prepending a '^'. Example:
4862 " -~,^,,9" All characters from space to '~', excluding
4863 comma, plus <Tab>.
4864 See |option-backslash| about including spaces and backslashes.
4865
4866 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004867'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 "@,48-57,_,128-167,224-235"
4869 otherwise: "@,48-57,_,192-255")
4870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 The characters given by this option are included in identifiers.
4872 Identifiers are used in recognizing environment variables and after a
4873 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004874 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004875 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004877 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4879
4880 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004881'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 "@,48-57,_,128-167,224-235"
4883 otherwise: "@,48-57,_,192-255"
4884 Vi default: "@,48-57,_")
4885 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004887 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004888 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004889 characters above 255 check the "word" character class (any character
4890 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004891 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 For a help file it is set to all non-blank printable characters except
4893 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4894 command).
4895 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004896 This option also influences syntax highlighting, unless the syntax
4897 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 NOTE: This option is set to the Vi default value when 'compatible' is
4899 set and to the Vim default value when 'compatible' is reset.
4900
4901 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004902'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 "@,~-255"; otherwise: "@,161-255")
4904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 The characters given by this option are displayed directly on the
4906 screen. It is also used for "\p" in a |pattern|. The characters from
4907 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4908 even when they are not included in 'isprint' or excluded. See
4909 'isfname' for a description of the format of this option.
4910
4911 Non-printable characters are displayed with two characters:
4912 0 - 31 "^@" - "^_"
4913 32 - 126 always single characters
4914 127 "^?"
4915 128 - 159 "~@" - "~_"
4916 160 - 254 "| " - "|~"
4917 255 "~?"
4918 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4919 displayed as <xx>, with the hexadecimal value of the byte.
4920 When 'display' contains "uhex" all unprintable characters are
4921 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004922 The SpecialKey highlighting will be used for unprintable characters.
4923 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924
4925 Multi-byte characters 256 and above are always included, only the
4926 characters up to 255 are specified with this option. When a character
4927 is printable but it is not available in the current font, a
4928 replacement character will be shown.
4929 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4930 There is no option to specify these characters.
4931
4932 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4933'joinspaces' 'js' boolean (default on)
4934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 Insert two spaces after a '.', '?' and '!' with a join command.
4936 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4937 Otherwise only one space is inserted.
4938 NOTE: This option is set when 'compatible' is set.
4939
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004940 *'jumpoptions'* *'jop'*
4941'jumpoptions' 'jop' string (default "")
4942 global
4943 List of words that change the behavior of the |jumplist|.
4944 stack Make the jumplist behave like the tagstack.
4945 Relative location of entries in the jumplist is
4946 preserved at the cost of discarding subsequent entries
4947 when navigating backwards in the jumplist and then
4948 jumping to a location. |jumplist-stack|
4949
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 *'key'*
4951'key' string (default "")
4952 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004953 {only available when compiled with the |+cryptv|
4954 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004956 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 Careful: Do not set the key value by hand, someone might see the typed
4958 key. Use the |:X| command. But you can make 'key' empty: >
4959 :set key=
4960< It is not possible to get the value of this option with ":set key" or
4961 "echo &key". This is to avoid showing it to someone who shouldn't
4962 know. It also means you cannot see it yourself once you have set it,
4963 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004964 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4965 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004966 You can use "&key" in an expression to detect whether encryption is
4967 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968
4969 *'keymap'* *'kmp'* *E544*
4970'keymap' 'kmp' string (default "")
4971 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 {only available when compiled with the |+keymap|
4973 feature}
4974 Name of a keyboard mapping. See |mbyte-keymap|.
4975 Setting this option to a valid keymap name has the side effect of
4976 setting 'iminsert' to one, so that the keymap becomes effective.
4977 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004978 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979
4980 *'keymodel'* *'km'*
4981'keymodel' 'km' string (default "")
4982 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004983 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 can do. These values can be used:
4985 startsel Using a shifted special key starts selection (either
4986 Select mode or Visual mode, depending on "key" being
4987 present in 'selectmode').
4988 stopsel Using a not-shifted special key stops selection.
4989 Special keys in this context are the cursor keys, <End>, <Home>,
4990 <PageUp> and <PageDown>.
4991 The 'keymodel' option is set by the |:behave| command.
4992
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004993 *'keyprotocol'* *'kpc'*
4994'keyprotocol' 'kpc' string (default: see below)
4995 global
4996 Specifies what keyboard protocol to use depending on the value of
4997 'term'. The supported keyboard protocols names are:
4998 none whatever the terminal uses
4999 mok2 modifyOtherKeys level 2, as supported by xterm
5000 kitty Kitty keyboard protocol, as supported by Kitty
5001
Bram Moolenaara87749e2022-11-30 10:23:17 +00005002 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005003 a pattern that is matched against the 'term' option, a colon and the
5004 protocol name to be used. To illustrate this, the default value would
5005 be set with: >
5006 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
5007
5008< This means that when 'term' contains "kitty, "foot" or "wezterm"
5009 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00005010 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005011
5012 The first match is used, thus if you want to have "kitty" use the
5013 kitty protocol, but "badkitty" not, then you should match "badkitty"
5014 first and use the "none" value: >
5015 set keyprotocol=badkitty:none,kitty:kitty
5016<
5017 The option is used after 'term' has been changed. First the termcap
5018 entries are set, possibly using the builtin list, see |builtin-terms|.
5019 Then this option is inspected and if there is a match and a protocol
5020 is specified the following happens:
5021 none Nothing, the regular t_TE and t_TI values remain
5022
5023 mok2 The t_TE value is changed to:
5024 CSI >4;m disables modifyOtherKeys
5025 The t_TI value is changed to:
5026 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005027 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005028
5029 kitty The t_TE value is changed to:
5030 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005031 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005032 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005033 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005034 CSI ?u request kitty keyboard protocol state
5035 CSI >c request the termresponse
5036
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005037 If you notice problems, such as characters being displayed that
5038 disappear after `CTRL-L`, you might want to try making this option
5039 empty. Then set the 'term' option to have it take effect: >
5040 set keyprotocol=
5041 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005042<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005043
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 *'keywordprg'* *'kp'*
5045'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005046 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 Program to use for the |K| command. Environment variables are
5049 expanded |:set_env|. ":help" may be used to access the Vim internal
5050 help. (Note that previously setting the global option to the empty
5051 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005052 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005053 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005054 When "man", "man -s" or an Ex command is used, Vim will automatically
5055 translate a count for the "K" command and pass it as the first
5056 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057 See |option-backslash| about including spaces and backslashes.
5058 Example: >
5059 :set keywordprg=man\ -s
5060< This option cannot be set from a |modeline| or in the |sandbox|, for
5061 security reasons.
5062
5063 *'langmap'* *'lmap'* *E357* *E358*
5064'langmap' 'lmap' string (default "")
5065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 {only available when compiled with the |+langmap|
5067 feature}
5068 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005069 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005070 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 care of translating these special characters to the original meaning
5072 of the key. This means you don't have to change the keyboard mode to
5073 be able to execute Normal mode commands.
5074 This is the opposite of the 'keymap' option, where characters are
5075 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005076 Also consider setting 'langremap' to off, to prevent 'langmap' from
5077 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005078 This option cannot be set from a |modeline| or in the |sandbox|, for
5079 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005081 Example (for Greek, in UTF-8): *greek* >
5082 :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 +00005083< Example (exchanges meaning of z and y for commands): >
5084 :set langmap=zy,yz,ZY,YZ
5085<
5086 The 'langmap' option is a list of parts, separated with commas. Each
5087 part can be in one of two forms:
5088 1. A list of pairs. Each pair is a "from" character immediately
5089 followed by the "to" character. Examples: "aA", "aAbBcC".
5090 2. A list of "from" characters, a semi-colon and a list of "to"
5091 characters. Example: "abc;ABC"
5092 Example: "aA,fgh;FGH,cCdDeE"
5093 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005094 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095
5096 This will allow you to activate vim actions without having to switch
5097 back and forth between the languages. Your language characters will
5098 be understood as normal vim English characters (according to the
5099 langmap mappings) in the following cases:
5100 o Normal/Visual mode (commands, buffer/register names, user mappings)
5101 o Insert/Replace Mode: Register names after CTRL-R
5102 o Insert/Replace Mode: Mappings
5103 Characters entered in Command-line mode will NOT be affected by
5104 this option. Note that this option can be changed at any time
5105 allowing to switch between mappings for different languages/encodings.
5106 Use a mapping to avoid having to type it each time!
5107
5108 *'langmenu'* *'lm'*
5109'langmenu' 'lm' string (default "")
5110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 {only available when compiled with the |+menu| and
5112 |+multi_lang| features}
5113 Language to use for menu translation. Tells which file is loaded
5114 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005115 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116< (without the spaces). For example, to always use the Dutch menus, no
5117 matter what $LANG is set to: >
5118 :set langmenu=nl_NL.ISO_8859-1
5119< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005120 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 If your $LANG is set to a non-English language but you do want to use
5122 the English menus: >
5123 :set langmenu=none
5124< This option must be set before loading menus, switching on filetype
5125 detection or syntax highlighting. Once the menus are defined setting
5126 this option has no effect. But you could do this: >
5127 :source $VIMRUNTIME/delmenu.vim
5128 :set langmenu=de_DE.ISO_8859-1
5129 :source $VIMRUNTIME/menu.vim
5130< Warning: This deletes all menus that you defined yourself!
5131
Bram Moolenaard94464e2015-11-02 15:28:18 +01005132 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005133'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005134 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005135 {only available when compiled with the |+langmap|
5136 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005137 This is just like 'langremap' but with the value inverted. It only
5138 exists for backwards compatibility. When setting 'langremap' then
5139 'langnoremap' is set to the inverted value, and the other way around.
5140
5141 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005142'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005143 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005144 {only available when compiled with the |+langmap|
5145 feature}
5146 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005147 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005148 'langmap' disables some of your mappings, try resetting this option.
5149 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005150 that works for you to avoid mappings to break.
5151
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 *'laststatus'* *'ls'*
5153'laststatus' 'ls' number (default 1)
5154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 The value of this option influences when the last window will have a
5156 status line:
5157 0: never
5158 1: only if there are at least two windows
5159 2: always
5160 The screen looks nicer with a status line if you have several
5161 windows, but it takes another screen line. |status-line|
5162
5163 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5164'lazyredraw' 'lz' boolean (default off)
5165 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166 When this option is set, the screen will not be redrawn while
5167 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005168 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005170 This may occasionally cause display errors. It is only meant to be set
5171 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005172 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173
5174 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5175'linebreak' 'lbr' boolean (default off)
5176 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005177 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005179 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 than at the last character that fits on the screen. Unlike
5181 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005182 it only affects the way the file is displayed, not its contents.
5183 If 'breakindent' is set, line is visually indented. Then, the value
5184 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005185 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 Note that <Tab> characters after an <EOL> are mostly not displayed
5187 with the right amount of white space.
5188
5189 *'lines'* *E593*
5190'lines' number (default 24 or terminal height)
5191 global
5192 Number of lines of the Vim window.
5193 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005194 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 When Vim is running in the GUI or in a resizable window, setting this
5196 option will cause the window size to be changed. When you only want
5197 to use the size for the GUI, put the command in your |gvimrc| file.
5198 Vim limits the number of lines to what fits on the screen. You can
5199 use this command to get the tallest window possible: >
5200 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005201< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005202 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 When you set this option and Vim is unable to change the physical
5204 number of lines of the display, the display may be messed up.
5205
5206 *'linespace'* *'lsp'*
5207'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 {only in the GUI}
5210 Number of pixel lines inserted between characters. Useful if the font
5211 uses the full character cell height, making lines touch each other.
5212 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005213 With some fonts there can be too much room between lines (to have
5214 space for ascents and descents). Then it makes sense to set
5215 'linespace' to a negative value. This may cause display problems
5216 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217
5218 *'lisp'* *'nolisp'*
5219'lisp' boolean (default off)
5220 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 Lisp mode: When <Enter> is typed in insert mode set the indent for
5222 the next line to Lisp standards (well, sort of). Also happens with
5223 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5224 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5225 better. Also see 'lispwords'.
5226 The '-' character is included in keyword characters. Redefines the
5227 "=" operator to use this same indentation algorithm rather than
5228 calling an external program if 'equalprg' is empty.
5229 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005231 *'lispoptions'* *'lop'*
5232'lispoptions' 'lop' string (default "")
5233 local to buffer
5234 Comma-separated list of items that influence the Lisp indenting when
5235 enabled with the |'lisp'| option. Currently only one item is
5236 supported:
5237 expr:1 use 'indentexpr' for Lisp indenting when it is set
5238 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5239 Note that when using 'indentexpr' the `=` operator indents all the
5240 lines, otherwise the first line is not indented (Vi-compatible).
5241
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 *'lispwords'* *'lw'*
5243'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005244 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005245 Comma-separated list of words that influence the Lisp indenting when
5246 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247
5248 *'list'* *'nolist'*
5249'list' boolean (default off)
5250 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005251 List mode: By default show tabs as CTRL-I is displayed, display $
5252 after end of line. Useful to see the difference between tabs and
5253 spaces and for trailing blanks. Further changed by the 'listchars'
5254 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005255
5256 The cursor is displayed at the start of the space a Tab character
5257 occupies, not at the end as usual in Normal mode. To get this cursor
5258 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005259 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005260<
5261 Note that list mode will also affect formatting (set with 'textwidth'
5262 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 changing the way tabs are displayed.
5264
5265 *'listchars'* *'lcs'*
5266'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005267 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005268 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005269 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005270 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 eol:c Character to show at the end of each line. When
5272 omitted, there is no extra character at the end of the
5273 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005274 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005275 tab:xy[z] Two or three characters to be used to show a tab.
5276 The third character is optional.
5277
5278 tab:xy The 'x' is always used, then 'y' as many times as will
5279 fit. Thus "tab:>-" displays:
5280 >
5281 >-
5282 >--
5283 etc.
5284
5285 tab:xyz The 'z' is always used, then 'x' is prepended, and
5286 then 'y' is used as many times as will fit. Thus
5287 "tab:<->" displays:
5288 >
5289 <>
5290 <->
5291 <-->
5292 etc.
5293
5294 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005295 *lcs-space*
5296 space:c Character to show for a space. When omitted, spaces
5297 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005298 *lcs-multispace*
5299 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005300 One or more characters to use cyclically to show for
5301 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005302 setting, except for single spaces. When omitted, the
5303 "space" setting is used. For example,
5304 `:set listchars=multispace:---+` shows ten consecutive
5305 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005306 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005307 *lcs-lead*
5308 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005309 leading spaces are blank. Overrides the "space" and
5310 "multispace" settings for leading spaces. You can
5311 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005312 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005313< *lcs-leadmultispace*
5314 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005315 Like the |lcs-multispace| value, but for leading
5316 spaces only. Also overrides |lcs-lead| for leading
5317 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005318 `:set listchars=leadmultispace:---+` shows ten
5319 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005320 ---+---+--XXX ~
5321 Where "XXX" denotes the first non-blank characters in
5322 the line.
5323 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005324 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005325 trailing spaces are blank. Overrides the "space" and
5326 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005327 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 extends:c Character to show in the last column, when 'wrap' is
5329 off and the line continues beyond the right of the
5330 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005331 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005332 precedes:c Character to show in the first visible column of the
5333 physical line, when there is text preceding the
5334 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005335 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005336 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005337 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005338 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005339 nbsp:c Character to show for a non-breakable space character
5340 (0xA0 (160 decimal) and U+202F). Left blank when
5341 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005343 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005345 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005347 Each character can be specified as hex: >
5348 set listchars=eol:\\x24
5349 set listchars=eol:\\u21b5
5350 set listchars=eol:\\U000021b5
5351< Note that a double backslash is used. The number of hex characters
5352 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5353
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 Examples: >
5355 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005356 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 :set lcs=extends:>,precedes:<
5358< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005359 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5360 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005361 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362
5363 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5364'loadplugins' 'lpl' boolean (default on)
5365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 When on the plugin scripts are loaded when starting up |load-plugins|.
5367 This option can be reset in your |vimrc| file to disable the loading
5368 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005369 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5370 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371
Bram Moolenaard94464e2015-11-02 15:28:18 +01005372 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005373'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005374 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005375 {only available when compiled with the |+lua/dyn|
5376 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005377 Specifies the name of the Lua shared library. The default is
5378 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005379 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005380 This option cannot be set from a |modeline| or in the |sandbox|, for
5381 security reasons.
5382
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005383 *'macatsui'* *'nomacatsui'*
5384'macatsui' boolean (default on)
5385 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005386 {not supported}
5387 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005388
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 *'magic'* *'nomagic'*
5390'magic' boolean (default on)
5391 global
5392 Changes the special characters that can be used in search patterns.
5393 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005394 WARNING: Switching this option off most likely breaks plugins! That
5395 is because many patterns assume it's on and will fail when it's off.
5396 Only switch it off when working with old Vi scripts. In any other
5397 situation write patterns that work when 'magic' is on. Include "\M"
5398 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005399 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5400 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401
5402 *'makeef'* *'mef'*
5403'makeef' 'mef' string (default: "")
5404 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 {not available when compiled without the |+quickfix|
5406 feature}
5407 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5408 and the |:grep| command.
5409 When it is empty, an internally generated temp file will be used.
5410 When "##" is included, it is replaced by a number to make the name
5411 unique. This makes sure that the ":make" command doesn't overwrite an
5412 existing file.
5413 NOT used for the ":cf" command. See 'errorfile' for that.
5414 Environment variables are expanded |:set_env|.
5415 See |option-backslash| about including spaces and backslashes.
5416 This option cannot be set from a |modeline| or in the |sandbox|, for
5417 security reasons.
5418
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005419 *'makeencoding'* *'menc'*
5420'makeencoding' 'menc' string (default "")
5421 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005422 Encoding used for reading the output of external commands. When empty,
5423 encoding is not converted.
5424 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5425 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5426 and `:laddfile`.
5427
5428 This would be mostly useful when you use MS-Windows and set 'encoding'
5429 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5430 'makeencoding' to "char" has the same effect as setting to the system
5431 locale encoding. Example: >
5432 :set encoding=utf-8
5433 :set makeencoding=char " system locale is used
5434<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 *'makeprg'* *'mp'*
5436'makeprg' 'mp' string (default "make", VMS: "MMS")
5437 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005438 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005439 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5440 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005441 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005442 Environment variables are expanded |:set_env|. See |option-backslash|
5443 about including spaces and backslashes.
5444 Note that a '|' must be escaped twice: once for ":set" and once for
5445 the interpretation of a command. When you use a filter called
5446 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 :set makeprg=gmake\ \\\|\ myfilter
5448< The placeholder "$*" can be given (even multiple times) to specify
5449 where the arguments will be included, for example: >
5450 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5451< This option cannot be set from a |modeline| or in the |sandbox|, for
5452 security reasons.
5453
5454 *'matchpairs'* *'mps'*
5455'matchpairs' 'mps' string (default "(:),{:},[:]")
5456 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005458 other.
5459 Only character pairs are allowed that are different, thus you cannot
5460 jump between two double quotes.
5461 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005462 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005463 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 :set mps+=<:>
5465
5466< A more exotic example, to jump between the '=' and ';' in an
5467 assignment, useful for languages like C and Java: >
5468 :au FileType c,cpp,java set mps+==:;
5469
5470< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005471 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472
5473 *'matchtime'* *'mat'*
5474'matchtime' 'mat' number (default 5)
5475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 Tenths of a second to show the matching paren, when 'showmatch' is
5477 set. Note that this is not in milliseconds, like other options that
5478 set a time. This is to be compatible with Nvi.
5479
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005480 *'maxcombine'* *'mco'*
5481'maxcombine' 'mco' number (default 2)
5482 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005483 The maximum number of combining characters supported for displaying.
5484 Only used when 'encoding' is "utf-8".
5485 The default is OK for most languages. Hebrew may require 4.
5486 Maximum value is 6.
5487 Even when this option is set to 2 you can still edit text with more
5488 combining characters, you just can't see them. Use |g8| or |ga|.
5489 See |mbyte-combining|.
5490
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 *'maxfuncdepth'* *'mfd'*
5492'maxfuncdepth' 'mfd' number (default 100)
5493 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005494 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005495 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 Maximum depth of function calls for user functions. This normally
5497 catches endless recursion. When using a recursive function with
5498 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5499 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005500 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005501 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005503 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504
5505 *'maxmapdepth'* *'mmd'* *E223*
5506'maxmapdepth' 'mmd' number (default 1000)
5507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 Maximum number of times a mapping is done without resulting in a
5509 character to be used. This normally catches endless mappings, like
5510 ":map x y" with ":map y x". It still does not catch ":map g wg",
5511 because the 'w' is used before the next mapping is done. See also
5512 |key-mapping|.
5513
5514 *'maxmem'* *'mm'*
5515'maxmem' 'mm' number (default between 256 to 5120 (system
5516 dependent) or half the amount of memory
5517 available)
5518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5520 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005521 other memory to be freed.
5522 The maximum usable value is about 2000000. Use this to work without a
5523 limit.
5524 The value is ignored when 'swapfile' is off.
5525 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005527 *'maxmempattern'* *'mmp'*
5528'maxmempattern' 'mmp' number (default 1000)
5529 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005530 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005531 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005532 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005533 When Vim runs into the limit it gives an error message and mostly
5534 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005535 Running into the limit often means that the pattern is very
5536 inefficient or too complex. This may already happen with the pattern
5537 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005538 Might also happen on redraw, when syntax rules try to match a complex
5539 text structure.
5540 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5541 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005542
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 *'maxmemtot'* *'mmt'*
5544'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5545 dependent) or half the amount of memory
5546 available)
5547 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005548 Maximum amount of memory in Kbyte to use for all buffers together.
5549 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005550 without a limit.
5551 On 64 bit machines higher values might work. But hey, do you really
5552 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005553 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005554 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005555 Buffers with 'swapfile' off still count to the total amount of memory
5556 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005557 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558
5559 *'menuitems'* *'mis'*
5560'menuitems' 'mis' number (default 25)
5561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 {not available when compiled without the |+menu|
5563 feature}
5564 Maximum number of items to use in a menu. Used for menus that are
5565 generated from a list of items, e.g., the Buffers menu. Changing this
5566 option has no direct effect, the menu must be refreshed first.
5567
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005568 *'mkspellmem'* *'msm'*
5569'mkspellmem' 'msm' string (default "460000,2000,500")
5570 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005571 {not available when compiled without the |+syntax|
5572 feature}
5573 Parameters for |:mkspell|. This tunes when to start compressing the
5574 word tree. Compression can be slow when there are many words, but
5575 it's needed to avoid running out of memory. The amount of memory used
5576 per word depends very much on how similar the words are, that's why
5577 this tuning is complicated.
5578
5579 There are three numbers, separated by commas:
5580 {start},{inc},{added}
5581
5582 For most languages the uncompressed word tree fits in memory. {start}
5583 gives the amount of memory in Kbyte that can be used before any
5584 compression is done. It should be a bit smaller than the amount of
5585 memory that is available to Vim.
5586
5587 When going over the {start} limit the {inc} number specifies the
5588 amount of memory in Kbyte that can be allocated before another
5589 compression is done. A low number means compression is done after
5590 less words are added, which is slow. A high number means more memory
5591 will be allocated.
5592
5593 After doing compression, {added} times 1024 words can be added before
5594 the {inc} limit is ignored and compression is done when any extra
5595 amount of memory is needed. A low number means there is a smaller
5596 chance of hitting the {inc} limit, less memory is used but it's
5597 slower.
5598
5599 The languages for which these numbers are important are Italian and
5600 Hungarian. The default works for when you have about 512 Mbyte. If
5601 you have 1 Gbyte you could use: >
5602 :set mkspellmem=900000,3000,800
5603< If you have less than 512 Mbyte |:mkspell| may fail for some
5604 languages, no matter what you set 'mkspellmem' to.
5605
dkearns8ebdbc92023-10-29 06:26:19 +11005606 This option cannot be set from a |modeline| or in the |sandbox|, for
5607 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005608
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005610'modeline' 'ml' boolean (Vim default: on (off for root),
5611 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005613 If 'modeline' is on 'modelines' gives the number of lines that is
5614 checked for set commands. If 'modeline' is off or 'modelines' is zero
5615 no lines are checked. See |modeline|.
5616
5617 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5618'modelineexpr' 'mle' boolean (default: off)
5619 global
5620 When on allow some options that are an expression to be set in the
5621 modeline. Check the option for whether it is affected by
5622 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005623 This option cannot be set from a |modeline| or in the |sandbox|, for
5624 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005625
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 *'modelines'* *'mls'*
5627'modelines' 'mls' number (default 5)
5628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 If 'modeline' is on 'modelines' gives the number of lines that is
5630 checked for set commands. If 'modeline' is off or 'modelines' is zero
5631 no lines are checked. See |modeline|.
5632 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5633 set and to the Vim default value when 'compatible' is reset.
5634
5635 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005636 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637'modifiable' 'ma' boolean (default on)
5638 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 When off the buffer contents cannot be changed. The 'fileformat' and
5640 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005641 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642
5643 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5644'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005645 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 When on, the buffer is considered to be modified. This option is set
5647 when:
5648 1. A change was made to the text since it was last written. Using the
5649 |undo| command to go back to the original text will reset the
5650 option. But undoing changes that were made before writing the
5651 buffer will set the option again, since the text is different from
5652 when it was written.
5653 2. 'fileformat' or 'fileencoding' is different from its original
5654 value. The original value is set when the buffer is read or
5655 written. A ":set nomodified" command also resets the original
5656 values to the current values and the 'modified' option will be
5657 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005658 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005659 This option is not set when a change is made to the buffer as the
5660 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5661 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5662 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5664 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005665 Note that the text may actually be the same, e.g. 'modified' is set
5666 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667
5668 *'more'* *'nomore'*
5669'more' boolean (Vim default: on, Vi default: off)
5670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 When on, listings pause when the whole screen is filled. You will get
5672 the |more-prompt|. When this option is off there are no pauses, the
5673 listing continues until finished.
5674 NOTE: This option is set to the Vi default value when 'compatible' is
5675 set and to the Vim default value when 'compatible' is reset.
5676
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005677 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005678'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005679 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005681 Enable the use of the mouse. Works for most terminals (xterm, Win32
5682 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5683 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5684 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005685 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 v Visual mode
5687 i Insert mode
5688 c Command-line mode
5689 h all previous modes when editing a help file
5690 a all previous modes
5691 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005692 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005694< If your terminal can't overrule the mouse events going to the
5695 application, use: >
5696 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005697< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005698 back to Vim using the mouse events.
5699 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5700 "xterm".
5701
5702 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 modeless selection. This doesn't move the text cursor.
5704
5705 See |mouse-using|. Also see |'clipboard'|.
5706
5707 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005708 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 the mouse buttons can still be used by keeping the shift key pressed.
5710 Also see the 'clipboard' option.
5711
5712 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5713'mousefocus' 'mousef' boolean (default off)
5714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 {only works in the GUI}
5716 The window that the mouse pointer is on is automatically activated.
5717 When changing the window layout or window focus in another way, the
5718 mouse pointer is moved to the window with keyboard focus. Off is the
5719 default because it makes using the pull down menus a little goofy, as
5720 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005721 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005722 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723
5724 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5725'mousehide' 'mh' boolean (default on)
5726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 {only works in the GUI}
5728 When on, the mouse pointer is hidden when characters are typed.
5729 The mouse pointer is restored when the mouse is moved.
5730
5731 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005732'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 Sets the model to use for the mouse. The name mostly specifies what
5735 the right mouse button is used for:
5736 extend Right mouse button extends a selection. This works
5737 like in an xterm.
5738 popup Right mouse button pops up a menu. The shifted left
5739 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005740 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 popup_setpos Like "popup", but the cursor will be moved to the
5742 position where the mouse was clicked, and thus the
5743 selected operation will act upon the clicked object.
5744 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005745 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 course, that right clicking outside a selection will
5747 end Visual mode.
5748 Overview of what button does what for each model:
5749 mouse extend popup(_setpos) ~
5750 left click place cursor place cursor
5751 left drag start selection start selection
5752 shift-left search word extend selection
5753 right click extend selection popup menu (place cursor)
5754 right drag extend selection -
5755 middle click paste paste
5756
5757 In the "popup" model the right mouse button produces a pop-up menu.
5758 You need to define this first, see |popup-menu|.
5759
5760 Note that you can further refine the meaning of buttons with mappings.
5761 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5762 selection (because that's handled in the GUI code directly).
5763
5764 The 'mousemodel' option is set by the |:behave| command.
5765
h_east59858792023-10-25 22:47:05 +09005766 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005767'mousemoveevent' 'mousemev' boolean (default off)
5768 global
5769 {only works in the GUI}
5770 When on, mouse move events are delivered to the input queue and are
5771 available for mapping. The default, off, avoids the mouse movement
5772 overhead except when needed. See |gui-mouse-mapping|.
5773 Warning: Setting this option can make pending mappings to be aborted
5774 when the mouse is moved.
5775 Currently only works in the GUI, may be made to work in a terminal
5776 later.
5777
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005779'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5780 vs:leftright,vd:lrsizing,m:no,
5781 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 {only available when compiled with the |+mouseshape|
5784 feature}
5785 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005786 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787 like used for 'guicursor'. Each part consist of a mode/location-list
5788 and an argument-list:
5789 mode-list:shape,mode-list:shape,..
5790 The mode-list is a dash separated list of these modes/locations:
5791 In a normal window: ~
5792 n Normal mode
5793 v Visual mode
5794 ve Visual mode with 'selection' "exclusive" (same as 'v',
5795 if not specified)
5796 o Operator-pending mode
5797 i Insert mode
5798 r Replace mode
5799
5800 Others: ~
5801 c appending to the command-line
5802 ci inserting in the command-line
5803 cr replacing in the command-line
5804 m at the 'Hit ENTER' or 'More' prompts
5805 ml idem, but cursor in the last line
5806 e any mode, pointer below last window
5807 s any mode, pointer on a status line
5808 sd any mode, while dragging a status line
5809 vs any mode, pointer on a vertical separator line
5810 vd any mode, while dragging a vertical separator line
5811 a everywhere
5812
5813 The shape is one of the following:
5814 avail name looks like ~
5815 w x arrow Normal mouse pointer
5816 w x blank no pointer at all (use with care!)
5817 w x beam I-beam
5818 w x updown up-down sizing arrows
5819 w x leftright left-right sizing arrows
5820 w x busy The system's usual busy pointer
5821 w x no The system's usual 'no input' pointer
5822 x udsizing indicates up-down resizing
5823 x lrsizing indicates left-right resizing
5824 x crosshair like a big thin +
5825 x hand1 black hand
5826 x hand2 white hand
5827 x pencil what you write with
5828 x question big ?
5829 x rightup-arrow arrow pointing right-up
5830 w x up-arrow arrow pointing up
5831 x <number> any X11 pointer number (see X11/cursorfont.h)
5832
5833 The "avail" column contains a 'w' if the shape is available for Win32,
5834 x for X11.
5835 Any modes not specified or shapes not available use the normal mouse
5836 pointer.
5837
5838 Example: >
5839 :set mouseshape=s:udsizing,m:no
5840< will make the mouse turn to a sizing arrow over the status lines and
5841 indicate no input when the hit-enter prompt is displayed (since
5842 clicking the mouse has no effect in this state.)
5843
5844 *'mousetime'* *'mouset'*
5845'mousetime' 'mouset' number (default 500)
5846 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005847 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 time in msec between two mouse clicks for the second click to be
5849 recognized as a multi click.
5850
laburnumT3f7855a2023-12-05 18:37:03 +01005851 *'mzquantum'* *'mzq'*
5852'mzquantum' 'mzq' number (default 100)
5853 global
5854 {not available when compiled without the |+mzscheme|
5855 feature}
5856 The number of milliseconds between polls for MzScheme threads.
5857 Negative or zero value means no thread scheduling.
5858 NOTE: This option is set to the Vim default value when 'compatible'
5859 is reset.
5860
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005861 *'mzschemedll'*
5862'mzschemedll' string (default depends on the build)
5863 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005864 {only available when compiled with the |+mzscheme/dyn|
5865 feature}
5866 Specifies the name of the MzScheme shared library. The default is
5867 DYNAMIC_MZSCH_DLL which was specified at compile time.
5868 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005869 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005870 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005871 This option cannot be set from a |modeline| or in the |sandbox|, for
5872 security reasons.
5873
5874 *'mzschemegcdll'*
5875'mzschemegcdll' string (default depends on the build)
5876 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005877 {only available when compiled with the |+mzscheme/dyn|
5878 feature}
5879 Specifies the name of the MzScheme GC shared library. The default is
5880 DYNAMIC_MZGC_DLL which was specified at compile time.
5881 The value can be equal to 'mzschemedll' if it includes the GC code.
5882 Environment variables are expanded |:set_env|.
5883 This option cannot be set from a |modeline| or in the |sandbox|, for
5884 security reasons.
5885
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005887'nrformats' 'nf' string (default "bin,octal,hex",
5888 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 This defines what bases Vim will consider for numbers when using the
5891 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5892 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005893 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005895 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005896 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005898 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 considered to be hexadecimal. Example: Using CTRL-X on
5900 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005901 bin If included, numbers starting with "0b" or "0B" will be
5902 considered to be binary. Example: Using CTRL-X on
5903 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005904 unsigned If included, numbers are recognized as unsigned. Thus a
5905 leading dash or negative sign won't be considered as part of
5906 the number. Examples:
5907 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5908 (without "unsigned" it would become "9-2021").
5909 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5910 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005911 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5912 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 Numbers which simply begin with a digit in the range 1-9 are always
5914 considered decimal. This also happens for numbers that are not
5915 recognized as octal or hex.
5916
5917 *'number'* *'nu'* *'nonumber'* *'nonu'*
5918'number' 'nu' boolean (default off)
5919 local to window
5920 Print the line number in front of each line. When the 'n' option is
5921 excluded from 'cpoptions' a wrapped line will not use the column of
5922 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005923 The 'numberwidth' option can be used to set the room used for the line
5924 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 When a long, wrapped line doesn't start with the first character, '-'
5926 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005927 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5928 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005929 *number_relativenumber*
5930 The 'relativenumber' option changes the displayed number to be
5931 relative to the cursor. Together with 'number' there are these
5932 four combinations (cursor in line 3):
5933
Bram Moolenaar3848e002016-03-19 18:42:29 +01005934 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005935 'nornu' 'nornu' 'rnu' 'rnu'
5936
5937 |apple | 1 apple | 2 apple | 2 apple
5938 |pear | 2 pear | 1 pear | 1 pear
5939 |nobody | 3 nobody | 0 nobody |3 nobody
5940 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005941
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005942 *'numberwidth'* *'nuw'*
5943'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5944 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005945 {only available when compiled with the |+linebreak|
5946 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005947 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005948 when the 'number' or 'relativenumber' option is set or printing lines
5949 with a line number. Since one space is always between the number and
5950 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005951 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005952 fit the highest line number in the buffer respectively the number of
5953 rows in the window, depending on whether 'number' or 'relativenumber'
5954 is set. Thus with the Vim default of 4 there is room for a line number
5955 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005956 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005957 NOTE: This option is set to the Vi default value when 'compatible' is
5958 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005959
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005960 *'omnifunc'* *'ofu'*
5961'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005962 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005963 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005964 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005965 This option specifies a function to be used for Insert mode omni
5966 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005967 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005968 invoked and what it should return. The value can be the name of a
5969 function, a |lambda| or a |Funcref|. See |option-value-function| for
5970 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005971 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005972 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005973 This option cannot be set from a |modeline| or in the |sandbox|, for
5974 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005975
Bram Moolenaar02467872007-05-06 13:22:01 +00005976 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005977'opendevice' 'odev' boolean (default off)
5978 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005979 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005980 Enable reading and writing from devices. This may get Vim stuck on a
5981 device that can be opened but doesn't actually do the I/O. Therefore
5982 it is off by default.
5983 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5984 result in editing a device.
5985
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005986 *'operatorfunc'* *'opfunc'*
5987'operatorfunc' 'opfunc' string (default: empty)
5988 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005989 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005990 See |:map-operator| for more info and an example. The value can be
5991 the name of a function, a |lambda| or a |Funcref|. See
5992 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005993
5994 This option cannot be set from a |modeline| or in the |sandbox|, for
5995 security reasons.
5996
Bram Moolenaar251e1912011-06-19 05:09:16 +02005997 *'osfiletype'* *'oft'*
5998'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006000 This option was supported on RISC OS, which has been removed.
6001
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006002 *'packpath'* *'pp'*
6003'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006004 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006005 This option cannot be set from a |modeline| or in the |sandbox|, for
6006 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006007
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006009'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 global
6011 Specifies the nroff macros that separate paragraphs. These are pairs
6012 of two letters (see |object-motions|).
6013
6014 *'paste'* *'nopaste'*
6015'paste' boolean (default off)
6016 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006017 Put Vim in Paste mode. This is useful if you want to cut or copy
6018 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019 unexpected effects.
6020 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006021 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 knows about pasting and will mostly do the right thing without 'paste'
6023 being set. The same is true for a terminal where Vim handles the
6024 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006025 This option is reset when starting the GUI. Thus if you set it in
6026 your .vimrc it will work in a terminal, but not in the GUI. Setting
6027 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6028 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 When the 'paste' option is switched on (also when it was already on):
6030 - mapping in Insert mode and Command-line mode is disabled
6031 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006033 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006034 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035 - 'revins' is reset
6036 - 'ruler' is reset
6037 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006038 - 'smarttab' is reset
6039 - 'softtabstop' is set to 0
6040 - 'textwidth' is set to 0
6041 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006042 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006045 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006046 - 'indentexpr'
6047 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006048 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049 NOTE: When you start editing another file while the 'paste' option is
6050 on, settings from the modelines or autocommands may change the
6051 settings again, causing trouble when pasting text. You might want to
6052 set the 'paste' option again.
6053 When the 'paste' option is reset the mentioned options are restored to
6054 the value before the moment 'paste' was switched from off to on.
6055 Resetting 'paste' before ever setting it does not have any effect.
6056 Since mapping doesn't work while 'paste' is active, you need to use
6057 the 'pastetoggle' option to toggle the 'paste' option with some key.
6058
6059 *'pastetoggle'* *'pt'*
6060'pastetoggle' 'pt' string (default "")
6061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062 When non-empty, specifies the key sequence that toggles the 'paste'
6063 option. This is like specifying a mapping: >
6064 :map {keys} :set invpaste<CR>
6065< Where {keys} is the value of 'pastetoggle'.
6066 The difference is that it will work even when 'paste' is set.
6067 'pastetoggle' works in Insert mode and Normal mode, but not in
6068 Command-line mode.
6069 Mappings are checked first, thus overrule 'pastetoggle'. However,
6070 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6071 this: >
6072 :map <F10> :set paste<CR>
6073 :map <F11> :set nopaste<CR>
6074 :imap <F10> <C-O>:set paste<CR>
6075 :imap <F11> <nop>
6076 :set pastetoggle=<F11>
6077< This will make <F10> start paste mode and <F11> stop paste mode.
6078 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6079 mode everything is inserted literally, except the 'pastetoggle' key
6080 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006081 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082
6083 *'pex'* *'patchexpr'*
6084'patchexpr' 'pex' string (default "")
6085 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 {not available when compiled without the |+diff|
6087 feature}
6088 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006089 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006090 This option cannot be set from a |modeline| or in the |sandbox|, for
6091 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092
Bram Moolenaardbc28022014-07-26 13:40:44 +02006093 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094'patchmode' 'pm' string (default "")
6095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 When non-empty the oldest version of a file is kept. This can be used
6097 to keep the original version of a file if you are changing files in a
6098 source distribution. Only the first time that a file is written a
6099 copy of the original file will be kept. The name of the copy is the
6100 name of the original file with the string in the 'patchmode' option
6101 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006102 ".orig" or ".org". 'backupdir' must not be empty for this to work
6103 (Detail: The backup file is renamed to the patchmode file after the
6104 new file has been successfully written, that's why it must be possible
6105 to write a backup file). If there was no file to be backed up, an
6106 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 When the 'backupskip' pattern matches, a patchmode file is not made.
6108 Using 'patchmode' for compressed files appends the extension at the
6109 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6110 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006111 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006113 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 other systems: ".,,")
6116 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006118 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6119 provided that the file being searched for has a relative path (not
6120 starting with "/", "./" or "../"). The directories in the 'path'
6121 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 - Use commas to separate directory names: >
6123 :set path=.,/usr/local/include,/usr/include
6124< - Spaces can also be used to separate directory names (for backwards
6125 compatibility with version 3.0). To have a space in a directory
6126 name, precede it with an extra backslash, and escape the space: >
6127 :set path=.,/dir/with\\\ space
6128< - To include a comma in a directory name precede it with an extra
6129 backslash: >
6130 :set path=.,/dir/with\\,comma
6131< - To search relative to the directory of the current file, use: >
6132 :set path=.
6133< - To search in the current directory use an empty string between two
6134 commas: >
6135 :set path=,,
6136< - A directory name may end in a ':' or '/'.
6137 - Environment variables are expanded |:set_env|.
6138 - When using |netrw.vim| URLs can be used. For example, adding
6139 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006140 - Search upwards and downwards in a directory tree using "*", "**" and
6141 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 - Careful with '\' characters, type two to get one in the option: >
6143 :set path=.,c:\\include
6144< Or just use '/' instead: >
6145 :set path=.,c:/include
6146< Don't forget "." or files won't even be found in the same directory as
6147 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006148 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 it is something like 256 or 1024 characters.
6150 You can check if all the include files are found, using the value of
6151 'path', see |:checkpath|.
6152 The use of |:set+=| and |:set-=| is preferred when adding or removing
6153 directories from the list. This avoids problems when a future version
6154 uses another default. To remove the current directory use: >
6155 :set path-=
6156< To add the current directory use: >
6157 :set path+=
6158< To use an environment variable, you probably need to replace the
6159 separator. Here is an example to append $INCL, in which directory
6160 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006161 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162< Replace the ';' with a ':' or whatever separator is used. Note that
6163 this doesn't work when $INCL contains a comma or white space.
6164
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006165 *'perldll'*
6166'perldll' string (default depends on the build)
6167 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006168 {only available when compiled with the |+perl/dyn|
6169 feature}
6170 Specifies the name of the Perl shared library. The default is
6171 DYNAMIC_PERL_DLL, which was specified at compile time.
6172 Environment variables are expanded |:set_env|.
6173 This option cannot be set from a |modeline| or in the |sandbox|, for
6174 security reasons.
6175
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6177'preserveindent' 'pi' boolean (default off)
6178 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 When changing the indent of the current line, preserve as much of the
6180 indent structure as possible. Normally the indent is replaced by a
6181 series of tabs followed by spaces as required (unless |'expandtab'| is
6182 enabled, in which case only spaces are used). Enabling this option
6183 means the indent will preserve as many existing characters as possible
6184 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006185 'expandtab' does not apply to the preserved white space, a Tab remains
6186 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187 NOTE: When using ">>" multiple times the resulting indent is a mix of
6188 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006189 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 Also see 'copyindent'.
6191 Use |:retab| to clean up white space.
6192
6193 *'previewheight'* *'pvh'*
6194'previewheight' 'pvh' number (default 12)
6195 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006196 {not available when compiled without the |+quickfix|
6197 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006199 commands. Used for |CTRL-W_}| when no count is given. Not used when
6200 'previewpopup' is set.
6201
6202 *'previewpopup'* *'pvp'*
6203'previewpopup' 'pvp' string (default empty)
6204 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006205 {not available when compiled without the |+textprop|
6206 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006207 When not empty a popup window is used for commands that would open a
6208 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006209 Not used for the insert completion info, add "popup" to
6210 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211
6212 *'previewwindow'* *'nopreviewwindow'*
6213 *'pvw'* *'nopvw'* *E590*
6214'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006215 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006216 {not available when compiled without the |+quickfix|
6217 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006218 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 set. It's normally not set directly, but by using one of the commands
6220 |:ptag|, |:pedit|, etc.
6221
6222 *'printdevice'* *'pdev'*
6223'printdevice' 'pdev' string (default empty)
6224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 {only available when compiled with the |+printer|
6226 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006227 The name of the printer to be used for |:hardcopy|.
6228 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006229 This option cannot be set from a |modeline| or in the |sandbox|, for
6230 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231
Bram Moolenaar8299df92004-07-10 09:47:34 +00006232 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006233'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 {only available when compiled with the |+printer|
6236 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006237 Sets the character encoding used when printing.
6238 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239
6240 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006241'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 {only available when compiled with the |+printer|
6244 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006245 Expression used to print the PostScript produced with |:hardcopy|.
6246 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006247 This option cannot be set from a |modeline| or in the |sandbox|, for
6248 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249
Bram Moolenaar8299df92004-07-10 09:47:34 +00006250 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251'printfont' 'pfn' string (default "courier")
6252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 {only available when compiled with the |+printer|
6254 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006255 The name of the font that will be used for |:hardcopy|.
6256 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257
6258 *'printheader'* *'pheader'*
6259'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 {only available when compiled with the |+printer|
6262 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006263 The format of the header produced in |:hardcopy| output.
6264 See |pheader-option|.
6265
6266 *'printmbcharset'* *'pmbcs'*
6267'printmbcharset' 'pmbcs' string (default "")
6268 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006269 {only available when compiled with the |+printer|
6270 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006271 The CJK character set to be used for CJK output from |:hardcopy|.
6272 See |pmbcs-option|.
6273
6274 *'printmbfont'* *'pmbfn'*
6275'printmbfont' 'pmbfn' string (default "")
6276 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006277 {only available when compiled with the |+printer|
6278 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006279 List of font names to be used for CJK output from |:hardcopy|.
6280 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281
6282 *'printoptions'* *'popt'*
6283'printoptions' 'popt' string (default "")
6284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006286 List of items that control the format of the output of |:hardcopy|.
6287 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006289 *'prompt'* *'noprompt'*
6290'prompt' boolean (default on)
6291 global
6292 When on a ":" prompt is used in Ex mode.
6293
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006294 *'pumheight'* *'ph'*
6295'pumheight' 'ph' number (default 0)
6296 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006297 Determines the maximum number of items to show in the popup menu for
6298 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006299 |ins-completion-menu|.
6300
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006301 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006302'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006303 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006304 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006305 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006306
Bram Moolenaard94464e2015-11-02 15:28:18 +01006307 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006308'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006309 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006310 {only available when compiled with the |+python/dyn|
6311 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006312 Specifies the name of the Python 2.x shared library. The default is
6313 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006314 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006315 This option cannot be set from a |modeline| or in the |sandbox|, for
6316 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006317
Bram Moolenaar94073162018-01-31 21:49:05 +01006318 *'pythonhome'*
6319'pythonhome' string (default "")
6320 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006321 {only available when compiled with the |+python/dyn|
6322 feature}
6323 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6324 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6325 which was specified at compile time, will be used for the Python 2.x
6326 home directory.
6327 Environment variables are expanded |:set_env|.
6328 This option cannot be set from a |modeline| or in the |sandbox|, for
6329 security reasons.
6330
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006331 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006332'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006333 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006334 {only available when compiled with the |+python3/dyn|
6335 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006336 Specifies the name of the Python 3 shared library. The default is
6337 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006338 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006339 This option cannot be set from a |modeline| or in the |sandbox|, for
6340 security reasons.
6341
Bram Moolenaar94073162018-01-31 21:49:05 +01006342 *'pythonthreehome'*
6343'pythonthreehome' string (default "")
6344 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006345 {only available when compiled with the |+python3/dyn|
6346 feature}
6347 Specifies the name of the Python 3 home directory. When
6348 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6349 PYTHON3_HOME, which was specified at compile time, will be used for
6350 the Python 3 home directory.
6351 Environment variables are expanded |:set_env|.
6352 This option cannot be set from a |modeline| or in the |sandbox|, for
6353 security reasons.
6354
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006355 *'pyxversion'* *'pyx'*
6356'pyxversion' 'pyx' number (default depends on the build)
6357 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006358 {only available when compiled with the |+python| or
6359 the |+python3| feature}
6360 Specifies the python version used for pyx* functions and commands
6361 |python_x|. The default value is as follows:
6362
6363 Compiled with Default ~
6364 |+python| and |+python3| 0
6365 only |+python| 2
6366 only |+python3| 3
6367
6368 Available values are 0, 2 and 3.
6369 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6370 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6371 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6372 to 2 if Python 2 is available.
6373 See also: |has-pythonx|
6374
6375 If Vim is compiled with only |+python| or |+python3| setting
6376 'pyxversion' has no effect. The pyx* functions and commands are
6377 always the same as the compiled version.
6378
6379 This option cannot be set from a |modeline| or in the |sandbox|, for
6380 security reasons.
6381
Bram Moolenaar858ba062020-05-31 23:11:59 +02006382 *'quickfixtextfunc'* *'qftf'*
6383'quickfixtextfunc' 'qftf' string (default "")
6384 global
6385 {only available when compiled with the |+quickfix|
6386 feature}
6387 This option specifies a function to be used to get the text to display
6388 in the quickfix and location list windows. This can be used to
6389 customize the information displayed in the quickfix or location window
6390 for each entry in the corresponding quickfix or location list. See
6391 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006392 function and an example. The value can be the name of a function, a
6393 |lambda| or a |Funcref|. See |option-value-function| for more
6394 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006395
6396 This option cannot be set from a |modeline| or in the |sandbox|, for
6397 security reasons.
6398
Bram Moolenaar677ee682005-01-27 14:41:15 +00006399 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006400'quoteescape' 'qe' string (default "\")
6401 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006402 The characters that are used to escape quotes in a string. Used for
6403 objects like a', a" and a` |a'|.
6404 When one of the characters in this option is found inside a string,
6405 the following character will be skipped. The default value makes the
6406 text "foo\"bar\\" considered to be one string.
6407
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6409'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006410 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 If on, writes fail unless you use a '!'. Protects you from
6412 accidentally overwriting a file. Default on when Vim is started
6413 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006414 When using ":w!" the 'readonly' option is reset for the current
6415 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006416 When using the ":view" command the 'readonly' option is set for the
6417 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006418 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006420 *'redrawtime'* *'rdt'*
6421'redrawtime' 'rdt' number (default 2000)
6422 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006423 {only available when compiled with the |+reltime|
6424 feature}
6425 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006426 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006427 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006428 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006429 matches will be highlighted.
6430 For syntax highlighting the time applies per window. When over the
6431 limit syntax highlighting is disabled until |CTRL-L| is used.
6432 This is used to avoid that Vim hangs when using a very complicated
6433 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006434
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006435 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006436'regexpengine' 're' number (default 0)
6437 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006438 This selects the default regexp engine. |two-engines|
6439 The possible values are:
6440 0 automatic selection
6441 1 old engine
6442 2 NFA engine
6443 Note that when using the NFA engine and the pattern contains something
6444 that is not supported the pattern will not match. This is only useful
6445 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006446 Using automatic selection enables Vim to switch the engine, if the
6447 default engine becomes too costly. E.g., when the NFA engine uses too
6448 many states. This should prevent Vim from hanging on a combination of
6449 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006450
Bram Moolenaar64486672010-05-16 15:46:46 +02006451 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6452'relativenumber' 'rnu' boolean (default off)
6453 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006454 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006455 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006456 precede some vertical motion commands (e.g. j k + -) with, without
6457 having to calculate it yourself. Especially useful in combination with
6458 other commands (e.g. y d c < > gq gw =).
6459 When the 'n' option is excluded from 'cpoptions' a wrapped
6460 line will not use the column of line numbers (this is the default when
6461 'compatible' isn't set).
6462 The 'numberwidth' option can be used to set the room used for the line
6463 number.
6464 When a long, wrapped line doesn't start with the first character, '-'
6465 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006466 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6467 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006468
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006469 The number in front of the cursor line also depends on the value of
6470 'number', see |number_relativenumber| for all combinations of the two
6471 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006472
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 *'remap'* *'noremap'*
6474'remap' boolean (default on)
6475 global
6476 Allows for mappings to work recursively. If you do not want this for
6477 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006478 NOTE: To avoid portability problems with Vim scripts, always keep
6479 this option at the default "on". Only switch it off when working with
6480 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481
zeertzjqd086b8f2024-02-25 15:42:52 +08006482 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006483'renderoptions' 'rop' string (default: empty)
6484 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006485 {only available when compiled with GUI and DIRECTX on
6486 MS-Windows}
6487 Select a text renderer and set its options. The options depend on the
6488 renderer.
6489
6490 Syntax: >
6491 set rop=type:{renderer}(,{name}:{value})*
6492<
6493 Currently, only one optional renderer is available.
6494
6495 render behavior ~
6496 directx Vim will draw text using DirectX (DirectWrite). It makes
6497 drawn glyphs more beautiful than default GDI.
6498 It requires 'encoding' is "utf-8", and only works on
6499 MS-Windows Vista or newer version.
6500
6501 Options:
6502 name meaning type value ~
6503 gamma gamma float 1.0 - 2.2 (maybe)
6504 contrast enhancedContrast float (unknown)
6505 level clearTypeLevel float (unknown)
6506 geom pixelGeometry int 0 - 2 (see below)
6507 renmode renderingMode int 0 - 6 (see below)
6508 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006509 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006510
Bram Moolenaar92467d32017-12-05 13:22:16 +01006511 See this URL for detail (except for scrlines):
6512 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006513
6514 For geom: structure of a device pixel.
6515 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6516 1 - DWRITE_PIXEL_GEOMETRY_RGB
6517 2 - DWRITE_PIXEL_GEOMETRY_BGR
6518
6519 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006520 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006521
6522 For renmode: method of rendering glyphs.
6523 0 - DWRITE_RENDERING_MODE_DEFAULT
6524 1 - DWRITE_RENDERING_MODE_ALIASED
6525 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6526 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6527 4 - DWRITE_RENDERING_MODE_NATURAL
6528 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6529 6 - DWRITE_RENDERING_MODE_OUTLINE
6530
6531 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006532 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006533
6534 For taamode: antialiasing mode used for drawing text.
6535 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6536 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6537 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6538 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6539
6540 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006541 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6542
Bram Moolenaara338adc2018-01-31 20:51:47 +01006543 For scrlines:
6544 This was used for optimizing scrolling behavior, however this
6545 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006546
6547 Example: >
6548 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006549 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006550 set rop=type:directx
6551<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006552 If select a raster font (Courier, Terminal or FixedSys which
6553 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006554 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006555
6556 NOTE: It is known that some fonts and options combination
6557 causes trouble on drawing glyphs.
6558
Bram Moolenaar92467d32017-12-05 13:22:16 +01006559 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006560 special made fonts (True-Type fonts which includes only
6561 bitmap glyphs).
6562 - 'taamode:3' will not work with some vector fonts.
6563
6564 NOTE: With this option, you can display colored emoji
6565 (emoticon) in Windows 8.1 or later. To display colored emoji,
6566 there are some conditions which you should notice.
6567
6568 - If your font includes non-colored emoji already, it will
6569 be used.
6570 - If your font doesn't have emoji, the system chooses an
6571 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6572 will be used.
6573 - When this alternative font didn't have fixed width glyph,
6574 emoji might be rendered beyond the bounding box of drawing
6575 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006576
6577 Other render types are currently not supported.
6578
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 *'report'*
6580'report' number (default 2)
6581 global
6582 Threshold for reporting number of lines changed. When the number of
6583 changed lines is more than 'report' a message will be given for most
6584 ":" commands. If you want it always, set 'report' to 0.
6585 For the ":substitute" command the number of substitutions is used
6586 instead of the number of lines.
6587
6588 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6589'restorescreen' 'rs' boolean (default on)
6590 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006591 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 When set, the screen contents is restored when exiting Vim. This also
6593 happens when executing external commands.
6594
6595 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6596 options in your .vimrc. To disable restoring:
6597 set t_ti= t_te=
6598 To enable restoring (for an xterm):
6599 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6600 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6601
6602 *'revins'* *'ri'* *'norevins'* *'nori'*
6603'revins' 'ri' boolean (default off)
6604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 {only available when compiled with the |+rightleft|
6606 feature}
6607 Inserting characters in Insert mode will work backwards. See "typing
6608 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6609 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006610 NOTE: This option is reset when 'compatible' is set.
6611 This option is reset when 'paste' is set and restored when 'paste' is
6612 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613
6614 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6615'rightleft' 'rl' boolean (default off)
6616 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 {only available when compiled with the |+rightleft|
6618 feature}
6619 When on, display orientation becomes right-to-left, i.e., characters
6620 that are stored in the file appear from the right to the left.
6621 Using this option, it is possible to edit files for languages that
6622 are written from the right to the left such as Hebrew and Arabic.
6623 This option is per window, so it is possible to edit mixed files
6624 simultaneously, or to view the same file in both ways (this is
6625 useful whenever you have a mixed text file with both right-to-left
6626 and left-to-right strings so that both sets are displayed properly
6627 in different windows). Also see |rileft.txt|.
6628
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006629 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630'rightleftcmd' 'rlc' string (default "search")
6631 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 {only available when compiled with the |+rightleft|
6633 feature}
6634 Each word in this option enables the command line editing to work in
6635 right-to-left mode for a group of commands:
6636
6637 search "/" and "?" commands
6638
6639 This is useful for languages such as Hebrew, Arabic and Farsi.
6640 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6641
Bram Moolenaard94464e2015-11-02 15:28:18 +01006642 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006643'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006644 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006645 {only available when compiled with the |+ruby/dyn|
6646 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006647 Specifies the name of the Ruby shared library. The default is
6648 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006649 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006650 This option cannot be set from a |modeline| or in the |sandbox|, for
6651 security reasons.
6652
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006654'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006657 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 text in the file is shown on the far right:
6659 Top first line is visible
6660 Bot last line is visible
6661 All first and last line are visible
6662 45% relative position in the file
6663 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006664 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006665 ruler is shown there. Otherwise it is shown in the last line of the
6666 screen. If the statusline is given by 'statusline' (i.e. not empty),
6667 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006669 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 the text column (byte number) and the screen column are shown,
6671 separated with a dash.
6672 For an empty line "0-1" is shown.
6673 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006674 This option is reset when 'paste' is set and restored when 'paste' is
6675 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 If you don't want to see the ruler all the time but want to know where
6677 you are, use "g CTRL-G" |g_CTRL-G|.
6678 NOTE: This option is reset when 'compatible' is set.
6679
6680 *'rulerformat'* *'ruf'*
6681'rulerformat' 'ruf' string (default empty)
6682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 {not available when compiled without the |+statusline|
6684 feature}
6685 When this option is not empty, it determines the content of the ruler
6686 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006687 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006688 This option cannot be set in a modeline when 'modelineexpr' is off.
6689
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 The default ruler width is 17 characters. To make the ruler 15
6691 characters wide, put "%15(" at the start and "%)" at the end.
6692 Example: >
6693 :set rulerformat=%15(%c%V\ %p%%%)
6694<
6695 *'runtimepath'* *'rtp'* *vimfiles*
6696'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006697 Unix: "$HOME/.vim or
6698 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 $VIM/vimfiles,
6700 $VIMRUNTIME,
6701 $VIM/vimfiles/after,
6702 $HOME/.vim/after"
6703 Amiga: "home:vimfiles,
6704 $VIM/vimfiles,
6705 $VIMRUNTIME,
6706 $VIM/vimfiles/after,
6707 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006708 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 $VIM/vimfiles,
6710 $VIMRUNTIME,
6711 $VIM/vimfiles/after,
6712 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006713 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 $VIMRUNTIME,
6715 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006716 Haiku: "$BE_USER_SETTINGS/vim,
6717 $VIM/vimfiles,
6718 $VIMRUNTIME,
6719 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006720 $BE_USER_SETTINGS/vim/after"
6721 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 $VIM/vimfiles,
6723 $VIMRUNTIME,
6724 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006725 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 This is a list of directories which will be searched for runtime
6728 files:
6729 filetype.vim filetypes by file name |new-filetype|
6730 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006731 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 colors/ color scheme files |:colorscheme|
6733 compiler/ compiler files |:compiler|
6734 doc/ documentation |write-local-help|
6735 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006736 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 indent/ indent scripts |indent-expression|
6738 keymap/ key mapping files |mbyte-keymap|
6739 lang/ menu translations |:menutrans|
6740 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006741 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 plugin/ plugin scripts |write-plugin|
6743 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006744 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 syntax/ syntax files |mysyntaxfile|
6746 tutor/ files for vimtutor |tutor|
6747
6748 And any other file searched for with the |:runtime| command.
6749
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006750 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6751
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 The defaults for most systems are setup to search five locations:
6753 1. In your home directory, for your personal preferences.
6754 2. In a system-wide Vim directory, for preferences from the system
6755 administrator.
6756 3. In $VIMRUNTIME, for files distributed with Vim.
6757 *after-directory*
6758 4. In the "after" directory in the system-wide Vim directory. This is
6759 for the system administrator to overrule or add to the distributed
6760 defaults (rarely needed)
6761 5. In the "after" directory in your home directory. This is for
6762 personal preferences to overrule or add to the distributed defaults
6763 or system-wide settings (rarely needed).
6764
Bram Moolenaard0796902016-09-16 20:02:31 +02006765 More entries are added when using |packages|. If it gets very long
6766 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6767 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006768
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6770 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006771 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 wildcards.
6773 See |:runtime|.
6774 Example: >
6775 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6776< This will use the directory "~/vimruntime" first (containing your
6777 personal Vim runtime files), then "/mygroup/vim" (shared between a
6778 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6779 files).
6780 You probably should always include $VIMRUNTIME somewhere, to use the
6781 distributed runtime files. You can put a directory before $VIMRUNTIME
6782 to find files which replace a distributed runtime files. You can put
6783 a directory after $VIMRUNTIME to find files which add to distributed
6784 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006785 When Vim is started with |--clean| the home directory entries are not
6786 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 This option cannot be set from a |modeline| or in the |sandbox|, for
6788 security reasons.
6789
6790 *'scroll'* *'scr'*
6791'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006792 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6794 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006795 changes. This may happen when enabling the |status-line| or
6796 'tabline' option after setting the 'scroll' option.
6797 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006798 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006799 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800
6801 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6802'scrollbind' 'scb' boolean (default off)
6803 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006804 See also |scroll-binding|. When this option is set, scrolling the
6805 current window also scrolls other scrollbind windows (windows that
6806 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 differences between two versions of a file, see 'diff'.
6808 See |'scrollopt'| for options that determine how this option should be
6809 interpreted.
6810 This option is mostly reset when splitting a window to edit another
6811 file. This means that ":split | edit file" results in two windows
6812 with scroll-binding, but ":split file" does not.
6813
Bram Moolenaarae20f342019-11-05 21:09:23 +01006814 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6815'scrollfocus' 'scf' boolean (default off)
6816 global
6817 {only for MS-Windows GUI}
6818 When using the scroll wheel and this option is set, the window under
6819 the mouse pointer is scrolled. With this option off the current
6820 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006821 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006822
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 *'scrolljump'* *'sj'*
6824'scrolljump' 'sj' number (default 1)
6825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 Minimal number of lines to scroll when the cursor gets off the
6827 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6828 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006829 When set to a negative number from -1 to -100 this is used as the
6830 percentage of the window height. Thus -50 scrolls half the window
6831 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 NOTE: This option is set to 1 when 'compatible' is set.
6833
6834 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006835'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006836 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 Minimal number of screen lines to keep above and below the cursor.
6838 This will make some context visible around where you are working. If
6839 you set it to a very large value (999) the cursor line will always be
6840 in the middle of the window (except at the start or end of the file or
6841 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006842 After using the local value, go back the global value with one of
6843 these two: >
6844 setlocal scrolloff<
6845 setlocal scrolloff=-1
6846< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 NOTE: This option is set to 0 when 'compatible' is set.
6848
6849 *'scrollopt'* *'sbo'*
6850'scrollopt' 'sbo' string (default "ver,jump")
6851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006853 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6854 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 The following words are available:
6856 ver Bind vertical scrolling for 'scrollbind' windows
6857 hor Bind horizontal scrolling for 'scrollbind' windows
6858 jump Applies to the offset between two windows for vertical
6859 scrolling. This offset is the difference in the first
6860 displayed line of the bound windows. When moving
6861 around in a window, another 'scrollbind' window may
6862 reach a position before the start or after the end of
6863 the buffer. The offset is not changed though, when
6864 moving back the 'scrollbind' window will try to scroll
6865 to the desired position when possible.
6866 When now making that window the current one, two
6867 things can be done with the relative offset:
6868 1. When "jump" is not included, the relative offset is
6869 adjusted for the scroll position in the new current
6870 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006871 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 2. When "jump" is included, the other windows are
6873 scrolled to keep the same relative offset. When
6874 going back to the other window, it still uses the
6875 same relative offset.
6876 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006877 When 'diff' mode is active there always is vertical scroll binding,
6878 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879
6880 *'sections'* *'sect'*
6881'sections' 'sect' string (default "SHNHH HUnhsh")
6882 global
6883 Specifies the nroff macros that separate sections. These are pairs of
6884 two letters (See |object-motions|). The default makes a section start
6885 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6886
6887 *'secure'* *'nosecure'* *E523*
6888'secure' boolean (default off)
6889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 When on, ":autocmd", shell and write commands are not allowed in
6891 ".vimrc" and ".exrc" in the current directory and map commands are
6892 displayed. Switch it off only if you know that you will not run into
6893 problems, or when the 'exrc' option is off. On Unix this option is
6894 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006895 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 'secure' at the end of your ~/.vimrc then.
6897 This option cannot be set from a |modeline| or in the |sandbox|, for
6898 security reasons.
6899
6900 *'selection'* *'sel'*
6901'selection' 'sel' string (default "inclusive")
6902 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 This option defines the behavior of the selection. It is only used
6904 in Visual and Select mode.
6905 Possible values:
6906 value past line inclusive ~
6907 old no yes
6908 inclusive yes yes
6909 exclusive yes no
6910 "past line" means that the cursor is allowed to be positioned one
6911 character past the line.
6912 "inclusive" means that the last character of the selection is included
6913 in an operation. For example, when "x" is used to delete the
6914 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006915 When "old" is used and 'virtualedit' allows the cursor to move past
6916 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 Note that when "exclusive" is used and selecting from the end
6918 backwards, you cannot include the last character of a line, when
6919 starting in Normal mode and 'virtualedit' empty.
6920
6921 The 'selection' option is set by the |:behave| command.
6922
6923 *'selectmode'* *'slm'*
6924'selectmode' 'slm' string (default "")
6925 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006926 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 Select mode instead of Visual mode, when a selection is started.
6928 Possible values:
6929 mouse when using the mouse
6930 key when using shifted special keys
6931 cmd when using "v", "V" or CTRL-V
6932 See |Select-mode|.
6933 The 'selectmode' option is set by the |:behave| command.
6934
6935 *'sessionoptions'* *'ssop'*
6936'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006937 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006939 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 feature}
6941 Changes the effect of the |:mksession| command. It is a comma
6942 separated list of words. Each word enables saving and restoring
6943 something:
6944 word save and restore ~
6945 blank empty windows
6946 buffers hidden and unloaded buffers, not just those in windows
6947 curdir the current directory
6948 folds manually created folds, opened/closed folds and local
6949 fold options
6950 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006951 and contain at least one lowercase letter. Only
6952 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 help the help window
6954 localoptions options and mappings local to a window or buffer (not
6955 global values for local options)
6956 options all options and mappings (also global values for local
6957 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006958 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 resize size of the Vim window: 'lines' and 'columns'
6960 sesdir the directory in which the session file is located
6961 will become the current directory (useful with
6962 projects accessed over a network from different
6963 systems)
6964 slash backslashes in file names replaced with forward
6965 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006966 tabpages all tab pages; without this only the current tab page
6967 is restored, so that you can make a session for each
6968 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006969 terminal include terminal windows where the command can be
6970 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 unix with Unix end-of-line format (single <NL>), even when
6972 on Windows or DOS
6973 winpos position of the whole Vim window
6974 winsize window sizes
6975
6976 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006977 When neither "curdir" nor "sesdir" is included, file names are stored
6978 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006979 If you leave out "options" many things won't work well after restoring
6980 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 "slash" and "unix" are useful on Windows when sharing session files
6982 with Unix. The Unix version of Vim cannot source dos format scripts,
6983 but the Windows version of Vim can source unix format scripts.
6984
6985 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006986'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 global
6988 Name of the shell to use for ! and :! commands. When changing the
6989 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6990 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006991 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 See |option-backslash| about including spaces and backslashes.
6993 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006994
Bram Moolenaara2baa732022-02-04 16:09:54 +00006995 In |restricted-mode| shell commands will not be possible. This mode
6996 is used if the value of $SHELL ends in "false" or "nologin".
6997
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006998 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006999 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7001< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007002 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007004 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007006 Example with escaped space (Vim will do this when initializing the
7007 option from $SHELL): >
7008 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007009< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007010 backslashes are consumed by `:set`.
7011
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 Under MS-Windows, when the executable ends in ".com" it must be
7013 included. Thus setting the shell to "command.com" or "4dos.com"
7014 works, but "command" and "4dos" do not work for all commands (e.g.,
7015 filtering).
7016 For unknown reasons, when using "4dos.com" the current directory is
7017 changed to "C:\". To avoid this set 'shell' like this: >
7018 :set shell=command.com\ /c\ 4dos
7019< This option cannot be set from a |modeline| or in the |sandbox|, for
7020 security reasons.
7021
7022 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007023'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007024 Win32, when 'shell' contains "powershell":
7025 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007026 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007029 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7030 For MS-Windows, the default is set according to the value of 'shell',
7031 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007032 On Unix it can have more than one flag. Each white space separated
7033 part is passed as an argument to the shell command.
7034 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007035 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 This option cannot be set from a |modeline| or in the |sandbox|, for
7037 security reasons.
7038
7039 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007040'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7041 "2>&1| tee", or
7042 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 {not available when compiled without the |+quickfix|
7045 feature}
7046 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007047 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 including spaces and backslashes.
7049 The name of the temporary file can be represented by "%s" if necessary
7050 (the file name is appended automatically if no %s appears in the value
7051 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007052 For the Amiga the default is ">". For MS-Windows using powershell the
7053 default is "2>&1 | Out-File -Encoding default", otherwise the default
7054 is ">%s 2>&1". The output is directly saved in a file and not echoed
7055 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007056 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 in a file and echoed to the screen. If the 'shell' option is "csh" or
7058 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007059 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007060 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7061 means that stderr is also included. Before using the 'shell' option a
7062 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007063 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7064 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 The initialization of this option is done after reading the ".vimrc"
7066 and the other initializations, so that when the 'shell' option is set
7067 there, the 'shellpipe' option changes automatically, unless it was
7068 explicitly set before.
7069 When 'shellpipe' is set to an empty string, no redirection of the
7070 ":make" output will be done. This is useful if you use a 'makeprg'
7071 that writes to 'makeef' by itself. If you want no piping, but do
7072 want to include the 'makeef', set 'shellpipe' to a single space.
7073 Don't forget to precede the space with a backslash: ":set sp=\ ".
7074 In the future pipes may be used for filtering and this option will
7075 become obsolete (at least for Unix).
7076 This option cannot be set from a |modeline| or in the |sandbox|, for
7077 security reasons.
7078
7079 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007080'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 Quoting character(s), put around the command passed to the shell, for
7083 the "!" and ":!" commands. The redirection is kept outside of the
7084 quoting. See 'shellxquote' to include the redirection. It's
7085 probably not useful to set both options.
7086 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007087 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007088 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 This option cannot be set from a |modeline| or in the |sandbox|, for
7090 security reasons.
7091
7092 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007093'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7094 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 String to be used to put the output of a filter command in a temporary
7097 file. See also |:!|. See |option-backslash| about including spaces
7098 and backslashes.
7099 The name of the temporary file can be represented by "%s" if necessary
7100 (the file name is appended automatically if no %s appears in the value
7101 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007102 The default is ">". For Unix, if the 'shell' option is "csh" or
7103 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007104 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007105 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7106 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007107 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7108 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007109 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7110 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 The initialization of this option is done after reading the ".vimrc"
7112 and the other initializations, so that when the 'shell' option is set
7113 there, the 'shellredir' option changes automatically unless it was
7114 explicitly set before.
7115 In the future pipes may be used for filtering and this option will
7116 become obsolete (at least for Unix).
7117 This option cannot be set from a |modeline| or in the |sandbox|, for
7118 security reasons.
7119
7120 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7121'shellslash' 'ssl' boolean (default off)
7122 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007123 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007125 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007126 powershell.exe. Backward slashes can still be typed, but they are
7127 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 Note that setting or resetting this option has no effect for some
7129 existing file names, thus this option needs to be set before opening
7130 any file for best results. This might change in the future.
7131 'shellslash' only works when a backslash can be used as a path
7132 separator. To test if this is so use: >
7133 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007134< Also see 'completeslash'.
7135
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007136 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7137'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7138 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007139 When on, use temp files for shell commands. When off use a pipe.
7140 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007141 Currently a pipe is only supported on Unix and MS-Windows 2K and
7142 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007143 :if has("filterpipe")
7144< The advantage of using a pipe is that nobody can read the temp file
7145 and the 'shell' command does not need to support redirection.
7146 The advantage of using a temp file is that the file type and encoding
7147 can be detected.
7148 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7149 |FilterWritePost| autocommands event are not triggered when
7150 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007151 The `system()` function does not respect this option and always uses
7152 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007153 NOTE: This option is set to the Vim default value when 'compatible'
7154 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007155
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 *'shelltype'* *'st'*
7157'shelltype' 'st' number (default 0)
7158 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007159 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 On the Amiga this option influences the way how the commands work
7161 which use a shell.
7162 0 and 1: always use the shell
7163 2 and 3: use the shell only to filter lines
7164 4 and 5: use shell only for ':sh' command
7165 When not using the shell, the command is executed directly.
7166
7167 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7168 1 and 3: use "shell cmd" to start external commands
7169
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007170 *'shellxescape'* *'sxe'*
7171'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007172 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007173 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007174 When 'shellxquote' is set to "(" then the characters listed in this
7175 option will be escaped with a '^' character. This makes it possible
7176 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007177 This option cannot be set from a |modeline| or in the |sandbox|, for
7178 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007179
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 *'shellxquote'* *'sxq'*
7181'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007182 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007183 for Win32, when 'shell' is
7184 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007185 for Win32, when 'shell' contains "sh"
7186 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 for Unix, when using system(): "\"")
7188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 Quoting character(s), put around the command passed to the shell, for
7190 the "!" and ":!" commands. Includes the redirection. See
7191 'shellquote' to exclude the redirection. It's probably not useful
7192 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007193 When the value is '(' then ')' is appended. When the value is '"('
7194 then ')"' is appended.
7195 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007196 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007197 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7198 pwsh.exe which automatically strips off the first and last quote on a
7199 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7200 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007201 'shell', to reduce the need to set this option by the user. See
7202 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 This option cannot be set from a |modeline| or in the |sandbox|, for
7204 security reasons.
7205
7206 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7207'shiftround' 'sr' boolean (default off)
7208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 Round indent to multiple of 'shiftwidth'. Applies to > and <
7210 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7211 a multiple of 'shiftwidth' (this is Vi compatible).
7212 NOTE: This option is reset when 'compatible' is set.
7213
7214 *'shiftwidth'* *'sw'*
7215'shiftwidth' 'sw' number (default 8)
7216 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007217 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007219 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007220 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007221
7222 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007223'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7224 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007225 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 This option helps to avoid all the |hit-enter| prompts caused by file
7227 messages, for example with CTRL-G, and to avoid some other messages.
7228 It is a list of flags:
7229 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007230 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7231 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7232 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7233 m use "[+]" instead of "[Modified]" *shm-m*
7234 n use "[New]" instead of "[New File]" *shm-n*
7235 r use "[RO]" instead of "[readonly]" *shm-r*
7236 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007238 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7239 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007240 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007241 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007243 o overwrite message for writing a file with subsequent *shm-o*
7244 message for reading a file (useful for ":wn" or when
7245 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007246 O message for reading a file overwrites any previous *shm-O*
7247 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007248 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7249 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007250 the search count do not show "W" before the count message
7251 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007252 t truncate file message at the start if it is too long *shm-t*
7253 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007254 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007255 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007256 long to fit on the command line; "..." will appear in the
7257 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007258 W don't give "written" or "[w]" when writing a file *shm-W*
7259 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007260 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007261 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007262 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007263 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007264 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7265 match", "Pattern not found", "Back at original", etc.
7266 C don't give messages while scanning for ins-completion *shm-C*
7267 items, for instance "scanning tags"
7268 q use "recording" instead of "recording @a" *shm-q*
7269 F don't give the file info when editing a file, like *shm-F*
7270 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007271 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007272 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007273 "[1/5]". When the "S" flag is not present (e.g. search count
7274 is shown), the "search hit BOTTOM, continuing at TOP" and
7275 "search hit TOP, continuing at BOTTOM" messages are only
7276 indicated by a "W" (Mnemonic: Wrapped) letter before the
7277 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278
7279 This gives you the opportunity to avoid that a change between buffers
7280 requires you to hit <Enter>, but still gives as useful a message as
7281 possible for the space available. To get the whole message that you
7282 would have got with 'shm' empty, use ":file!"
7283 Useful values:
7284 shm= No abbreviation of message.
7285 shm=a Abbreviation, but no loss of information.
7286 shm=at Abbreviation, and truncate message when necessary.
7287
7288 NOTE: This option is set to the Vi default value when 'compatible' is
7289 set and to the Vim default value when 'compatible' is reset.
7290
7291 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7292'shortname' 'sn' boolean (default off)
7293 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 Filenames are assumed to be 8 characters plus one extension of 3
7295 characters. Multiple dots in file names are not allowed. When this
7296 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007297 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007299 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300
7301 *'showbreak'* *'sbr'* *E595*
7302'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007303 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007304 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 feature}
7306 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007307 values are "> " or "+++ ": >
7308 :set showbreak=>\
7309< Note the backslash to escape the trailing space. It's easier like
7310 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007311 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007312< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 comma (in a future version the comma might be used to separate the
7314 part that is shown at the end and at the start of a line).
7315 The characters are highlighted according to the '@' flag in
7316 'highlight'.
7317 Note that tabs after the showbreak will be displayed differently.
7318 If you want the 'showbreak' to appear in between line numbers, add the
7319 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007320 A window-local value overrules a global value. If the global value is
7321 set and you want no value in the current window use NONE: >
7322 :setlocal showbreak=NONE
7323<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007325'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7326 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007327 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007328 Show (partial) command in the last line of the screen. Set this
7329 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 In Visual mode the size of the selected area is shown:
7331 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007332 If the number of bytes is different it is also displayed: "2-6"
7333 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007335 - When selecting a block, the size in screen characters:
7336 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007337 This information can be displayed in an alternative location using the
7338 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 NOTE: This option is set to the Vi default value when 'compatible' is
7340 set and to the Vim default value when 'compatible' is reset.
7341
Luuk van Baalba936f62022-12-15 13:15:39 +00007342 *'showcmdloc'* *'sloc'*
7343'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007344 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007345 This option can be used to display the (partially) entered command in
7346 another location. Possible values are:
7347 last Last line of the screen (default).
7348 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007349 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007350 Setting this option to "statusline" or "tabline" means that these will
7351 be redrawn whenever the command changes, which can be on every key
7352 pressed.
7353 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7354 place the text. Without a custom 'statusline' or 'tabline' it will be
7355 displayed in a convenient location.
7356
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7358'showfulltag' 'sft' boolean (default off)
7359 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 When completing a word in insert mode (see |ins-completion|) from the
7361 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007362 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 matched a C function, you can see a template for what arguments are
7364 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007365 Note that this doesn't work well together with having "longest" in
7366 'completeopt', because the completion from the search pattern may not
7367 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368
7369 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7370'showmatch' 'sm' boolean (default off)
7371 global
7372 When a bracket is inserted, briefly jump to the matching one. The
7373 jump is only done if the match can be seen on the screen. The time to
7374 show the match can be set with 'matchtime'.
7375 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007376 seen or not).
7377 This option is reset when 'paste' is set and restored when 'paste' is
7378 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 When the 'm' flag is not included in 'cpoptions', typing a character
7380 will immediately move the cursor back to where it belongs.
7381 See the "sm" field in 'guicursor' for setting the cursor shape and
7382 blinking when showing the match.
7383 The 'matchpairs' option can be used to specify the characters to show
7384 matches for. 'rightleft' and 'revins' are used to look for opposite
7385 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007386 Also see the matchparen plugin for highlighting the match when moving
7387 around |pi_paren.txt|.
7388 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389
7390 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7391'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7392 global
7393 If in Insert, Replace or Visual mode put a message on the last line.
7394 Use the 'M' flag in 'highlight' to set the type of highlighting for
7395 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007396 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397 doesn't mean XIM is really active, especially when 'imactivatekey' is
7398 not set.
7399 NOTE: This option is set to the Vi default value when 'compatible' is
7400 set and to the Vim default value when 'compatible' is reset.
7401
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007402 *'showtabline'* *'stal'*
7403'showtabline' 'stal' number (default 1)
7404 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007405 The value of this option specifies when the line with tab page labels
7406 will be displayed:
7407 0: never
7408 1: only if there are at least two tab pages
7409 2: always
7410 This is both for the GUI and non-GUI implementation of the tab pages
7411 line.
7412 See |tab-page| for more information about tab pages.
7413
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 *'sidescroll'* *'ss'*
7415'sidescroll' 'ss' number (default 0)
7416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 The minimal number of columns to scroll horizontally. Used only when
7418 the 'wrap' option is off and the cursor is moved off of the screen.
7419 When it is zero the cursor will be put in the middle of the screen.
7420 When using a slow terminal set it to a large number or 0. When using
7421 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7422 commands.
7423
7424 *'sidescrolloff'* *'siso'*
7425'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007426 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007428 right of the cursor if 'nowrap' is set. Setting this option to a
7429 value greater than 0 while having |'sidescroll'| also at a non-zero
7430 value makes some context visible in the line you are scrolling in
7431 horizontally (except at beginning of the line). Setting this option
7432 to a large value (like 999) has the effect of keeping the cursor
7433 horizontally centered in the window, as long as one does not come too
7434 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007435 After using the local value, go back the global value with one of
7436 these two: >
7437 setlocal sidescrolloff<
7438 setlocal sidescrolloff=-1
7439< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440
7441 Example: Try this together with 'sidescroll' and 'listchars' as
7442 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007443 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444
7445 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7446 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007447<
7448 *'signcolumn'* *'scl'*
7449'signcolumn' 'scl' string (default "auto")
7450 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007451 {not available when compiled without the |+signs|
7452 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007453 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007454 "auto" only when there is a sign to display
7455 "no" never
7456 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007457 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007458 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7461'smartcase' 'scs' boolean (default off)
7462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 Override the 'ignorecase' option if the search pattern contains upper
7464 case characters. Only used when the search pattern is typed and
7465 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007466 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7468 recalling the search pattern from history and hitting <Enter>.
7469 NOTE: This option is reset when 'compatible' is set.
7470
7471 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7472'smartindent' 'si' boolean (default off)
7473 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 Do smart autoindenting when starting a new line. Works for C-like
7475 programs, but can also be used for other languages. 'cindent' does
7476 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007477 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007478 setting 'si' has no effect. 'indentexpr' is a more advanced
7479 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 Normally 'autoindent' should also be on when using 'smartindent'.
7481 An indent is automatically inserted:
7482 - After a line ending in '{'.
7483 - After a line starting with a keyword from 'cinwords'.
7484 - Before a line starting with '}' (only with the "O" command).
7485 When typing '}' as the first character in a new line, that line is
7486 given the same indent as the matching '{'.
7487 When typing '#' as the first character in a new line, the indent for
7488 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007489 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7491 When using the ">>" command, lines starting with '#' are not shifted
7492 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007493 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007494 This option is reset when 'paste' is set and restored when 'paste' is
7495 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496
7497 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7498'smarttab' 'sta' boolean (default off)
7499 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007501 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7502 <BS> will delete a 'shiftwidth' worth of space at the start of the
7503 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007504 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007505 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7506 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007507 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007509 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007510 This option is reset when 'paste' is set and restored when 'paste' is
7511 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 NOTE: This option is reset when 'compatible' is set.
7513
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007514 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7515'smoothscroll' 'sms' boolean (default off)
7516 local to window
7517 Scrolling works with screen lines. When 'wrap' is set and the first
7518 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007519 above the window. "<<<" is displayed at the start of the first line,
7520 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007521 You may also want to add "lastline" to the 'display' option to show as
7522 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007523 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007524
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 *'softtabstop'* *'sts'*
7526'softtabstop' 'sts' number (default 0)
7527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 Number of spaces that a <Tab> counts for while performing editing
7529 operations, like inserting a <Tab> or using <BS>. It "feels" like
7530 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7531 used. This is useful to keep the 'ts' setting at its standard value
7532 of 8, while being able to edit like it is set to 'sts'. However,
7533 commands like "x" still work on the actual characters.
7534 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007535 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007536 'softtabstop' is set to 0 when the 'paste' option is set and restored
7537 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7539 spaces is minimized by using <Tab>s.
7540 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7541 set.
7542 NOTE: This option is set to 0 when 'compatible' is set.
7543
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007544 If Vim is compiled with the |+vartabs| feature then the value of
7545 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7546 anything other than an empty string.
7547
Bram Moolenaar217ad922005-03-20 22:37:15 +00007548 *'spell'* *'nospell'*
7549'spell' boolean (default off)
7550 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007551 {not available when compiled without the |+syntax|
7552 feature}
7553 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007554 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007555
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007556 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007557'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007558 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007559 {not available when compiled without the |+syntax|
7560 feature}
7561 Pattern to locate the end of a sentence. The following word will be
7562 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007563 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007564 When this check is not wanted make this option empty.
7565 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007566 Be careful with special characters, see |option-backslash| about
7567 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007568 To set this option automatically depending on the language, see
7569 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007570
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007571 *'spellfile'* *'spf'*
7572'spellfile' 'spf' string (default empty)
7573 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007574 {not available when compiled without the |+syntax|
7575 feature}
7576 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007577 commands. It must end in ".{encoding}.add". You need to include the
7578 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007579 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007580 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007581 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007582 |zg| and |zw| commands can be used to access each. This allows using
7583 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007584 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007585 you: Using the first directory in 'runtimepath' that is writable. If
7586 there is no "spell" directory yet it will be created. For the file
7587 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007588 ignoring the region.
7589 The resulting ".spl" file will be used for spell checking, it does not
7590 have to appear in 'spelllang'.
7591 Normally one file is used for all regions, but you can add the region
7592 name if you want to. However, it will then only be used when
7593 'spellfile' is set to it, for entries in 'spelllang' only files
7594 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007595 This option cannot be set from a |modeline| or in the |sandbox|, for
7596 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007597
Bram Moolenaar217ad922005-03-20 22:37:15 +00007598 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007599'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007600 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007601 {not available when compiled without the |+syntax|
7602 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007603 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007604 on spellchecking will be done for these languages. Example: >
7605 set spelllang=en_us,nl,medical
7606< This means US English, Dutch and medical words are recognized. Words
7607 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007608 The word list name must consist of alphanumeric characters, a dash or
7609 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007610 recommended to separate the two letter language name from a
7611 specification. Thus "en-rare" is used for rare English words.
7612 A region name must come last and have the form "_xx", where "xx" is
7613 the two-letter, lower case region name. You can use more than one
7614 region by listing them: "en_us,en_ca" supports both US and Canadian
7615 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007616 Britain. (Note: currently en_au and en_nz dictionaries are older than
7617 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007618 If the name "cjk" is included East Asian characters are excluded from
7619 spell checking. This is useful when editing text that also has Asian
7620 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007621 Note that the "medical" dictionary does not exist, it is just an
7622 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007623 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007624 As a special case the name of a .spl file can be given as-is. The
7625 first "_xx" in the name is removed and used as the region name
7626 (_xx is an underscore, two letters and followed by a non-letter).
7627 This is mainly for testing purposes. You must make sure the correct
7628 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007629 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007630 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7631 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007632 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007633
Bram Moolenaar98692072006-02-04 00:57:42 +00007634 If the |spellfile.vim| plugin is active and you use a language name
7635 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7636 will ask you if you want to download the file.
7637
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007638 After this option has been set successfully, Vim will source the files
7639 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007640 up to the first character that is not an ASCII letter or number and
7641 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007642
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007643 *'spelloptions'* *'spo'*
7644'spelloptions' 'spo' string (default "")
7645 local to buffer
7646 {not available when compiled without the |+syntax|
7647 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007648 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007649 camel When a word is CamelCased, assume "Cased" is a
7650 separate word: every upper-case character in a word
7651 that comes after a lower case character indicates the
7652 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007653
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007654 *'spellsuggest'* *'sps'*
7655'spellsuggest' 'sps' string (default "best")
7656 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007657 {not available when compiled without the |+syntax|
7658 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007659 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007660 the |spellsuggest()| function. This is a comma-separated list of
7661 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007662
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007663 best Internal method that works best for English. Finds
7664 changes like "fast" and uses a bit of sound-a-like
7665 scoring to improve the ordering.
7666
7667 double Internal method that uses two methods and mixes the
7668 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007669 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007670 word. That only works when the language specifies
7671 sound folding. Can be slow and doesn't always give
7672 better results.
7673
7674 fast Internal method that only checks for simple changes:
7675 character inserts/deletes/swaps. Works well for
7676 simple typing mistakes.
7677
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007678 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007679 Not used for |spellsuggest()|. The number of
7680 suggestions is never more than the value of 'lines'
7681 minus two.
7682
Bram Moolenaar585ee072022-01-29 11:22:17 +00007683 timeout:{millisec} Limit the time searching for suggestions to
7684 {millisec} milli seconds. Applies to the following
7685 methods. When omitted the limit is 5000. When
7686 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007687 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007688
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007689 file:{filename} Read file {filename}, which must have two columns,
7690 separated by a slash. The first column contains the
7691 bad word, the second column the suggested good word.
7692 Example:
7693 theribal/terrible ~
7694 Use this for common mistakes that do not appear at the
7695 top of the suggestion list with the internal methods.
7696 Lines without a slash are ignored, use this for
7697 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007698 The word in the second column must be correct,
7699 otherwise it will not be used. Add the word to an
7700 ".add" file if it is currently flagged as a spelling
7701 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007702 The file is used for all languages.
7703
7704 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007705 trouble with spaces. Best is to call a function
7706 without arguments, see |expr-option-function|.
7707 |v:val| holds the badly spelled word. The expression
7708 must evaluate to a List of Lists, each with a
7709 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007710 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007711 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007712 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007713 internal methods use. A lower score is better.
7714 This may invoke |spellsuggest()| if you temporarily
7715 set 'spellsuggest' to exclude the "expr:" part.
7716 Errors are silently ignored, unless you set the
7717 'verbose' option to a non-zero value.
7718
7719 Only one of "best", "double" or "fast" may be used. The others may
7720 appear several times in any order. Example: >
7721 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7722<
7723 This option cannot be set from a |modeline| or in the |sandbox|, for
7724 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007725
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7727'splitbelow' 'sb' boolean (default off)
7728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 When on, splitting a window will put the new window below the current
7730 one. |:split|
7731
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007732 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007733'splitkeep' 'spk' string (default "cursor")
7734 global
7735 The value of this option determines the scroll behavior when opening,
7736 closing or resizing horizontal splits.
7737
7738 Possible values are:
7739 cursor Keep the same relative cursor position.
7740 screen Keep the text on the same screen line.
7741 topline Keep the topline the same.
7742
7743 For the "screen" and "topline" values, the cursor position will be
7744 changed when necessary. In this case, the jumplist will be populated
7745 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007746 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007747
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7749'splitright' 'spr' boolean (default off)
7750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 When on, splitting a window will put the new window right of the
7752 current one. |:vsplit|
7753
7754 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7755'startofline' 'sol' boolean (default on)
7756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007758 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007759 (if possible). This applies to the commands:
7760 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7761 - "d", "<<" and ">>" with a linewise operator
7762 - "%" with a count
7763 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7764 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 In case of buffer changing commands the cursor is placed at the column
7766 where it was the last time the buffer was edited.
7767 NOTE: This option is set when 'compatible' is set.
7768
Bram Moolenaar00654022011-02-25 14:42:19 +01007769 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007771 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 {not available when compiled without the |+statusline|
7773 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007774 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 Also see |status-line|.
7776
7777 The option consists of printf style '%' items interspersed with
7778 normal text. Each status line item is of the form:
7779 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007780 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007781 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782
Bram Moolenaar238a5642006-02-21 22:12:05 +00007783 When the option starts with "%!" then it is used as an expression,
7784 evaluated and the result is used as the option value. Example: >
7785 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007786< The *g:statusline_winid* variable will be set to the |window-ID| of the
7787 window that the status line belongs to.
7788 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007789 Note that the "%!" expression is evaluated in the context of the
7790 current window and buffer, while %{} items are evaluated in the
7791 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007792
7793 When there is error while evaluating the option then it will be made
7794 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007795 When the result contains unprintable characters the result is
7796 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007797
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 Note that the only effect of 'ruler' when this option is set (and
7799 'laststatus' is 2) is controlling the output of |CTRL-G|.
7800
7801 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007802 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007804 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 minwid Minimum width of the item, padding as set by '-' & '0'.
7806 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007807 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 on the left for text items. Numeric items will be
7809 shifted down to maxwid-2 digits followed by '>'number
7810 where number is the amount of missing digits, much like
7811 an exponential notation.
7812 item A one letter code as described below.
7813
7814 Following is a description of the possible statusline items. The
7815 second character in "item" is the type:
7816 N for number
7817 S for string
7818 F for flags as described below
7819 - not applicable
7820
7821 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007822 f S Path to the file in the buffer, as typed or relative to current
7823 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 F S Full path to the file in the buffer.
7825 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007826 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007828 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007830 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007832 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007834 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007836 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7838 being used: "<keymap>"
7839 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007840 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 B N As above, in hexadecimal.
7842 o N Byte number in file of byte under cursor, first byte is 1.
7843 Mnemonic: Offset from start of file (with one added)
7844 {not available when compiled without |+byte_offset| feature}
7845 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007846 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 l N Line number.
7848 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007849 c N Column number (byte index).
7850 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007851 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 p N Percentage through file in lines as in |CTRL-G|.
7853 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007854 percentage described for 'ruler'. Always 3 in length, unless
7855 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007856 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007857 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007859 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007860 Note that there is no '%' before the closing '}'. The
7861 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007862 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007863 {% - This is almost same as { except the result of the expression is
7864 re-evaluated as a statusline format string. Thus if the
7865 return value of expr contains % items they will get expanded.
7866 The expression can contain the } character, the end of
7867 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007868 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007869 func! Stl_filename() abort
7870 return "%t"
7871 endfunc
7872< `stl=%{Stl_filename()}` results in `"%t"`
7873 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007874 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 ( - Start of item group. Can be used for setting the width and
7876 alignment of a section. Must be followed by %) somewhere.
7877 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007878 T N For 'tabline': start of tab page N label. Use %T after the last
7879 label. This information is used for mouse clicks.
7880 X N For 'tabline': start of close tab N label. Use %X after the
7881 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7882 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 < - Where to truncate line if too long. Default is at the start.
7884 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007885 = - Separation point between alignment sections. Each section will
7886 be separated by an equal number of spaces. With one %= what
7887 comes after it will be right-aligned. With two %= there is a
7888 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007890 # - Set highlight group. The name must follow and then a # again.
7891 Thus use %#HLname# for highlight group HLname. The same
7892 highlighting is used, also for the statusline of non-current
7893 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007895 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007896 The difference between User{N} and StatusLine will be applied to
7897 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 The number N must be between 1 and 9. See |hl-User1..9|
7899
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007900 When displaying a flag, Vim removes the leading comma, if any, when
7901 that flag comes right after plaintext. This will make a nice display
7902 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903
Bram Moolenaar582fd852005-03-28 20:58:01 +00007904 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 not set) and a minwid is not set for the group, the whole group will
7906 become empty. This will make a group like the following disappear
7907 completely from the statusline when none of the flags are set. >
7908 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007909< Beware that an expression is evaluated each and every time the status
7910 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007911 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007912 While evaluating %{} the current buffer and current window will be set
7913 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007914 currently being drawn. The expression will evaluate in this context.
7915 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7916 real current buffer and "g:actual_curwin" to the |window-ID| of the
7917 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007918
Bram Moolenaar30b65812012-07-12 22:01:11 +02007919 The 'statusline' option will be evaluated in the |sandbox| if set from
7920 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007921 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007922
7923 It is not allowed to change text or jump to another window while
7924 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925
7926 If the statusline is not updated when you want it (e.g., after setting
7927 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007928 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007930 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 Otherwise the result is taken as flag text and applied to the rules
7932 described above.
7933
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007934 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007936 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937
7938 Examples:
7939 Emulate standard status line with 'ruler' set >
7940 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7941< Similar, but add ASCII value of char under the cursor (like "ga") >
7942 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7943< Display byte count and byte value, modified flag in red. >
7944 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7945 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7946< Display a ,GZ flag if a compressed file is loaded >
7947 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7948< In the |:autocmd|'s: >
7949 :let b:gzflag = 1
7950< And: >
7951 :unlet b:gzflag
7952< And define this function: >
7953 :function VarExists(var, val)
7954 : if exists(a:var) | return a:val | else | return '' | endif
7955 :endfunction
7956<
7957 *'suffixes'* *'su'*
7958'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7959 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 Files with these suffixes get a lower priority when multiple files
7961 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007962 suffixes. Spaces after the comma are ignored. A dot is also seen as
7963 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 separator, precede it with a backslash (see |option-backslash| about
7965 including spaces and backslashes).
7966 See 'wildignore' for completely ignoring files.
7967 The use of |:set+=| and |:set-=| is preferred when adding or removing
7968 suffixes from the list. This avoids problems when a future version
7969 uses another default.
7970
7971 *'suffixesadd'* *'sua'*
7972'suffixesadd' 'sua' string (default "")
7973 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007974 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 file for the "gf", "[I", etc. commands. Example: >
7976 :set suffixesadd=.java
7977<
7978 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7979'swapfile' 'swf' boolean (default on)
7980 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007981 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 swapfile is not wanted for a specific buffer. For example, with
7983 confidential information that even root must not be able to access.
7984 Careful: All text will be in memory:
7985 - Don't use this for big files.
7986 - Recovery will be impossible!
7987 A swapfile will only be present when |'updatecount'| is non-zero and
7988 'swapfile' is set.
7989 When 'swapfile' is reset, the swap file for the current buffer is
7990 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7991 non-zero, a swap file is immediately created.
7992 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007993 If you want to open a new buffer without creating a swap file for it,
7994 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007995 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996
7997 This option is used together with 'bufhidden' and 'buftype' to
7998 specify special kinds of buffers. See |special-buffers|.
7999
8000 *'swapsync'* *'sws'*
8001'swapsync' 'sws' string (default "fsync")
8002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008004 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 When this option is empty parts of the swap file may be in memory and
8006 not written to disk. When the system crashes you may lose more work.
8007 On Unix the system does a sync now and then without Vim asking for it,
8008 so the disadvantage of setting this option off is small. On some
8009 systems the swap file will not be written at all. For a unix system
8010 setting it to "sync" will use the sync() call instead of the default
8011 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008012 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013
8014 *'switchbuf'* *'swb'*
8015'switchbuf' 'swb' string (default "")
8016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008018 This option is checked, when
8019 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008020 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008021 - jumping to a tag using the |:stag| command.
8022 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8023 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8024 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008025 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008026 useopen If included, jump to the first open window in the
8027 current tab page that contains the specified buffer
8028 (if there is one). Otherwise: Do not examine other
8029 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008030 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008031 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008033 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008034 Otherwise: do not split, use current window (when used
8035 in the quickfix window: the previously used window or
8036 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008037 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008038 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008039 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008040 uselast If included, jump to the previously used window when
8041 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008042 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8043 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008045 *'synmaxcol'* *'smc'*
8046'synmaxcol' 'smc' number (default 3000)
8047 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008048 {not available when compiled without the |+syntax|
8049 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008050 Maximum column in which to search for syntax items. In long lines the
8051 text after this column is not highlighted and following lines may not
8052 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008053 This helps to avoid very slow redrawing for an XML file that is one
8054 long line.
8055 Set to zero to remove the limit.
8056
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057 *'syntax'* *'syn'*
8058'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008059 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 {not available when compiled without the |+syntax|
8061 feature}
8062 When this option is set, the syntax with this name is loaded, unless
8063 syntax highlighting has been switched off with ":syntax off".
8064 Otherwise this option does not always reflect the current syntax (the
8065 b:current_syntax variable does).
8066 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008067 not automatically recognized. Example, in an IDL file:
8068 /* vim: set syntax=idl : */ ~
8069 When a dot appears in the value then this separates two filetype
8070 names. Example:
8071 /* vim: set syntax=c.doxygen : */ ~
8072 This will use the "c" syntax first, then the "doxygen" syntax.
8073 Note that the second one must be prepared to be loaded as an addition,
8074 otherwise it will be skipped. More than one dot may appear.
8075 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008076 :set syntax=OFF
8077< To switch syntax highlighting on according to the current value of the
8078 'filetype' option: >
8079 :set syntax=ON
8080< What actually happens when setting the 'syntax' option is that the
8081 Syntax autocommand event is triggered with the value as argument.
8082 This option is not copied to another buffer, independent of the 's' or
8083 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008084 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008086 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008087'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008088 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008089 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008090 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008091 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008092
8093 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008094 option and only when there is no GUI tab line. When 'e' is in
8095 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008096 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008097
8098 The value is evaluated like with 'statusline'. You can use
8099 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008100 the text to be displayed. Use "%1T" for the first label, "%2T" for
8101 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008102
Bram Moolenaare12bab32019-01-08 22:02:56 +01008103 When changing something that is used in 'tabline' that does not
8104 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008105 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008106
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008107 Keep in mind that only one of the tab pages is the current one, others
8108 are invisible and you can't jump to their windows.
8109
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008110 *'tabpagemax'* *'tpm'*
8111'tabpagemax' 'tpm' number (default 10)
8112 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008113 Maximum number of tab pages to be opened by the |-p| command line
8114 argument or the ":tab all" command. |tabpage|
8115
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008116 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117'tabstop' 'ts' number (default 8)
8118 local to buffer
8119 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008120 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121
8122 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008123 appear wrong in many places, e.g., when printing it.
8124 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008126 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8128 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008129 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008130 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008131 This is the recommended way, the file will look the same with other
8132 tools and when listing it in a terminal.
8133 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8134 'expandtab'. This way you will always insert spaces. The
8135 formatting will never be messed up when 'tabstop' is changed (leave
8136 it at 8 just in case). The file will be a bit larger.
8137 You do need to check if no Tabs exist in the file. You can get rid
8138 of them by first setting 'expandtab' and using `%retab!`, making
8139 sure the value of 'tabstop' is set correctly.
8140 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 'expandtab'. This way you will always insert spaces. The
8142 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008143 You do need to check if no Tabs exist in the file, just like in the
8144 item just above.
8145 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008146 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008147 works when using Vim to edit the file, other tools assume a tabstop
8148 is worth 8 spaces.
8149 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 'noexpandtab'. This should then work (for initial indents only)
8151 for any tabstop setting that people use. It might be nice to have
8152 tabs after the first non-blank inserted as spaces if you do this
8153 though. Otherwise aligned comments will be wrong when 'tabstop' is
8154 changed.
8155
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008156 If Vim is compiled with the |+vartabs| feature then the value of
8157 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8158 than an empty string.
8159
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8161'tagbsearch' 'tbs' boolean (default on)
8162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008164 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 searching makes searching for a tag a LOT faster, but a linear search
8166 will find more tags if the tags file wasn't properly sorted.
8167 Vim normally assumes that your tags files are sorted, or indicate that
8168 they are not sorted. Only when this is not the case does the
8169 'tagbsearch' option need to be switched off.
8170
8171 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008172 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173 certain files, or retry all files with a linear search. When
8174 'tagbsearch' is off, only a linear search is done.
8175
8176 Linear searching is done anyway, for one file, when Vim finds a line
8177 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008178 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179< [The whitespace before and after the '0' must be a single <Tab>]
8180
8181 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008182 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 instead of a normal tag name, a retry is done with a linear search.
8184 Tags in unsorted tags files, and matches with different case will only
8185 be found in the retry.
8186
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008187 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008188 linear search can be avoided when case is ignored. Use a value of '2'
8189 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8190 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008191 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8192 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8193 used for this as well. Note that case must be folded to uppercase for
8194 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008195
8196 By default, tag searches are case-sensitive. Case is ignored when
8197 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8198 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008199 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8200 'tagcase' is "smart", and the pattern contains only lowercase
8201 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202
8203 When 'tagbsearch' is off, tags searching is slower when a full match
8204 exists, but faster when no full match exists. Tags in unsorted tags
8205 files may only be found with 'tagbsearch' off.
8206 When the tags file is not sorted, or sorted in a wrong way (not on
8207 ASCII byte value), 'tagbsearch' should be off, or the line given above
8208 must be included in the tags file.
8209 This option doesn't affect commands that find all matching tags (e.g.,
8210 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008212 *'tagcase'* *'tc'*
8213'tagcase' 'tc' string (default "followic")
8214 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008215 This option specifies how case is handled when searching the tags
8216 file:
8217 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008218 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008219 ignore Ignore case
8220 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008221 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008222 NOTE: This option is set to the Vi default value when 'compatible' is
8223 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008224
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008225 *'tagfunc'* *'tfu'*
8226'tagfunc' 'tfu' string (default: empty)
8227 local to buffer
8228 {not available when compiled without the |+eval|
8229 feature}
8230 This option specifies a function to be used to perform tag searches.
8231 The function gets the tag pattern and should return a List of matching
8232 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008233 function and an example. The value can be the name of a function, a
8234 |lambda| or a |Funcref|. See |option-value-function| for more
8235 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008236 This option cannot be set from a |modeline| or in the |sandbox|, for
8237 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008238
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 *'taglength'* *'tl'*
8240'taglength' 'tl' number (default 0)
8241 global
8242 If non-zero, tags are significant up to this number of characters.
8243
8244 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8245'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8246 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008247 If on and using a tags file in another directory, file names in that
8248 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 NOTE: This option is set to the Vi default value when 'compatible' is
8250 set and to the Vim default value when 'compatible' is reset.
8251
8252 *'tags'* *'tag'* *E433*
8253'tags' 'tag' string (default "./tags,tags", when compiled with
8254 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8255 global or local to buffer |global-local|
8256 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008257 include a space or comma in a file name, precede it with backslashes
8258 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 When a file name starts with "./", the '.' is replaced with the path
8260 of the current file. But only when the 'd' flag is not included in
8261 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8262 |tags-option|.
8263 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008264 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8265 find all files named "tags" below "/lib". The filename itself cannot
8266 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008267 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008268 The |tagfiles()| function can be used to get a list of the file names
8269 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8271 files are also supported. They are automatically recognized. The
8272 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8273 differences are ignored (MS-Windows). |emacs-tags|
8274 The use of |:set+=| and |:set-=| is preferred when adding or removing
8275 file names from the list. This avoids problems when a future version
8276 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277
8278 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8279'tagstack' 'tgst' boolean (default on)
8280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008281 When on, the |tagstack| is used normally. When off, a ":tag" or
8282 ":tselect" command with an argument will not push the tag onto the
8283 tagstack. A following ":tag" without an argument, a ":pop" command or
8284 any other command that uses the tagstack will use the unmodified
8285 tagstack, but does change the pointer to the active entry.
8286 Resetting this option is useful when using a ":tag" command in a
8287 mapping which should not change the tagstack.
8288
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008289 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008290'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008291 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008292 {only available when compiled with the |+tcl/dyn|
8293 feature}
8294 Specifies the name of the Tcl shared library. The default is
8295 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008296 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008297 This option cannot be set from a |modeline| or in the |sandbox|, for
8298 security reasons.
8299
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 *'term'* *E529* *E530* *E531*
8301'term' string (default is $TERM, if that fails:
8302 in the GUI: "builtin_gui"
8303 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008304 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 on Unix: "ansi"
8307 on VMS: "ansi"
8308 on Win 32: "win32")
8309 global
8310 Name of the terminal. Used for choosing the terminal control
8311 characters. Environment variables are expanded |:set_env|.
8312 For example: >
8313 :set term=$TERM
8314< See |termcap|.
8315
8316 *'termbidi'* *'tbidi'*
8317 *'notermbidi'* *'notbidi'*
8318'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8319 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008320 {only available when compiled with the |+arabic|
8321 feature}
8322 The terminal is in charge of Bi-directionality of text (as specified
8323 by Unicode). The terminal is also expected to do the required shaping
8324 that some languages (such as Arabic) require.
8325 Setting this option implies that 'rightleft' will not be set when
8326 'arabic' is set and the value of 'arabicshape' will be ignored.
8327 Note that setting 'termbidi' has the immediate effect that
8328 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8329 This option is reset when the GUI is started.
8330 For further details see |arabic.txt|.
8331
8332 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008333'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 Encoding used for the terminal. This specifies what character
8336 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008337 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008338 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008339 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008340 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8342 Any attempts to set a different value will be rejected, and an error
8343 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008344 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 because the Win32 system always passes Unicode characters.
8346 When empty, the same encoding is used as for the 'encoding' option.
8347 This is the normal value.
8348 Not all combinations for 'termencoding' and 'encoding' are valid. See
8349 |encoding-table|.
8350 The value for this option must be supported by internal conversions or
8351 iconv(). When this is not possible no conversion will be done and you
8352 will probably experience problems with non-ASCII characters.
8353 Example: You are working with the locale set to euc-jp (Japanese) and
8354 want to edit a UTF-8 file: >
8355 :let &termencoding = &encoding
8356 :set encoding=utf-8
8357< You need to do this when your system has no locale support for UTF-8.
8358
Bram Moolenaar938ae282023-02-20 20:44:55 +00008359 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008360'termguicolors' 'tgc' boolean (default off)
8361 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008362 {not available when compiled without the
8363 |+termguicolors| feature}
8364 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008365 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008366
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008367 Requires a ISO-8613-3 compatible terminal. If setting this option
8368 does not work (produces a colorless UI) reading |xterm-true-color|
8369 might help.
8370
8371 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8372 is required. Use this check to find out: >
8373 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008374< This requires Vim to be built with the |+vtp| feature.
8375
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008376 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008377
8378 When using Vim with Windows Terminal, the background of Windows
8379 Terminal is normally filled with the Vim background color. Setting
8380 'termguicolors' and the guibg of the Normal highlight group to NONE
8381 will make the background transparent: >
8382 :hi Normal guibg=NONE
8383<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008384 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008385
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008386 *'termwinkey'* *'twk'*
8387'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008388 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008389 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008390 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008391 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008392 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008393< The string must be one key stroke but can be multiple bytes.
8394 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008395 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008396 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008397
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008398 *'termwinscroll'* *'twsl'*
8399'termwinscroll' 'twsl' number (default 10000)
8400 local to buffer
8401 {not available when compiled without the
8402 |+terminal| feature}
8403 Number of scrollback lines to keep. When going over this limit the
8404 first 10% of the scrollback lines are deleted. This is just to reduce
8405 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008406 Also used as a limit for text sent to the terminal in one write,
8407 multiplied by the number of columns times 3 (average number of bytes
8408 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008409
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008410 *'termwinsize'* *'tws'*
8411'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008412 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008413 Size used when opening the |terminal| window. Format:
8414 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008415 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008416 - When set with a "x" (e.g., "24x80") the terminal size is not
8417 adjusted to the window size. If the window is smaller only the
8418 top-left part is displayed.
8419 - When set with a "*" (e.g., "10*50") the terminal size follows the
8420 window size, but will not be smaller than the specified rows and/or
8421 columns.
8422 - When rows is zero then use the height of the window.
8423 - When columns is zero then use the width of the window.
8424 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008425 - Can be overruled in the |term_start()| options with "term_rows" and
8426 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008427
8428 Examples:
8429 "30x0" uses 30 rows and the current window width.
8430 "20*0" uses at least 20 rows and the current window width.
8431 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008432 Note that the command running in the terminal window may still change
8433 the size of the terminal. In that case the Vim window will be
8434 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008435
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008436 *'termwintype'* *'twt'*
8437'termwintype' 'twt' string (default "")
8438 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008439 {only available when compiled with the |terminal|
8440 feature on MS-Windows}
8441 Specify the virtual console (pty) used when opening the terminal
8442 window.
8443
8444 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008445 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008446 "winpty" use winpty, fail if not supported
8447 "conpty" use |ConPTY|, fail if not supported
8448
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008449 |ConPTY| support depends on the platform. Windows 10 October 2018
8450 Update is the first version that supports ConPTY, however it is still
8451 considered unstable. ConPTY might become stable in the next release
8452 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008453 supported then you cannot open a terminal window.
8454
Bram Moolenaar071d4272004-06-13 20:20:40 +00008455 *'terse'* *'noterse'*
8456'terse' boolean (default off)
8457 global
8458 When set: Add 's' flag to 'shortmess' option (this makes the message
8459 for a search that hits the start or end of the file not being
8460 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8461 shortens a lot of messages}
8462
8463 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8464'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8465 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466 This option is obsolete. Use 'fileformats'.
8467 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8468 set to the default value for the current system. When 'textauto' is
8469 reset, 'fileformats' is made empty.
8470 NOTE: This option is set to the Vi default value when 'compatible' is
8471 set and to the Vim default value when 'compatible' is reset.
8472
8473 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008474'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475 others: default off)
8476 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 This option is obsolete. Use 'fileformat'.
8478 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8479 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8480 "unix".
8481
8482 *'textwidth'* *'tw'*
8483'textwidth' 'tw' number (default 0)
8484 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 Maximum width of text that is being inserted. A longer line will be
8486 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008487 this.
8488 'textwidth' is set to 0 when the 'paste' option is set and restored
8489 when 'paste' is reset.
8490 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008491 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008492 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008493 NOTE: This option is set to 0 when 'compatible' is set.
8494
8495 *'thesaurus'* *'tsr'*
8496'thesaurus' 'tsr' string (default "")
8497 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008498 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008499 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8500 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008501
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008502 This option is not used if 'thesaurusfunc' is set, either for the
8503 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008504
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008505 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008507 name. See |option-backslash| about using backslashes. The use of
8508 |:set+=| and |:set-=| is preferred when adding or removing directories
8509 from the list. This avoids problems when a future version uses
8510 another default. Backticks cannot be used in this option for security
8511 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008513 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008514'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008515 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008516 {not available when compiled without the |+eval|
8517 feature}
8518 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008519 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008520 The value can be the name of a function, a |lambda| or a |Funcref|.
8521 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008522
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008523 This option cannot be set from a |modeline| or in the |sandbox|, for
8524 security reasons.
8525
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8527'tildeop' 'top' boolean (default off)
8528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 When on: The tilde command "~" behaves like an operator.
8530 NOTE: This option is reset when 'compatible' is set.
8531
8532 *'timeout'* *'to'* *'notimeout'* *'noto'*
8533'timeout' 'to' boolean (default on)
8534 global
laburnumT3f7855a2023-12-05 18:37:03 +01008535
Bram Moolenaar071d4272004-06-13 20:20:40 +00008536 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008537'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539 These two options together determine the behavior when part of a
8540 mapped key sequence or keyboard code has been received:
8541
8542 'timeout' 'ttimeout' action ~
8543 off off do not time out
8544 on on or off time out on :mappings and key codes
8545 off on time out on key codes
8546
8547 If both options are off, Vim will wait until either the complete
8548 mapping or key sequence has been received, or it is clear that there
8549 is no mapping or key sequence for the received characters. For
8550 example: if you have mapped "vl" and Vim has received 'v', the next
8551 character is needed to see if the 'v' is followed by an 'l'.
8552 When one of the options is on, Vim will wait for about 1 second for
8553 the next character to arrive. After that the already received
8554 characters are interpreted as single characters. The waiting time can
8555 be changed with the 'timeoutlen' option.
8556 On slow terminals or very busy systems timing out may cause
8557 malfunctioning cursor keys. If both options are off, Vim waits
8558 forever after an entered <Esc> if there are key codes that start
8559 with <Esc>. You will have to type <Esc> twice. If you do not have
8560 problems with key codes, but would like to have :mapped key
8561 sequences not timing out in 1 second, set the 'ttimeout' option and
8562 reset the 'timeout' option.
8563
8564 NOTE: 'ttimeout' is reset when 'compatible' is set.
8565
8566 *'timeoutlen'* *'tm'*
8567'timeoutlen' 'tm' number (default 1000)
8568 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008569
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008571'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 The time in milliseconds that is waited for a key code or mapped key
8574 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8575 when part of a command has been typed.
8576 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8577 different timeout value for key codes is desired set 'ttimeoutlen' to
8578 a non-negative number.
8579
8580 ttimeoutlen mapping delay key code delay ~
8581 < 0 'timeoutlen' 'timeoutlen'
8582 >= 0 'timeoutlen' 'ttimeoutlen'
8583
8584 The timeout only happens when the 'timeout' and 'ttimeout' options
8585 tell so. A useful setting would be >
8586 :set timeout timeoutlen=3000 ttimeoutlen=100
8587< (time out on mapping after three seconds, time out on key codes after
8588 a tenth of a second).
8589
8590 *'title'* *'notitle'*
8591'title' boolean (default off, on when title can be restored)
8592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 When on, the title of the window will be set to the value of
8594 'titlestring' (if it is not empty), or to:
8595 filename [+=-] (path) - VIM
8596 Where:
8597 filename the name of the file being edited
8598 - indicates the file cannot be modified, 'ma' off
8599 + indicates the file was modified
8600 = indicates the file is read-only
8601 =+ indicates the file is read-only and modified
8602 (path) is the path of the file being edited
8603 - VIM the server name |v:servername| or "VIM"
8604 Only works if the terminal supports setting window titles
8605 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008606 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8608 *X11*
8609 When Vim was compiled with HAVE_X11 defined, the original title will
8610 be restored if possible. The output of ":version" will include "+X11"
8611 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8612 works for the icon name |'icon'|.
8613 But: When Vim was started with the |-X| argument, restoring the title
8614 will not work (except in the GUI).
8615 If the title cannot be restored, it is set to the value of 'titleold'.
8616 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008617 When using an xterm from a remote machine you can use this command: >
8618
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008620 ssh -X machine_name xterm &
8621<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 then the WINDOWID environment variable should be inherited and the
8623 title of the window should change back to what it should be after
8624 exiting Vim.
8625
8626 *'titlelen'*
8627'titlelen' number (default 85)
8628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008630 title. When the title is longer, only the end of the path name is
8631 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 Using a percentage makes this adapt to the width of the window. But
8633 it won't work perfectly, because the actual number of characters
8634 available also depends on the font used and other things in the title
8635 bar. When 'titlelen' is zero the full path is used. Otherwise,
8636 values from 1 to 30000 percent can be used.
8637 'titlelen' is also used for the 'titlestring' option.
8638
8639 *'titleold'*
8640'titleold' string (default "Thanks for flying Vim")
8641 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642 This option will be used for the window title when exiting Vim if the
8643 original title cannot be restored. Only happens if 'title' is on or
8644 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008645 This option cannot be set from a |modeline| or in the |sandbox|, for
8646 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 *'titlestring'*
8648'titlestring' string (default "")
8649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008650 When this option is not empty, it will be used for the title of the
8651 window. This happens only when the 'title' option is on.
8652 Only works if the terminal supports setting window titles (currently
8653 Amiga console, Win32 console, all GUI versions and terminals with a
8654 non-empty 't_ts' option).
8655 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008656 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008657
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 When this option contains printf-style '%' items, they will be
8659 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008660 This option cannot be set in a modeline when 'modelineexpr' is off.
8661
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008663 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8665< The value of 'titlelen' is used to align items in the middle or right
8666 of the available space.
8667 Some people prefer to have the file name first: >
8668 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8669< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008670 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 separating space only when needed.
8672 NOTE: Use of special characters in 'titlestring' may cause the display
8673 to be garbled (e.g., when it contains a CR or NL character).
8674 {not available when compiled without the |+statusline| feature}
8675
8676 *'toolbar'* *'tb'*
8677'toolbar' 'tb' string (default "icons,tooltips")
8678 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008679 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008680 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 possible values are:
8682 icons Toolbar buttons are shown with icons.
8683 text Toolbar buttons shown with text.
8684 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008685 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008686 tooltips Tooltips are active for toolbar buttons.
8687 Tooltips refer to the popup help text which appears after the mouse
8688 cursor is placed over a toolbar button for a brief moment.
8689
8690 If you want the toolbar to be shown with icons as well as text, do the
8691 following: >
8692 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008693< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 will show icons if both are requested.
8695
8696 If none of the strings specified in 'toolbar' are valid or if
8697 'toolbar' is empty, this option is ignored. If you want to disable
8698 the toolbar, you need to set the 'guioptions' option. For example: >
8699 :set guioptions-=T
8700< Also see |gui-toolbar|.
8701
8702 *'toolbariconsize'* *'tbis'*
8703'toolbariconsize' 'tbis' string (default "small")
8704 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008705 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008707 tiny Use tiny icons.
8708 small Use small icons (default).
8709 medium Use medium-sized icons.
8710 large Use large icons.
8711 huge Use even larger icons.
8712 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008714 the current theme. Common dimensions are giant=48x48, huge=32x32,
8715 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716
8717 If 'toolbariconsize' is empty, the global default size as determined
8718 by user preferences or the current theme is used.
8719
8720 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8721'ttybuiltin' 'tbi' boolean (default on)
8722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008723 When on, the builtin termcaps are searched before the external ones.
8724 When off the builtin termcaps are searched after the external ones.
8725 When this option is changed, you should set the 'term' option next for
8726 the change to take effect, for example: >
8727 :set notbi term=$TERM
8728< See also |termcap|.
8729 Rationale: The default for this option is "on", because the builtin
8730 termcap entries are generally better (many systems contain faulty
8731 xterm entries...).
8732
8733 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008734'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 Indicates a fast terminal connection. More characters will be sent to
8737 the screen for redrawing, instead of using insert/delete line
8738 commands. Improves smoothness of redrawing when there are multiple
8739 windows and the terminal does not support a scrolling region.
8740 Also enables the extra writing of characters at the end of each screen
8741 line for lines that wrap. This helps when using copy/paste with the
8742 mouse in an xterm and other terminals.
8743
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008744 The default used to be set only for some terminal names, but these
8745 days nearly all terminals are fast, therefore the default is now "on".
8746 If you have a slow connection you may want to set this option off,
8747 e.g. depending on the host name: >
8748 if hostname() =~ 'faraway'
8749 set nottyfast
8750 endif
8751<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008752 *'ttymouse'* *'ttym'*
8753'ttymouse' 'ttym' string (default depends on 'term')
8754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 {only in Unix and VMS, doesn't work in the GUI; not
8756 available when compiled without |+mouse|}
8757 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008758 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 *xterm-mouse*
8760 xterm xterm-like mouse handling. The mouse generates
8761 "<Esc>[Mscr", where "scr" is three bytes:
8762 "s" = button state
8763 "c" = column plus 33
8764 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008765 This only works up to 223 columns! See "dec",
8766 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767 xterm2 Works like "xterm", but with the xterm reporting the
8768 mouse position while the mouse is dragged. This works
8769 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008770 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 work. See below for how Vim detects this
8772 automatically.
8773 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008774 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008776 for the row and column. No other mouse events are
8777 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 *dec-mouse*
8779 dec DEC terminal mouse handling. The mouse generates a
8780 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008781 This is also available for an Xterm, if it was
8782 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 *jsbterm-mouse*
8784 jsbterm JSB term mouse handling.
8785 *pterm-mouse*
8786 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008787 *urxvt-mouse*
8788 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008789 The mouse works only if the terminal supports this
8790 encoding style, but it does not have 223 columns limit
8791 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008792 *sgr-mouse*
8793 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008794 mouse reporting. The mouse works even in columns
8795 beyond 223. This option is backward compatible with
8796 "xterm2" because it can also decode "xterm2" style
8797 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798
8799 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008800 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8801 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8803 recognized, if enabled at compile time. DEC terminal mouse codes
8804 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008805 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8806 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008808 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8809 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8810 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008811 If the terminfo/termcap entry "XM" exists and the first number is
8812 "1006" then 'ttymouse' will be set to "sgr". This works for many
8813 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008814 Additionally, if vim is compiled with the |+termresponse| feature and
8815 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008816 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008817 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008818 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8819 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8820 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008821 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8822 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 :set t_RV=
8824<
8825 *'ttyscroll'* *'tsl'*
8826'ttyscroll' 'tsl' number (default 999)
8827 global
8828 Maximum number of lines to scroll the screen. If there are more lines
8829 to scroll the window is redrawn. For terminals where scrolling is
8830 very slow and redrawing is not slow this can be set to a small number,
8831 e.g., 3, to speed up displaying.
8832
8833 *'ttytype'* *'tty'*
8834'ttytype' 'tty' string (default from $TERM)
8835 global
8836 Alias for 'term', see above.
8837
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008838 *'undodir'* *'udir'*
8839'undodir' 'udir' string (default ".")
8840 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008841 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008842 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008843 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008844 "." means using the directory of the file. The undo file name for
8845 "file.txt" is ".file.txt.un~".
8846 For other directories the file name is the full path of the edited
8847 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008848 When writing: The first directory that exists is used. "." always
8849 works, no directories after "." will be used for writing.
8850 When reading all entries are tried to find an undo file. The first
8851 undo file that exists is used. When it cannot be read an error is
8852 given, no further entry is used.
8853 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008854 This option cannot be set from a |modeline| or in the |sandbox|, for
8855 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008856
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008857 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008858'undofile' 'udf' boolean (default off)
8859 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008860 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008861 When on, Vim automatically saves undo history to an undo file when
8862 writing a buffer to a file, and restores undo history from the same
8863 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008864 The directory where the undo file is stored is specified by 'undodir'.
8865 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008866 The undo file is not read when 'undoreload' causes the buffer from
8867 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008868 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008869 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008870
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008872'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008873 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008875 is kept in memory, higher numbers will cause more memory to be used.
8876 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8878 itself: >
8879 set ul=0
8880< But you can also get Vi compatibility by including the 'u' flag in
8881 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008882 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008883 Set to -1 for no undo at all. You might want to do this only for the
8884 current buffer: >
8885 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008887
8888 The local value is set to -123456 when the global value is to be used.
8889
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008890 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008892 *'undoreload'* *'ur'*
8893'undoreload' 'ur' number (default 10000)
8894 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008895 Save the whole buffer for undo when reloading it. This applies to the
8896 ":e!" command and reloading for when the buffer changed outside of
8897 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008898 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008899 of lines is smaller than the value of this option.
8900 Set this option to zero to disable undo for a reload.
8901
8902 When saving undo for a reload, any undo file is not read.
8903
8904 Note that this causes the whole buffer to be stored in memory. Set
8905 this option to a lower value if you run out of memory.
8906
Bram Moolenaar071d4272004-06-13 20:20:40 +00008907 *'updatecount'* *'uc'*
8908'updatecount' 'uc' number (default: 200)
8909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 After typing this many characters the swap file will be written to
8911 disk. When zero, no swap file will be created at all (see chapter on
8912 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8913 Vim with the "-n" option, see |startup|. When editing in readonly
8914 mode this option will be initialized to 10000.
8915 The swapfile can be disabled per buffer with |'swapfile'|.
8916 When 'updatecount' is set from zero to non-zero, swap files are
8917 created for all buffers that have 'swapfile' set. When 'updatecount'
8918 is set to zero, existing swap files are not deleted.
8919 Also see |'swapsync'|.
8920 This option has no meaning in buffers where |'buftype'| is "nofile"
8921 or "nowrite".
8922
8923 *'updatetime'* *'ut'*
8924'updatetime' 'ut' number (default 4000)
8925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 If this many milliseconds nothing is typed the swap file will be
8927 written to disk (see |crash-recovery|). Also used for the
8928 |CursorHold| autocommand event.
8929
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008930 *'varsofttabstop'* *'vsts'*
8931'varsofttabstop' 'vsts' string (default "")
8932 local to buffer
8933 {only available when compiled with the |+vartabs|
8934 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008935 A list of the number of spaces that a <Tab> counts for while editing,
8936 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8937 width <Tab>s are being inserted, while in fact a mixture of spaces
8938 and <Tab>s is used. Tab widths are separated with commas, with the
8939 final value applying to all subsequent tabs.
8940
8941 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008942 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008943 to use the following: >
8944 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008945< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8946 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008947
8948 Note that the value of |'softtabstop'| will be ignored while
8949 'varsofttabstop' is set.
8950
8951 *'vartabstop'* *'vts'*
8952'vartabstop' 'vts' string (default "")
8953 local to buffer
8954 {only available when compiled with the |+vartabs|
8955 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008956 A list of the number of spaces that a <Tab> in the file counts for,
8957 separated by commas. Each value corresponds to one tab, with the
8958 final value applying to all subsequent tabs. For example: >
8959 :set vartabstop=4,20,10,8
8960< This will make the first tab 4 spaces wide, the second 20 spaces,
8961 the third 10 spaces, and all following tabs 8 spaces.
8962
8963 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8964 is set.
8965
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966 *'verbose'* *'vbs'*
8967'verbose' 'vbs' number (default 0)
8968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 When bigger than zero, Vim will give messages about what it is doing.
8970 Currently, these messages are given:
8971 >= 1 When the viminfo file is read or written.
8972 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008973 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008974 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 >= 8 Files for which a group of autocommands is executed.
8976 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008977 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008978 >= 12 Every executed function.
8979 >= 13 When an exception is thrown, caught, finished, or discarded.
8980 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008981 >= 15 Every executed Ex command from a script (truncated at 200
8982 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008983 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984
8985 This option can also be set with the "-V" argument. See |-V|.
8986 This option is also set by the |:verbose| command.
8987
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008988 When the 'verbosefile' option is set then the verbose messages are not
8989 displayed.
8990
8991 *'verbosefile'* *'vfile'*
8992'verbosefile' 'vfile' string (default empty)
8993 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008994 When not empty all messages are written in a file with this name.
8995 When the file exists messages are appended.
8996 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008997 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008998 Setting 'verbosefile' to a new value is like making it empty first.
8999 The difference with |:redir| is that verbose messages are not
9000 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009001 This option cannot be set from a |modeline| or in the |sandbox|, for
9002 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009003
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009005'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009006 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009007 for Unix: "$HOME/.vim/view" or
9008 "$XDG_CONFIG_HOME/vim/view"
h_east59858792023-10-25 22:47:05 +09009009 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009010 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009012 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 feature}
9014 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009015 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 This option cannot be set from a |modeline| or in the |sandbox|, for
9017 security reasons.
9018
9019 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009020'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009022 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009024 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009025 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 word save and restore ~
9027 cursor cursor position in file and in window
9028 folds manually created folds, opened/closed folds and local
9029 fold options
9030 options options and mappings local to a window or buffer (not
9031 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009032 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009033 slash backslashes in file names replaced with forward
9034 slashes
9035 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009036 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009037 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009038
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009039 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009040 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009041 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009042
9043 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009044'viminfo' 'vi' string (Vi default: "", Vim default for
9045 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009046 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9047 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009049 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050 feature}
9051 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009052 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9053 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009054 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009055 consisting of a single character identifying the particular parameter,
9056 followed by a number or string which specifies the value of that
9057 parameter. If a particular character is left out, then the default
9058 value is used for that parameter. The following is a list of the
9059 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009061 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009062 ! When included, save and restore global variables that start
9063 with an uppercase letter, and don't contain a lowercase
9064 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009065 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009066 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009067 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 " Maximum number of lines saved for each register. Old name of
9069 the '<' item, with the disadvantage that you need to put a
9070 backslash before the ", otherwise it will be recognized as the
9071 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009072 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009073 % When included, save and restore the buffer list. If Vim is
9074 started with a file name argument, the buffer list is not
9075 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009076 buffer list is restored from the viminfo file. Quickfix
9077 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9078 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009079 When followed by a number, the number specifies the maximum
9080 number of buffers that are stored. Without a number all
9081 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009082 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 ' Maximum number of previously edited files for which the marks
9084 are remembered. This parameter must always be included when
9085 'viminfo' is non-empty.
9086 Including this item also means that the |jumplist| and the
9087 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009088 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009090 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009091 patterns are also saved. When not included, the value of
9092 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009093 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009095 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009096 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 < Maximum number of lines saved for each register. If zero then
9098 registers are not saved. When not included, all lines are
9099 saved. '"' is the old name for this item.
9100 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009101 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009102 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009103 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009104 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 c When included, convert the text in the viminfo file from the
9106 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009107 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009108 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009109 f Whether file marks need to be stored. If zero, file marks ('0
9110 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009111 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009113 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114 h Disable the effect of 'hlsearch' when loading the viminfo
9115 file. When not included, it depends on whether ":nohlsearch"
9116 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009117 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009119 the 'n'. Must be at the end of the option! If the
9120 'viminfofile' option is set, that file name overrides the one
9121 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009122 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009123 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 r Removable media. The argument is a string (up to the next
9125 ','). This parameter can be given several times. Each
9126 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009127 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009128 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9129 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9130 ignored. Maximum length of each 'r' argument is 50
9131 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009132 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009133 s Maximum size of an item in Kbyte. If zero then registers are
9134 not saved. Currently only applies to registers. The default
9135 "s10" will exclude registers with more than 10 Kbyte of text.
9136 Also see the '<' item above: line count limit.
9137
9138 Example: >
9139 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9140<
9141 '50 Marks will be remembered for the last 50 files you
9142 edited.
9143 <1000 Contents of registers (up to 1000 lines each) will be
9144 remembered.
9145 s100 Registers with more than 100 Kbyte text are skipped.
9146 :0 Command-line history will not be saved.
9147 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9148 no / Since '/' is not specified, the default will be used,
9149 that is, save all of the search history, and also the
9150 previous search and substitute patterns.
9151 no % The buffer list will not be saved nor read back.
9152 no h 'hlsearch' highlighting will be restored.
9153
9154 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9155 load the contents of the file, this is not done automatically.
9156
9157 This option cannot be set from a |modeline| or in the |sandbox|, for
9158 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009159 NOTE: This option is set to the Vim default value when 'compatible'
9160 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009162 *'viminfofile'* *'vif'*
9163'viminfofile' 'vif' string (default: "")
9164 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009165 {not available when compiled without the |+viminfo|
9166 feature}
9167 When non-empty, overrides the file name used for viminfo.
9168 When equal to "NONE" no viminfo file will be read or written.
9169 This option can be set with the |-i| command line flag. The |--clean|
9170 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009171 This option cannot be set from a |modeline| or in the |sandbox|, for
9172 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009173
Bram Moolenaar071d4272004-06-13 20:20:40 +00009174 *'virtualedit'* *'ve'*
9175'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009176 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009177 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009178 block Allow virtual editing in Visual block mode.
9179 insert Allow virtual editing in Insert mode.
9180 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009181 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009182 none When used as the local value, do not allow virtual
9183 editing even when the global value is set. When used
9184 as the global value, "none" is the same as "".
9185 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009186
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009188 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009189 of the line. Useful for selecting a rectangle in Visual mode and
9190 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009191 "onemore" is not the same, it will only allow moving the cursor just
9192 after the last character of the line. This makes some commands more
9193 consistent. Previously the cursor was always past the end of the line
9194 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009195 break some plugins or Vim scripts. For example because |l| can move
9196 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009197 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009198 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009199 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009200 It doesn't make sense to combine "all" with "onemore", but you will
9201 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009202 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009203 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009204
9205 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9206'visualbell' 'vb' boolean (default off)
9207 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009208 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009209 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009210 use: >
9211 :set vb t_vb=
9212< If you want a short flash, you can use this on many terminals: >
9213 :set vb t_vb=[?5h$<100>[?5l
9214< Here $<100> specifies the time, you can use a smaller or bigger value
9215 to get a shorter or longer flash.
9216
9217 Note: Vim will limit the bell to once per half a second. This avoids
9218 having to wait for the flashing to finish when there are lots of
9219 bells, e.g. on key repeat. This also happens without 'visualbell'
9220 set.
9221
Bram Moolenaar071d4272004-06-13 20:20:40 +00009222 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9223 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9224 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009225
9226 Note: When the GUI starts, 't_vb' is reset to its default value. You
9227 might want to set it again in your |gvimrc|.
9228
Bram Moolenaar071d4272004-06-13 20:20:40 +00009229 Does not work on the Amiga, you always get a screen flash.
9230 Also see 'errorbells'.
9231
9232 *'warn'* *'nowarn'*
9233'warn' boolean (default on)
9234 global
9235 Give a warning message when a shell command is used while the buffer
9236 has been changed.
9237
9238 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9239'weirdinvert' 'wiv' boolean (default off)
9240 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009241 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009242 It is provided for backwards compatibility with version 4.x.
9243 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9244 vice versa. Has no effect when the GUI is running.
9245
9246 *'whichwrap'* *'ww'*
9247'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249 Allow specified keys that move the cursor left/right to move to the
9250 previous/next line when the cursor is on the first/last character in
9251 the line. Concatenate characters to allow this for these keys:
9252 char key mode ~
9253 b <BS> Normal and Visual
9254 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009255 h "h" Normal and Visual (not recommended)
9256 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009257 < <Left> Normal and Visual
9258 > <Right> Normal and Visual
9259 ~ "~" Normal
9260 [ <Left> Insert and Replace
9261 ] <Right> Insert and Replace
9262 For example: >
9263 :set ww=<,>,[,]
9264< allows wrap only when cursor keys are used.
9265 When the movement keys are used in combination with a delete or change
9266 operator, the <EOL> also counts for a character. This makes "3h"
9267 different from "3dh" when the cursor crosses the end of a line. This
9268 is also true for "x" and "X", because they do the same as "dl" and
9269 "dh". If you use this, you may also want to use the mapping
9270 ":map <BS> X" to make backspace delete the character in front of the
9271 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009272 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009273 line (not an empty line) then it will not move to the next line. This
9274 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009275 NOTE: This option is set to the Vi default value when 'compatible' is
9276 set and to the Vim default value when 'compatible' is reset.
9277
9278 *'wildchar'* *'wc'*
9279'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 Character you have to type to start wildcard expansion in the
9282 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009283 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009284 The character is not recognized when used inside a macro. See
9285 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009286 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009287 <Esc> can be used, but hitting it twice in a row will still exit
9288 command-line as a failsafe measure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009290 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009291< NOTE: This option is set to the Vi default value when 'compatible' is
9292 set and to the Vim default value when 'compatible' is reset.
9293
9294 *'wildcharm'* *'wcm'*
9295'wildcharm' 'wcm' number (default: none (0))
9296 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009297 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009298 recognized when used inside a macro. You can find "spare" command-line
9299 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009300 you'll never actually type 'wildcharm', just use it in mappings that
9301 automatically invoke completion mode, e.g.: >
9302 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009303 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009304< Then after typing :ss you can use CTRL-P & CTRL-N.
9305
9306 *'wildignore'* *'wig'*
9307'wildignore' 'wig' string (default "")
9308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009309 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009310 patterns is ignored when expanding |wildcards|, completing file or
9311 directory names, and influences the result of |expand()|, |glob()| and
9312 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9314 Also see 'suffixes'.
9315 Example: >
9316 :set wildignore=*.o,*.obj
9317< The use of |:set+=| and |:set-=| is preferred when adding or removing
9318 a pattern from the list. This avoids problems when a future version
9319 uses another default.
9320
h_east596a9f22023-11-21 21:24:23 +09009321 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009322'wildignorecase' 'wic' boolean (default off)
9323 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009324 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009325 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009326 Does not apply when the shell is used to expand wildcards, which
9327 happens when there are special characters.
9328
Bram Moolenaar071d4272004-06-13 20:20:40 +00009329 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009330'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009332 When 'wildmenu' is on, command-line completion operates in an enhanced
9333 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009334 the possible matches are shown.
9335 When 'wildoptions' contains "pum", then the completion matches are
9336 shown in a popup menu. Otherwise they are displayed just above the
9337 command line, with the first match highlighted (overwriting the status
9338 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009339 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009340 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9341 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9342 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009343 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009344 If there are more matches than can fit in the line, a ">" is shown on
9345 the right and/or a "<" is shown on the left. The status line scrolls
9346 as needed.
9347 The "wildmenu" mode is abandoned when a key is hit that is not used
9348 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009349 While the "wildmenu" is active, the following keys have special
9350 meanings:
9351 CTRL-P - go to the previous entry
9352 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009353 <CR> - in menu completion, when the cursor is just after a
9354 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009355 CTRL-E - end completion, go back to what was there before
9356 selecting a match.
9357 CTRL-Y - accept the currently selected match and stop
9358 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009359
9360 When not using the popup menu for command line completion, the
9361 following keys have special meanings:
9362 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009363 <Up> - in filename/menu name completion: move up into
9364 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009365 <Down> - in filename/menu name completion: move into a
9366 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009367
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009368 When using the popup menu for command line completion, the following
9369 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009370 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009371 <PageUp> - select a match several entries back
9372 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009373 <Left> - in filename/menu name completion: move up into
9374 parent directory or parent menu.
9375 <Right> - in filename/menu name completion: move into a
9376 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009377
Bram Moolenaar071d4272004-06-13 20:20:40 +00009378 This makes the menus accessible from the console |console-menus|.
9379
9380 If you prefer the <Left> and <Right> keys to move the cursor instead
9381 of selecting a different match, use this: >
9382 :cnoremap <Left> <Space><BS><Left>
9383 :cnoremap <Right> <Space><BS><Right>
9384<
9385 The "WildMenu" highlighting is used for displaying the current match
9386 |hl-WildMenu|.
9387
9388 *'wildmode'* *'wim'*
9389'wildmode' 'wim' string (Vim default: "full")
9390 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009391 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009392 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009393 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009394 first part specifies the behavior for the first use of 'wildchar',
9395 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009396
9397 Each part consists of a colon separated list consisting of the
9398 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009399 "" Complete only the first match.
9400 "full" Complete the next full match. After the last match,
9401 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009402 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009403 "longest" Complete till longest common string. If this doesn't
9404 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009405 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009406 "lastused" When completing buffer names and more than one buffer
9407 matches, sort buffers by time last used (other than
9408 the current buffer).
9409 When there is only a single match, it is fully completed in all cases.
9410
9411 Examples of useful colon-separated values:
9412 "longest:full" Like "longest", but also start 'wildmenu' if it is
9413 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009414 "list:full" When more than one match, list all matches and
9415 complete first match.
9416 "list:longest" When more than one match, list all matches and
9417 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009418 "list:lastused" When more than one buffer matches, list all matches
9419 and sort buffers by time last used (other than the
9420 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009421
9422 Examples: >
9423 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009424< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009425 :set wildmode=longest,full
9426< Complete longest common string, then each full match >
9427 :set wildmode=list:full
9428< List all matches and complete each full match >
9429 :set wildmode=list,full
9430< List all matches without completing, then each full match >
9431 :set wildmode=longest,list
9432< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009433 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009434
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009435 *'wildoptions'* *'wop'*
9436'wildoptions' 'wop' string (default "")
9437 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009438 A list of words that change how |cmdline-completion| is done.
9439 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009440 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009441 this value is specified, wildcard expansion will not
9442 be used for completion. The matches will be sorted by
9443 the "best match" rather than alphabetically sorted.
9444 This will find more matches than the wildcard
9445 expansion. Currently fuzzy matching based completion
9446 is not supported for file and directory names and
9447 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009448 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009449 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009450 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009451 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009452 is displayed per line. Often used tag kinds are:
9453 d #define
9454 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009455
Bram Moolenaar071d4272004-06-13 20:20:40 +00009456 *'winaltkeys'* *'wak'*
9457'winaltkeys' 'wak' string (default "menu")
9458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009459 {only used in Win32, Motif, GTK and Photon GUI}
9460 Some GUI versions allow the access to menu entries by using the ALT
9461 key in combination with a character that appears underlined in the
9462 menu. This conflicts with the use of the ALT key for mappings and
9463 entering special characters. This option tells what to do:
9464 no Don't use ALT keys for menus. ALT key combinations can be
9465 mapped, but there is no automatic handling. This can then be
9466 done with the |:simalt| command.
9467 yes ALT key handling is done by the windowing system. ALT key
9468 combinations cannot be mapped.
9469 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009470 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009471 keys can be mapped.
9472 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9473 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009474 This option is not used for <F10>; on Win32 and with GTK <F10> will
9475 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009476
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009477 *'wincolor'* *'wcr'*
9478'wincolor' 'wcr' string (default empty)
9479 local to window
9480 Highlight group name to use for this window instead of the Normal
9481 color |hl-Normal|.
9482
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009483 *'window'* *'wi'*
9484'window' 'wi' number (default screen height - 1)
9485 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009486 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9487 window and the value is smaller than 'lines' minus one. The screen
9488 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009489 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9490 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009491 When resizing the Vim window, and the value is smaller than 1 or more
9492 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009493 Note: Do not confuse this with the height of the Vim window, use
9494 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009495
Colin Kennedy21570352024-03-03 16:16:47 +01009496 *'winfixbuf'*
9497'winfixbuf' 'wfb' boolean (default off)
9498 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009499 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009500 For example, attempting to change the buffer with |:edit| will fail.
9501 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009502 also skip any window with 'winfixbuf' enabled. However if an Ex
9503 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009504
laburnumT3f7855a2023-12-05 18:37:03 +01009505 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9506'winfixheight' 'wfh' boolean (default off)
9507 local to window |local-noglobal|
9508 Keep the window height when windows are opened or closed and
9509 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9510 |preview-window| and |quickfix-window|.
9511 The height may be changed anyway when running out of room.
9512
9513 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9514'winfixwidth' 'wfw' boolean (default off)
9515 local to window |local-noglobal|
9516 Keep the window width when windows are opened or closed and
9517 'equalalways' is set. Also for |CTRL-W_=|.
9518 The width may be changed anyway when running out of room.
9519
Bram Moolenaar071d4272004-06-13 20:20:40 +00009520 *'winheight'* *'wh'* *E591*
9521'winheight' 'wh' number (default 1)
9522 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009523 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009524 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009525 focus goes to a window that is smaller, its size is increased, at the
9526 cost of the height of other windows.
9527 Set 'winheight' to a small number for normal editing.
9528 Set it to 999 to make the current window fill most of the screen.
9529 Other windows will be only 'winminheight' high. This has the drawback
9530 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9531 to create only two windows, set the option after startup is done,
9532 using the |VimEnter| event: >
9533 au VimEnter * set winheight=999
9534< Minimum value is 1.
9535 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009536 height of the current window.
9537 'winheight' applies to the current window. Use 'winminheight' to set
9538 the minimal height for other windows.
9539
Bram Moolenaar071d4272004-06-13 20:20:40 +00009540 *'winminheight'* *'wmh'*
9541'winminheight' 'wmh' number (default 1)
9542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009543 The minimal height of a window, when it's not the current window.
9544 This is a hard minimum, windows will never become smaller.
9545 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9546 status bar) if necessary. They will return to at least one line when
9547 they become active (since the cursor has to have somewhere to go.)
9548 Use 'winheight' to set the minimal height of the current window.
9549 This option is only checked when making a window smaller. Don't use a
9550 large number, it will cause errors when opening more than a few
9551 windows. A value of 0 to 3 is reasonable.
9552
9553 *'winminwidth'* *'wmw'*
9554'winminwidth' 'wmw' number (default 1)
9555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009556 The minimal width of a window, when it's not the current window.
9557 This is a hard minimum, windows will never become smaller.
9558 When set to zero, windows may be "squashed" to zero columns (i.e. just
9559 a vertical separator) if necessary. They will return to at least one
9560 line when they become active (since the cursor has to have somewhere
9561 to go.)
9562 Use 'winwidth' to set the minimal width of the current window.
9563 This option is only checked when making a window smaller. Don't use a
9564 large number, it will cause errors when opening more than a few
9565 windows. A value of 0 to 12 is reasonable.
9566
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009567 *'winptydll'*
9568'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9569 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009570 {only available when compiled with the |terminal|
9571 feature on MS-Windows}
9572 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009573 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009574 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009575 a fallback.
9576 Environment variables are expanded |:set_env|.
9577 This option cannot be set from a |modeline| or in the |sandbox|, for
9578 security reasons.
9579
Bram Moolenaar071d4272004-06-13 20:20:40 +00009580 *'winwidth'* *'wiw'* *E592*
9581'winwidth' 'wiw' number (default 20)
9582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009583 Minimal number of columns for the current window. This is not a hard
9584 minimum, Vim will use fewer columns if there is not enough room. If
9585 the current window is smaller, its size is increased, at the cost of
9586 the width of other windows. Set it to 999 to make the current window
9587 always fill the screen. Set it to a small number for normal editing.
9588 The width is not adjusted after one of the commands to change the
9589 width of the current window.
9590 'winwidth' applies to the current window. Use 'winminwidth' to set
9591 the minimal width for other windows.
9592
9593 *'wrap'* *'nowrap'*
9594'wrap' boolean (default on)
9595 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009596 This option changes how text is displayed. It doesn't change the text
9597 in the buffer, see 'textwidth' for that.
9598 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009599 displaying continues on the next line. When off lines will not wrap
9600 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009601 moved to a part that is not shown, the screen will scroll
9602 horizontally.
9603 The line will be broken in the middle of a word if necessary. See
9604 'linebreak' to get the break at a word boundary.
9605 To make scrolling horizontally a bit more useful, try this: >
9606 :set sidescroll=5
9607 :set listchars+=precedes:<,extends:>
9608< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009609 This option can't be set from a |modeline| when the 'diff' option is
9610 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009611
9612 *'wrapmargin'* *'wm'*
9613'wrapmargin' 'wm' number (default 0)
9614 local to buffer
9615 Number of characters from the right window border where wrapping
9616 starts. When typing text beyond this limit, an <EOL> will be inserted
9617 and inserting continues on the next line.
9618 Options that add a margin, such as 'number' and 'foldcolumn', cause
9619 the text width to be further reduced. This is Vi compatible.
9620 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009621 This option is set to 0 when 'paste' is set and restored when 'paste'
9622 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009623 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009624
9625 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9626'wrapscan' 'ws' boolean (default on) *E384* *E385*
9627 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009628 Searches wrap around the end of the file. Also applies to |]s| and
9629 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009630
9631 *'write'* *'nowrite'*
9632'write' boolean (default on)
9633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009634 Allows writing files. When not set, writing a file is not allowed.
9635 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009636 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009637 argument. Filtering text is still possible, even though this requires
9638 writing a temporary file.
9639
9640 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9641'writeany' 'wa' boolean (default off)
9642 global
9643 Allows writing to any file with no need for "!" override.
9644
9645 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9646'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9647 otherwise)
9648 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009649 Make a backup before overwriting a file. The backup is removed after
9650 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009651 also on.
9652 WARNING: Switching this option off means that when Vim fails to write
9653 your buffer correctly and then, for whatever reason, Vim exits, you
9654 lose both the original file and what you were writing. Only reset
9655 this option if your file system is almost full and it makes the write
9656 fail (and make sure not to exit Vim until the write was successful).
9657 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009658 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009659 Depending on 'backupcopy' the backup is a new file or the original
9660 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009661 NOTE: This option is set to the default value when 'compatible' is
9662 set.
9663
9664 *'writedelay'* *'wd'*
9665'writedelay' 'wd' number (default 0)
9666 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009667 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009668 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009669 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009670
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009671 *'xtermcodes'* *'noxtermcodes'*
9672'xtermcodes' boolean (default on)
9673 global
9674 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009675 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009676 key codes and number of colors from the terminal. This takes care of
9677 various configuration options of the terminal that cannot be obtained
9678 from the termlib/terminfo entry, see |xterm-codes|.
9679 A side effect may be that t_Co changes and Vim will redraw the
9680 display.
9681
9682
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009683 vim:tw=78:ts=8:noet:ft=help:norl: