blob: e28244f1113cf3c32e9d1263e09e5d2ae6e82edb [file] [log] [blame]
glepnira218cc62024-06-03 19:32:39 +02001*options.txt* For Vim version 9.1. Last change: 2024 Jun 03
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
Bram Moolenaarf1dcd142022-12-31 15:30:45 +000037 The options have the form t_AB, see
38 |terminal-options|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
Bram Moolenaar47003982021-12-05 21:54:04 +000040:se[t]! termcap Idem, but don't use multiple columns.
41
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 *E518* *E519*
43:se[t] {option}? Show value of {option}.
44
45:se[t] {option} Toggle option: set, switch it on.
46 Number option: show value.
47 String option: show value.
48
49:se[t] no{option} Toggle option: Reset, switch it off.
50
Bram Moolenaar00a927d2010-05-14 23:24:24 +020051 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000052:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000054
55 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
56:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020057 current value of 'compatible'.
58:se[t] {option}&vi Reset option to its Vi default value.
59:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010061:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020062 these options are not changed:
63 all terminal options, starting with t_
64 'columns'
65 'cryptmethod'
66 'encoding'
67 'key'
68 'lines'
69 'term'
70 'ttymouse'
71 'ttytype'
72 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
h_east59858792023-10-25 22:47:05 +090074 *:set-args* *:set=* *E487* *E521*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075:se[t] {option}={value} or
76:se[t] {option}:{value}
77 Set string or number option to {value}.
78 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010079 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000080 The old value can be inserted by typing 'wildchar' (by
81 default this is a <Tab> or CTRL-E if 'compatible' is
Yee Cheng Chin900894b2023-09-29 20:42:32 +020082 set). Many string options with fixed syntax and names
83 also support completing known values. See
84 |cmdline-completion| and |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000085 White space between {option} and '=' is allowed and
86 will be ignored. White space between '=' and {value}
87 is not allowed.
88 See |option-backslash| for using white space and
89 backslashes in {value}.
90
91:se[t] {option}+={value} *:set+=*
92 Add the {value} to a number option, or append the
93 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010094 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000095 value was empty.
96 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000097 are removed. When adding a flag that was already
98 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000099 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100
101:se[t] {option}^={value} *:set^=*
102 Multiply the {value} to a number option, or prepend
103 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100104 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105 value was empty.
106 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000107
108:se[t] {option}-={value} *:set-=*
109 Subtract the {value} from a number option, or remove
110 the {value} from a string option, if it is there.
111 If the {value} is not found in a string option, there
112 is no error or warning. When the option is a comma
113 separated list, a comma is deleted, unless the option
114 becomes empty.
115 When the option is a list of flags, {value} must be
116 exactly as they appear in the option. Remove flags
117 one by one to avoid problems.
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200118 The individual values from a comma separated list or
119 list of flags can be inserted by typing 'wildchar'.
120 See |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122
123The {option} arguments to ":set" may be repeated. For example: >
124 :set ai nosi sw=3 ts=3
125If you make an error in one of the arguments, an error message will be given
126and the following arguments will be ignored.
127
128 *:set-verbose*
129When 'verbose' is non-zero, displaying an option value will also tell where it
130was last set. Example: >
131 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200132< shiftwidth=4 ~
133 Last set from modeline line 1 ~
134 cindent ~
135 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136This is only done when specific option values are requested, not for ":verbose
137set all" or ":verbose set" without an argument.
138When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139When the option was set while executing a function, user command or
140autocommand, the script in which it was defined is reported.
141Note that an option may also have been set as a side effect of setting
142'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000143A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200144 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000145 Option was set in a |modeline|.
146 Last set from --cmd argument ~
147 Option was set with command line argument |--cmd| or +.
148 Last set from -c argument ~
149 Option was set with command line argument |-c|, +, |-S| or
150 |-q|.
151 Last set from environment variable ~
152 Option was set from an environment variable, $VIMINIT,
153 $GVIMINIT or $EXINIT.
154 Last set from error handler ~
155 Option was cleared when evaluating it resulted in an error.
156
Bram Moolenaardb84e452010-08-15 13:50:43 +0200157{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158
159 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000160For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161override the value from the termcap. You can then use it in a mapping. If
162the "xx" part contains special characters, use the <t_xx> form: >
163 :set <t_#4>=^[Ot
164This can also be used to translate a special code for a normal key. For
165example, if Alt-b produces <Esc>b, use this: >
166 :set <M-b>=^[b
167(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
168The advantage over a mapping is that it works in all situations.
169
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100170You can define any key codes, e.g.: >
171 :set t_xy=^[foo;
172There is no warning for using a name that isn't recognized. You can map these
173codes as you like: >
174 :map <t_xy> something
175< *E846*
176When a key code is not set, it's like it does not exist. Trying to get its
177value will result in an error: >
178 :set t_kb=
179 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000180< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100181
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000182The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
183security reasons.
184
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000186at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187"set all" probably does not fit on the screen, causing Vim to give the
188|more-prompt|.
189
190 *option-backslash*
191To include white space in a string option value it has to be preceded with a
192backslash. To include a backslash you have to use two. Effectively this
193means that the number of backslashes in an option value is halved (rounded
194down).
Yee Cheng Chin54844852023-10-09 18:12:31 +0200195In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
196backslashes instead for compatibility with version 3.0 where the options can
197be separated by either commas or spaces.
198Comma-separated options like 'backupdir' and 'tags' will also require commas
199to be escaped with two backslashes, whereas this is not needed for
200non-comma-separated ones like 'makeprg'.
201When setting options using |:let| and |literal-string|, you need to use one
202fewer layer of backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203A few examples: >
Yee Cheng Chin54844852023-10-09 18:12:31 +0200204 :set makeprg=make\ file results in "make file"
205 :let &makeprg='make file' (same as above)
206 :set makeprg=make\\\ file results in "make\ file"
207 :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
208 :set tags=tags\\\ file results in "tags file"
209 :let &tags='tags\ file' (same as above)
210
211 :set makeprg=make,file results in "make,file"
212 :set makeprg=make\\,file results in "make\,file"
213 :set tags=tags,file results in "tags" and "file"
214 :set tags=tags\\,file results in "tags,file"
215 :let &tags='tags\,file' (same as above)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217The "|" character separates a ":set" command from a following command. To
218include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219'titlestring' option to "hi|there": >
220 :set titlestring=hi\|there
221This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
222 :set titlestring=hi|set iconstring=there
223
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200224Similarly, in legacy script the double quote character starts a comment. To
225include the '"' in the option value, use '\"' instead. This example sets the
226'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000227 :set titlestring=hi\ \"there\"
228
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200229In |Vim9| script it's simpler, comments start with a '#' character, and only
230when preceded by white space. A backslash is needed less often: >
231 vim9script
232 set titlestring=hi\ "there"
233 set titlestring=hi#there#
234 set titlestring=hi\ \#there#
235
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100236For Win32 backslashes in file names are mostly not removed. More precise: For
237options that expect a file name (those where environment variables are
238expanded) a backslash before a normal file name character is not removed. But
239a backslash before a special character (space, backslash, comma, etc.) is used
240like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000241There is one special situation, when the value starts with "\\": >
242 :set dir=\\machine\path results in "\\machine\path"
243 :set dir=\\\\machine\\path results in "\\machine\path"
244 :set dir=\\path\\file results in "\\path\file" (wrong!)
245For the first one the start is kept, but for the second one the backslashes
246are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000247halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248result which is probably not what you want. Avoid it.
249
250 *add-option-flags* *remove-option-flags*
251 *E539* *E550* *E551* *E552*
252Some options are a list of flags. When you want to add a flag to such an
253option, without changing the existing ones, you can do it like this: >
254 :set guioptions+=a
255Remove a flag from an option like this: >
256 :set guioptions-=a
257This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000258Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
260doesn't appear.
261
262 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000263Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264environment variable exists the '$' and the following environment variable
265name is replaced with its value. If it does not exist the '$' and the name
266are not modified. Any non-id character (not a letter, digit or '_') may
267follow the environment variable name. That character and what follows is
268appended to the value of the environment variable. Examples: >
269 :set term=$TERM.new
270 :set path=/usr/$INCLUDE,$HOME/include,.
271When adding or removing a string from an option with ":set opt-=val" or ":set
272opt+=val" the expansion is done before the adding or removing.
273
274
275Handling of local options *local-options*
276
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200277Note: The following also applies to |global-local| options.
278
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100280has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000281allows you to set 'list' in one window but not in another. And set
282'shiftwidth' to 3 in one buffer and 4 in another.
283
284The following explains what happens to these local options in specific
285situations. You don't really need to know all of this, since Vim mostly uses
286the option values you would expect. Unfortunately, doing what the user
287expects is a bit complicated...
288
289When splitting a window, the local options are copied to the new window. Thus
290right after the split the contents of the two windows look the same.
291
292When editing a new buffer, its local option values must be initialized. Since
293the local options of the current buffer might be specifically for that buffer,
294these are not used. Instead, for each buffer-local option there also is a
295global value, which is used for new buffers. With ":set" both the local and
296global value is changed. With "setlocal" only the local value is changed,
297thus this value is not used when editing a new buffer.
298
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200299When editing a buffer that has been edited before, the options from the window
300that was last closed are used again. If this buffer has been edited in this
301window, the values from back then are used. Otherwise the values from the
302last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303
304It's possible to set a local window option specifically for a type of buffer.
305When you edit another buffer in the same window, you don't want to keep
306using these local window options. Therefore Vim keeps a global value of the
307local window options, which is used when editing another buffer. Each window
308has its own copy of these values. Thus these are local to the window, but
309global to all buffers in the window. With this you can do: >
310 :e one
311 :set list
312 :e two
313Now the 'list' option will also be set in "two", since with the ":set list"
314command you have also set the global value. >
315 :set nolist
316 :e one
317 :setlocal list
318 :e two
319Now the 'list' option is not set, because ":set nolist" resets the global
320value, ":setlocal list" only changes the local value and ":e two" gets the
321global value. Note that if you do this next: >
322 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200323You will get back the 'list' value as it was the last time you edited "one".
324The options local to a window are remembered for each buffer. This also
325happens when the buffer is not loaded, but they are lost when the buffer is
326wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327
Christian Brabandt596ad662023-08-16 00:11:09 +0200328Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200329
330The following local window options won't be copied over when new windows are
331created, thus they behave slightly differently:
332
333 Option Reason ~
334 'previewwindow' there can only be a single one
335 'scroll' specific to existing window
zeertzjq0049a492024-03-11 23:13:16 +0800336 'winfixbuf' specific to existing window
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200337 'winfixheight' specific to existing window
338 'winfixwidth' specific to existing window
339
Christian Brabandt596ad662023-08-16 00:11:09 +0200340Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200341
342The following local buffer options won't be copied over when new buffers are
343created, thus they behave slightly differently:
344
345 Option Reason ~
346 'filetype' explicitly set by autocommands
347 'syntax' explicitly set by autocommands
348 'bufhidden' denote |special-buffers|
349 'buftype' denote |special-buffers|
350 'readonly' will be detected automatically
351 'modified' will be detected automatically
352
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100354:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 current buffer or window. Not all options have a
356 local value. If the option does not have a local
357 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200358 With the "all" argument: display local values for all
359 local options.
360 Without argument: Display local values for all local
361 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000363 local value. For a global/local boolean option, when
364 the global value is being used, "--" is displayed
365 before the option name.
366 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368
Matt Ellis374e26a2024-02-24 17:02:43 +0100369:se[t] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800370 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100371 For string |global-local| options, the local value is
372 removed, so that the global value will be used.
373 For all other options, the global value is copied to
374 the local value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000375
Matt Ellis374e26a2024-02-24 17:02:43 +0100376:setl[ocal] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800377 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100378 For number and boolean |global-local| options, the
379 local value is removed, so that the global value will
380 be used.
381 For all other options, including string |global-local|
382 options, the global value is copied to the local
383 value.
384
385Note that the behaviour for |global-local| options is slightly different
386between string and number-based options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387
388 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100389:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 option without changing the local value.
391 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200392 With the "all" argument: display global values for all
393 local options.
394 Without argument: display global values for all local
395 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396
397For buffer-local and window-local options:
398 Command global value local value ~
399 :set option=value set set
400 :setlocal option=value - set
401:setglobal option=value set -
402 :set option? - display
403 :setlocal option? - display
404:setglobal option? display -
405
406
407Global options with a local value *global-local*
408
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000409Options are global when you mostly use one value for all buffers and windows.
410For some global options it's useful to sometimes have a different local value.
411You can set the local value with ":setlocal". That buffer or window will then
412use the local value, while other buffers and windows continue using the global
413value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414
415For example, you have two windows, both on C source code. They use the global
416'makeprg' option. If you do this in one of the two windows: >
417 :set makeprg=gmake
418then the other window will switch to the same value. There is no need to set
419the 'makeprg' option in the other C source window too.
420However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000421another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000422files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423 :setlocal makeprg=perlmake
424You can switch back to using the global value by making the local value empty: >
425 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100426This only works for a string option. For a number or boolean option you need
427to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100429Note that for non-boolean and non-number options using "<" copies the global
430value to the local value, it doesn't switch back to using the global value
431(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000432 :set path<
433This will make the local value of 'path' empty, so that the global value is
434used. Thus it does the same as: >
435 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000436Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437":setlocal" on a global option might work differently then.
438
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000439 *option-value-function*
440Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000441'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000442a function name or a function reference or a lambda function. When using a
443lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000444>
445 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000446 set opfunc=function('MyOpFunc')
447 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000448 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000449
450Set to a script-local function: >
451 set opfunc=s:MyLocalFunc
452 set opfunc=<SID>MyLocalFunc
453In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
454the script: >
455 set opfunc=MyLocalFunc
456
457Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000458 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000459 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000460
461Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000462 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000463
464Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000465 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000466 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000467
468In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300469closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000470context of where it was defined.
471
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000472
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473Setting the filetype
474
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200475:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476 Set the 'filetype' option to {filetype}, but only if
477 not done yet in a sequence of (nested) autocommands.
478 This is short for: >
479 :if !did_filetype()
480 : setlocal filetype={filetype}
481 :endif
482< This command is used in a filetype.vim file to avoid
483 setting the 'filetype' option twice, causing different
484 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200485
486 When the optional FALLBACK argument is present, a
487 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100488 'filetype'. This is to be used for filetype
489 detections that are just a guess. |did_filetype()|
490 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200491
Bram Moolenaard58e9292011-02-09 17:07:58 +0100492 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
494:opt[ions] Open a window for viewing and setting all options.
495 Options are grouped by function.
496 Offers short help for each option. Hit <CR> on the
497 short help to open a help window with more help for
498 the option.
499 Modify the value of the option and hit <CR> on the
500 "set" line to set the new value. For window and
501 buffer specific options, the last accessed window is
502 used to set the option value in, unless this is a help
503 window, in which case the window below help window is
504 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100505 {not available when compiled without the |+eval|
506 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000507
508 *$HOME*
509Using "~" is like using "$HOME", but it is only recognized at the start of an
510option and after a space or comma.
511
512On Unix systems "~user" can be used too. It is replaced by the home directory
513of user "user". Example: >
514 :set path=~mool/include,/usr/include,.
515
516On Unix systems the form "${HOME}" can be used too. The name between {} can
517contain non-id characters then. Note that if you want to use this for the
518"gf" command, you need to add the '{' and '}' characters to 'isfname'.
519
520NOTE: expanding environment variables and "~/" is only done with the ":set"
521command, not when assigning a value to an option with ":let".
522
Bram Moolenaarc572da52017-08-27 16:52:01 +0200523 *$HOME-windows*
524On MS-Windows, if $HOME is not defined as an environment variable, then
525at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200526If $HOMEDRIVE is not set then $USERPROFILE is used.
527
528This expanded value is not exported to the environment, this matters when
529running an external command: >
530 :echo system('set | findstr ^HOME=')
531and >
532 :echo luaeval('os.getenv("HOME")')
533should echo nothing (an empty string) despite exists('$HOME') being true.
534When setting $HOME to a non-empty string it will be exported to the
535subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200536
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538Note the maximum length of an expanded option is limited. How much depends on
539the system, mostly it is something like 256 or 1024 characters.
540
541 *:fix* *:fixdel*
542:fix[del] Set the value of 't_kD':
543 't_kb' is 't_kD' becomes ~
544 CTRL-? CTRL-H
545 not CTRL-? CTRL-?
546
Bram Moolenaar82be4842021-01-11 19:40:15 +0100547 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000548
549 If your delete key terminal code is wrong, but the
550 code for backspace is alright, you can put this in
551 your .vimrc: >
552 :fixdel
553< This works no matter what the actual code for
554 backspace is.
555
556 If the backspace key terminal code is wrong you can
557 use this: >
558 :if &term == "termname"
559 : set t_kb=^V<BS>
560 : fixdel
561 :endif
562< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000563 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564 with your terminal name.
565
566 If your <Delete> key sends a strange key sequence (not
567 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
568 :if &term == "termname"
569 : set t_kD=^V<Delete>
570 :endif
571< Where "^V" is CTRL-V and "<Delete>" is the delete key
572 (don't type eight characters!). Replace "termname"
573 with your terminal name.
574
575 *Linux-backspace*
576 Note about Linux: By default the backspace key
577 produces CTRL-?, which is wrong. You can fix it by
578 putting this line in your rc.local: >
579 echo "keycode 14 = BackSpace" | loadkeys
580<
581 *NetBSD-backspace*
582 Note about NetBSD: If your backspace doesn't produce
583 the right code, try this: >
584 xmodmap -e "keycode 22 = BackSpace"
585< If this works, add this in your .Xmodmap file: >
586 keysym 22 = BackSpace
587< You need to restart for this to take effect.
588
589==============================================================================
5902. Automatically setting options *auto-setting*
591
592Besides changing options with the ":set" command, there are three alternatives
593to set options automatically for one or more files:
594
5951. When starting Vim initializations are read from various places. See
596 |initialization|. Most of them are performed for all editing sessions,
597 and some of them depend on the directory where Vim is started.
598 You can create an initialization file with |:mkvimrc|, |:mkview| and
599 |:mksession|.
6002. If you start editing a new file, the automatic commands are executed.
601 This can be used to set options for files matching a particular pattern and
602 many other things. See |autocommand|.
6033. If you start editing a new file, and the 'modeline' option is on, a
604 number of lines at the beginning and end of the file are checked for
605 modelines. This is explained here.
606
607 *modeline* *vim:* *vi:* *ex:* *E520*
608There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100609 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100611[text{white}] empty or any text followed by at least one blank
612 character (<Space> or <Tab>); "ex:" always requires at
613 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200614{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200615[white] optional white space
616{options} a list of option settings, separated with white space
617 or ':', where each part between ':' is the argument
618 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619
Bram Moolenaar14b69452013-06-29 23:05:20 +0200620Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000621 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200622 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623
624The second form (this is compatible with some versions of Vi):
625
Bram Moolenaarade0d392020-01-21 22:33:58 +0100626 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000627
Bram Moolenaarade0d392020-01-21 22:33:58 +0100628[text{white}] empty or any text followed by at least one blank
629 character (<Space> or <Tab>); "ex:" always requires at
630 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200631{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
632[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200633se[t] the string "set " or "se " (note the space); When
634 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200635{options} a list of options, separated with white space, which
636 is the argument for a ":set" command
637: a colon
638[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639
Bram Moolenaar14b69452013-06-29 23:05:20 +0200640Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000641 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200642 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200644The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
645chance that a normal word like "lex:" is caught. There is one exception:
646"vi:" and "vim:" can also be at the start of the line (for compatibility with
647version 3.0). Using "ex:" at the start of the line will be ignored (this
648could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649
Hu Jialun9dcd3492021-08-28 20:42:50 +0200650If the modeline is disabled within a modeline, subsequent modelines will be
651ignored. This is to allow turning off modeline on a per-file basis. This is
652useful when a line looks like a modeline but isn't. For example, it would be
653good to start a YAML file containing strings like "vim:" with
654 # vim: nomodeline ~
655so as to avoid modeline misdetection. Following options on the same line
656after modeline deactivation, if any, are still evaluated (but you would
657normally not have any).
658
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 *modeline-local*
660The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000661buffer and window that contain the file. Although it's possible to set global
662options from a modeline, this is unusual. If you have two windows open and
663the files in it set the same global option to a different value, the result
664depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000666When editing a file that was already loaded, only the window-local options
667from the modeline are used. Thus if you manually changed a buffer-local
668option after opening the file, it won't be changed if you edit the same buffer
669in another window. But window-local options will be set.
670
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671 *modeline-version*
672If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200673number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 vim{vers}: version {vers} or later
675 vim<{vers}: version before {vers}
676 vim={vers}: version {vers}
677 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100678{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
679For example, to use a modeline only for Vim 7.0:
680 /* vim700: set foldmethod=marker */ ~
681To use a modeline for Vim after version 7.2:
682 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683There can be no blanks between "vim" and the ":".
684
685
686The number of lines that are checked can be set with the 'modelines' option.
687If 'modeline' is off or 'modelines' is 0 no lines are checked.
688
689Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000690like:
691 /* vi:ts=4: */ ~
692will give an error message for the trailing "*/". This line is OK:
693 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694
695If an error is detected the rest of the line is skipped.
696
697If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000698backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100699 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
700This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
701before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200702 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000704might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200705can be set. For some options a flag is set, so that when the value is used
706the |sandbox| is effective. Some options can only be set from the modeline
707when 'modelineexpr' is set (the default is off).
708
709Still, there is always a small risk that a modeline causes trouble. E.g.,
710when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
711So disable modelines before editing untrusted text. The mail ftplugin does
712this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713
714Hint: If you would like to do something else than setting an option, you could
715define an autocommand that checks the file for a specific string. For
716example: >
717 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
718And define a function SetVar() that does something with the line containing
719"VAR".
720
721==============================================================================
7223. Options summary *option-summary*
723
724In the list below all the options are mentioned with their full name and with
725an abbreviation if there is one. Both forms may be used.
726
727In this document when a boolean option is "set" that means that ":set option"
728is entered. When an option is "reset", ":set nooption" is used.
729
730For some options there are two default values: The "Vim default", which is
731used when 'compatible' is not set, and the "Vi default", which is used when
732'compatible' is set.
733
734Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000735are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736different value in each window. For example the 'list' option can be set in
737one window and reset in another for the same text, giving both types of view
738at the same time. There are a few options that are specific to a certain
739file. These can have a different value for each file or buffer. For example
740the 'textwidth' option can be 78 for a normal text file and 0 for a C
741program.
742
743 global one option for all buffers and windows
744 local to window each window has its own copy of this option
745 local to buffer each buffer has its own copy of this option
746
747When creating a new window the option values from the currently active window
748are used as a default value for the window-specific options. For the
749buffer-specific options this depends on the 's' and 'S' flags in the
750'cpoptions' option. If 's' is included (which is the default) the values for
751buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000752first entered. If 'S' is present the options are copied each time the buffer
753is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754present, the options are copied from the currently active buffer when the
755buffer is created.
756
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000757Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000759Not all options are supported in all versions. This depends on the supported
760features and sometimes on the system. A remark about this is in curly braces
761below. When an option is not supported it may still be set without getting an
762error, this is called a hidden option. You can't get the value of a hidden
763option though, it is not stored.
764
765To test if option "foo" can be used with ":set" use something like this: >
766 if exists('&foo')
767This also returns true for a hidden option. To test if option "foo" is really
768supported use something like this: >
769 if exists('+foo')
770<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 *E355*
772A jump table for the options with a short description can be found at |Q_op|.
773
774 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100775'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 {only available when compiled with the |+rightleft|
778 feature}
779 The ASCII code for the first letter of the Hebrew alphabet. The
780 routine that maps the keyboard in Hebrew mode, both in Insert mode
781 (when hkmap is set) and on the command-line (when hitting CTRL-_)
782 outputs the Hebrew characters in the range [aleph..aleph+26].
783 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
784 See |rileft.txt|.
785
786 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
787'allowrevins' 'ari' boolean (default off)
788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 {only available when compiled with the |+rightleft|
790 feature}
791 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
792 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
793 into reverse Insert mode, and don't know how to get out. See
794 'revins'.
795 NOTE: This option is reset when 'compatible' is set.
796
797 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
798'altkeymap' 'akm' boolean (default off)
799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 {only available when compiled with the |+farsi|
801 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100802 This option was for using Farsi, which has been removed. See
803 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804
805 *'ambiwidth'* *'ambw'*
806'ambiwidth' 'ambw' string (default: "single")
807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
809 Tells Vim what to do with characters with East Asian Width Class
810 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
811 letters, Cyrillic letters).
812
813 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000814 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 expected by most users.
816 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200817 *E834* *E835*
818 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100819 contains a character that would be double width. These errors may
820 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200821
822 The values are overruled for characters specified with
823 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824
825 There are a number of CJK fonts for which the width of glyphs for
826 those characters are solely based on how many octets they take in
827 legacy/traditional CJK encodings. In those encodings, Euro,
828 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000829 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000831 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 Vim is running inside a terminal (emulators) that uses a CJK font
833 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
834 this option should be set to "double" to match the width perceived
835 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100836 to be set to "double" under CJK MS-Windows when the system locale is
837 set to one of CJK locales. See Unicode Standard Annex #11
838 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100840 Vim may set this option automatically at startup time when Vim is
841 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200842 escape sequence to request cursor position report. The response can
843 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100844
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
846'antialias' 'anti' boolean (default: off)
847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200849 on macOS}
850 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
852 which can be easier to read at certain sizes on certain displays.
853 Setting this option can sometimes cause problems if 'guifont' is set
854 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100855 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
858'arabic' 'arab' boolean (default off)
859 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 {only available when compiled with the |+arabic|
861 feature}
862 This option can be set to start editing Arabic text.
863 Setting this option will:
864 - Set the 'rightleft' option, unless 'termbidi' is set.
865 - Set the 'arabicshape' option, unless 'termbidi' is set.
866 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
867 between typing English and Arabic key mapping.
868 - Set the 'delcombine' option
869 Note that 'encoding' must be "utf-8" for working with Arabic text.
870
871 Resetting this option will:
872 - Reset the 'rightleft' option.
873 - Disable the use of 'keymap' (without changing its value).
874 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200875 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100876 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 Also see |arabic.txt|.
878
879 *'arabicshape'* *'arshape'*
880 *'noarabicshape'* *'noarshape'*
881'arabicshape' 'arshape' boolean (default on)
882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 {only available when compiled with the |+arabic|
884 feature}
885 When on and 'termbidi' is off, the required visual character
886 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200887 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 one which encompasses:
889 a) the changing/morphing of characters based on their location
890 within a word (initial, medial, final and stand-alone).
891 b) the enabling of the ability to compose characters
892 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100893 When disabled the display shows each character's true stand-alone
894 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 Arabic is a complex language which requires other settings, for
896 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100897 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898
laburnumT3f7855a2023-12-05 18:37:03 +0100899 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
900'autochdir' 'acd' boolean (default off)
901 global
902 {only available when compiled with it, use
903 exists("+autochdir") to check}
904 When on, Vim will change the current working directory whenever you
905 open a file, switch buffers, delete a buffer or open/close a window.
906 It will change to the directory containing the file which was opened
907 or selected. When a buffer has no name it also has no directory, thus
908 the current directory won't change when navigating to it.
909 Note: When this option is on some plugins may not work.
910
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
912'autoindent' 'ai' boolean (default off)
913 local to buffer
914 Copy indent from current line when starting a new line (typing <CR>
915 in Insert mode or when using the "o" or "O" command). If you do not
916 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000917 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
918 to another line has the same effect, unless the 'I' flag is included
919 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000920 When autoindent is on, formatting (with the "gq" command or when you
921 reach 'textwidth' in Insert mode) uses the indentation of the first
922 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923 When 'smartindent' or 'cindent' is on the indent is changed in
924 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200925 The 'autoindent' option is reset when the 'paste' option is set and
926 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927
928 *'autoread'* *'ar'* *'noautoread'* *'noar'*
929'autoread' 'ar' boolean (default off)
930 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 When a file has been detected to have been changed outside of Vim and
932 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200933 When the file has been deleted this is not done, so you have the text
934 from before it was deleted. When it appears again then it is read.
935 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 If this option has a local value, use this command to switch back to
937 using the global value: >
938 :set autoread<
939<
laburnumT3f7855a2023-12-05 18:37:03 +0100940
941 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
942'autoshelldir' 'asd' boolean (default off)
943 global
944 When on, Vim will change the current working directory whenever you
945 change the directory of the shell running in a terminal window. You
946 need proper setting-up, so whenever the shell's pwd changes an OSC 7
947 escape sequence will be emitted. For example, on Linux, you can
948 source /etc/profile.d/vte.sh in your shell profile if you use bash or
949 zsh. For bash this should work (put it in a bash init file): >
950 if [[ -n "$VIM_TERMINAL" ]]; then
951 PROMPT_COMMAND='_vim_sync_PWD'
952 function _vim_sync_PWD() {
953 printf '\033]7;file://%s\033\\' "$PWD"
954 }
955 fi
956<
957 Or, in a zsh init file: >
958 if [[ -n "$VIM_TERMINAL" ]]; then
959 autoload -Uz add-zsh-hook
960 add-zsh-hook -Uz chpwd _vim_sync_PWD
961 function _vim_sync_PWD() {
962 printf '\033]7;file://%s\033\\' "$PWD"
963 }
964 fi
965<
966 In a fish init file: >
967 if test -n "$VIM_TERMINAL"
968 function _vim_sync_PWD --on-variable=PWD
969 printf '\033]7;file://%s\033\\' "$PWD"
970 end
971 end
972<
973 You can find an alternative method at |terminal-autoshelldir|.
974 When the parsing of the OSC sequence fails you get *E1179* .
975
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
977'autowrite' 'aw' boolean (default off)
978 global
979 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000980 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000981 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
982 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000983 to another file.
984 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000985 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 Note that for some commands the 'autowrite' option is not used, see
987 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200988 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200989 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100990 USE WITH CARE: If you make temporary changes to a buffer that you
991 don't want to be saved this option may cause it to be saved anyway.
992 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993
994 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
995'autowriteall' 'awa' boolean (default off)
996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
998 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
999 Setting this option also implies that Vim behaves like 'autowrite' has
1000 been set.
1001
1002 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001003'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 When set to "dark", Vim will try to use colors that look good on a
1006 dark background. When set to "light", Vim will try to use colors that
1007 look good on a light background. Any other value is illegal.
1008 Vim tries to set the default value according to the terminal used.
1009 This will not always be correct.
1010 Setting this option does not change the background color, it tells Vim
1011 what the background color looks like. For changing the background
1012 color, see |:hi-normal|.
1013
Gregory Anders83ad2722024-01-03 19:48:51 +01001014 When 'background' is changed Vim will adjust the default color groups
1015 for the new value. But the colors used for syntax highlighting will
1016 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001017 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001018 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 the color scheme adjusts to the value of 'background' this will work.
1020 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001021 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022
1023 When setting 'background' to the default value with: >
1024 :set background&
1025< Vim will guess the value. In the GUI this should work correctly,
1026 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001027 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001028 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001030 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001031 color from the terminal. If the returned RGB value is dark/light and
1032 'background' is not dark/light, 'background' will be set and the
1033 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001034 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001035 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001036
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 When starting the GUI, the default value for 'background' will be
1038 "light". When the value is not set in the .gvimrc, and Vim detects
1039 that the background is actually quite dark, 'background' is set to
1040 "dark". But this happens only AFTER the .gvimrc file has been read
1041 (because the window needs to be opened to find the actual background
1042 color). To get around this, force the GUI window to be opened by
1043 putting a ":gui" command in the .gvimrc file, before where the value
1044 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001045
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001046 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001047 For other systems "dark" is used when 'term' is "linux",
1048 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1049 background. Otherwise the default is "light".
1050
Bram Moolenaarc572da52017-08-27 16:52:01 +02001051 The |:terminal| command and the |term_start()| function use the
1052 'background' value to decide whether the terminal window will start
1053 with a white or black background.
1054
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 Normally this option would be set in the .vimrc file. Possibly
1056 depending on the terminal name. Example: >
1057 :if &term == "pcterm"
1058 : set background=dark
1059 :endif
1060< When this option is set, the default settings for the highlight groups
1061 will change. To use other settings, place ":highlight" commands AFTER
1062 the setting of the 'background' option.
1063 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1064 to select the colors for syntax highlighting. After changing this
1065 option, you must load syntax.vim again to see the result. This can be
1066 done with ":syntax on".
1067
1068 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001069'backspace' 'bs' string (default "", set to "indent,eol,start"
1070 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1073 mode. This is a list of items, separated by commas. Each item allows
1074 a way to backspace over something:
1075 value effect ~
1076 indent allow backspacing over autoindent
1077 eol allow backspacing over line breaks (join lines)
1078 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1079 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001080 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1081 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082
Bram Moolenaar46eea442022-03-30 10:51:39 +01001083 When the value is empty, Vi compatible backspacing is used, none of
1084 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
1086 For backwards compatibility with version 5.4 and earlier:
1087 value effect ~
1088 0 same as ":set backspace=" (Vi compatible)
1089 1 same as ":set backspace=indent,eol"
1090 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001091 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092
1093 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1094 NOTE: This option is set to "" when 'compatible' is set.
1095
1096 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1097'backup' 'bk' boolean (default off)
1098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 Make a backup before overwriting a file. Leave it around after the
1100 file has been successfully written. If you do not want to keep the
1101 backup file, but you do want a backup while the file is being
1102 written, reset this option and set the 'writebackup' option (this is
1103 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001104 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 |backup-table| for more explanations.
1106 When the 'backupskip' pattern matches, a backup is not made anyway.
1107 When 'patchmode' is set, the backup may be renamed to become the
1108 oldest version of a file.
1109 NOTE: This option is reset when 'compatible' is set.
1110
1111 *'backupcopy'* *'bkc'*
1112'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001113 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001115 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116
1117 The main values are:
1118 "yes" make a copy of the file and overwrite the original one
1119 "no" rename the file and write a new one
1120 "auto" one of the previous, what works best
1121
1122 Extra values that can be combined with the ones above are:
1123 "breaksymlink" always break symlinks when writing
1124 "breakhardlink" always break hardlinks when writing
1125
1126 Making a copy and overwriting the original file:
1127 - Takes extra time to copy the file.
1128 + When the file has special attributes, is a (hard/symbolic) link or
1129 has a resource fork, all this is preserved.
1130 - When the file is a link the backup will have the name of the link,
1131 not of the real file.
1132
1133 Renaming the file and writing a new one:
1134 + It's fast.
1135 - Sometimes not all attributes of the file can be copied to the new
1136 file.
1137 - When the file is a link the new file will not be a link.
1138
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001139 The "auto" value is the middle way: When Vim sees that renaming the
1140 file is possible without side effects (the attributes can be passed on
1141 and the file is not a link) that is used. When problems are expected,
1142 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143
1144 The "breaksymlink" and "breakhardlink" values can be used in
1145 combination with any of "yes", "no" and "auto". When included, they
1146 force Vim to always break either symbolic or hard links by doing
1147 exactly what the "no" option does, renaming the original file to
1148 become the backup and writing a new file in its place. This can be
1149 useful for example in source trees where all the files are symbolic or
1150 hard links and any changes should stay in the local source tree, not
1151 be propagated back to the original source.
1152 *crontab*
1153 One situation where "no" and "auto" will cause problems: A program
1154 that opens a file, invokes Vim to edit that file, and then tests if
1155 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001156 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157 example.
1158
1159 When a copy is made, the original file is truncated and then filled
1160 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001161 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001162 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 group of the backup is set to the group of the original file. If this
1164 fails, the protection bits for the group are made the same as for
1165 others.
1166
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001167 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 the same attributes of the original file, and the newly written file
1169 is owned by the current user. When the file was a (hard/symbolic)
1170 link, the new file will not! That's why the "auto" value doesn't
1171 rename when the file is a link. The owner and group of the newly
1172 written file will be set to the same ones as the original file, but
1173 the system may refuse to do this. In that case the "auto" value will
1174 again not rename the file.
1175
Bram Moolenaar036986f2017-03-16 17:41:02 +01001176 NOTE: This option is set to the Vi default value when 'compatible' is
1177 set and to the Vim default value when 'compatible' is reset.
1178
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 *'backupdir'* *'bdir'*
1180'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001181 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 for Unix: ".,~/tmp,~/")
1183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 List of directories for the backup file, separated with commas.
1185 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001186 where this is possible. The directory must exist, Vim will not
1187 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001188 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189 impossible!). Writing may fail because of this.
1190 - A directory "." means to put the backup file in the same directory
1191 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001192 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1193 the backup file relative to where the edited file is. The leading
1194 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 ("." inside a directory name has no special meaning).
1196 - Spaces after the comma are ignored, other spaces are considered part
1197 of the directory name. To have a space at the start of a directory
1198 name, precede it with a backslash.
1199 - To include a comma in a directory name precede it with a backslash.
1200 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001201 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001202 the backup file name will be built from the complete path to the
1203 file with all path separators changed to percent '%' signs. This
1204 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001205 On Win32, it is also possible to end with "\\". However, When a
1206 separating comma is following, you must use "//", since "\\" will
1207 include the comma in the file name. Therefore it is recommended to
1208 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 - Environment variables are expanded |:set_env|.
1210 - Careful with '\' characters, type one before a space, type two to
1211 get one in the option (see |option-backslash|), for example: >
1212 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1213< - For backwards compatibility with Vim version 3.0 a '>' at the start
1214 of the option is removed.
1215 See also 'backup' and 'writebackup' options.
1216 If you want to hide your backup files on Unix, consider this value: >
1217 :set backupdir=./.backup,~/.backup,.,/tmp
1218< You must create a ".backup" directory in each directory and in your
1219 home directory for this to work properly.
1220 The use of |:set+=| and |:set-=| is preferred when adding or removing
1221 directories from the list. This avoids problems when a future version
1222 uses another default.
1223 This option cannot be set from a |modeline| or in the |sandbox|, for
1224 security reasons.
1225
1226 *'backupext'* *'bex'* *E589*
1227'backupext' 'bex' string (default "~", for VMS: "_")
1228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 String which is appended to a file name to make the name of the
1230 backup file. The default is quite unusual, because this avoids
1231 accidentally overwriting existing files with a backup file. You might
1232 prefer using ".bak", but make sure that you don't have files with
1233 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001234 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001236 If you like to keep a lot of backups, you could use a BufWritePre
1237 autocommand to change 'backupext' just before writing the file to
1238 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001239 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001240< Use 'backupdir' to put the backup in a different directory.
1241
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001243'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1244 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1245 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 A list of file patterns. When one of the patterns matches with the
1248 name of the file which is written, no backup file is created. Both
1249 the specified file name and the full path name of the file are used.
1250 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1251 Watch out for special characters, see |option-backslash|.
1252 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001253 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001254
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001255 WARNING: Not having a backup file means that when Vim fails to write
1256 your buffer correctly and then, for whatever reason, Vim exits, you
1257 lose both the original file and what you were writing. Only disable
1258 backups if you don't care about losing the file.
1259
Bram Moolenaar02467872007-05-06 13:22:01 +00001260 Note that environment variables are not expanded. If you want to use
1261 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001262 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001263
1264< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001265 backup would be made by renaming the original file crontab won't see
1266 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267
1268 *'balloondelay'* *'bdlay'*
1269'balloondelay' 'bdlay' number (default: 600)
1270 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271 {only available when compiled with the |+balloon_eval|
1272 feature}
1273 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1274
1275 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1276'ballooneval' 'beval' boolean (default off)
1277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001279 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001280 Switch on the |balloon-eval| functionality for the GUI.
1281
1282 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1283 *'nobevalterm'*
1284'balloonevalterm' 'bevalterm' boolean (default off)
1285 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001286 {only available when compiled with the
1287 |+balloon_eval_term| feature}
1288 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001290 *'balloonexpr'* *'bexpr'*
1291'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001292 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001293 {only available when compiled with the |+balloon_eval|
1294 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001295 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001296 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1297 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001298
1299 v:beval_bufnr number of the buffer in which balloon is going to show
1300 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001301 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001302 v:beval_lnum line number
1303 v:beval_col column number (byte index)
1304 v:beval_text word under or after the mouse pointer
1305
Bram Moolenaar54775062019-07-31 21:07:14 +02001306 Instead of showing a balloon, which is limited to plain text, consider
1307 using a popup window, see |popup_beval_example|. A popup window can
1308 use highlighting and show a border.
1309
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001310 The evaluation of the expression must not have side effects!
1311 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001312 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001313 return 'Cursor is at line ' .. v:beval_lnum ..
1314 \ ', column ' .. v:beval_col ..
1315 \ ' of file ' .. bufname(v:beval_bufnr) ..
1316 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001317 endfunction
1318 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001319 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001320<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001321 Also see |balloon_show()|, it can be used if the content of the balloon
1322 is to be fetched asynchronously. In that case evaluating
1323 'balloonexpr' should result in an empty string. If you get a balloon
1324 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001325
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001326 NOTE: The balloon is displayed only if the cursor is on a text
1327 character. If the result of evaluating 'balloonexpr' is not empty,
1328 Vim does not try to send a message to an external debugger (Netbeans
1329 or Sun Workshop).
1330
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001331 If the expression starts with s: or |<SID>|, then it is replaced with
1332 the script ID (|local-function|). Example: >
1333 set bexpr=s:MyBalloonExpr()
1334 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001335< Otherwise, the expression is evaluated in the context of the script
1336 where the option was set, thus script-local items are available.
1337
Bram Moolenaar30b65812012-07-12 22:01:11 +02001338 The expression will be evaluated in the |sandbox| when set from a
1339 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001340 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001341
1342 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001343 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001344
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001345 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001346 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001347< When they are supported "\n" characters will start a new line. If the
1348 expression evaluates to a |List| this is equal to using each List item
1349 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001350 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001351
Bram Moolenaar165bc692015-07-21 17:53:25 +02001352 *'belloff'* *'bo'*
1353'belloff' 'bo' string (default "")
1354 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001355 Specifies for which events the bell will not be rung. It is a comma
1356 separated list of items. For each item that is present, the bell
1357 will be silenced. This is most useful to specify specific events in
1358 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001359 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001360
1361 item meaning when present ~
1362 all All events.
1363 backspace When hitting <BS> or <Del> and deleting results in an
1364 error.
1365 cursor Fail to move around using the cursor keys or
1366 <PageUp>/<PageDown> in |Insert-mode|.
1367 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1368 |i_CTRL-X_CTRL-T|.
1369 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1370 |i_CTRL-E|.
1371 ctrlg Unknown Char after <C-G> in Insert mode.
1372 error Other Error occurred (e.g. try to join last line)
1373 (mostly used in |Normal-mode| or |Cmdline-mode|).
1374 esc hitting <Esc> in |Normal-mode|.
1375 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001376 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001377 insertmode Pressing <Esc> in 'insertmode'.
1378 lang Calling the beep module for Lua/Mzscheme/TCL.
1379 mess No output available for |g<|.
1380 showmatch Error occurred for 'showmatch' function.
1381 operator Empty region error |cpo-E|.
1382 register Unknown register after <C-R> in |Insert-mode|.
1383 shell Bell from shell output |:!|.
1384 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001385 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001386 wildmode More matches in |cmdline-completion| available
1387 (depends on the 'wildmode' setting).
1388
Bram Moolenaar036986f2017-03-16 17:41:02 +01001389 This is most useful to fine tune when in Insert mode the bell should
1390 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001391 indicate that an error occurred. It can be silenced by adding the
1392 "error" keyword.
1393
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1395'binary' 'bin' boolean (default off)
1396 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 This option should be set before editing a binary file. You can also
1398 use the |-b| Vim argument. When this option is switched on a few
1399 options will be changed (also when it already was on):
1400 'textwidth' will be set to 0
1401 'wrapmargin' will be set to 0
1402 'modeline' will be off
1403 'expandtab' will be off
1404 Also, 'fileformat' and 'fileformats' options will not be used, the
1405 file is read and written like 'fileformat' was "unix" (a single <NL>
1406 separates lines).
1407 The 'fileencoding' and 'fileencodings' options will not be used, the
1408 file is read without conversion.
1409 NOTE: When you start editing a(nother) file while the 'bin' option is
1410 on, settings from autocommands may change the settings again (e.g.,
1411 'textwidth'), causing trouble when editing. You might want to set
1412 'bin' again when the file has been loaded.
1413 The previous values of these options are remembered and restored when
1414 'bin' is switched from on to off. Each buffer has its own set of
1415 saved option values.
1416 To edit a file with 'binary' set you can use the |++bin| argument.
1417 This avoids you have to do ":set bin", which would have effect for all
1418 files you edit.
1419 When writing a file the <EOL> for the last line is only written if
1420 there was one in the original file (normally Vim appends an <EOL> to
1421 the last line if there is none; this would make the file longer). See
1422 the 'endofline' option.
1423
1424 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1425'bioskey' 'biosk' boolean (default on)
1426 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001427 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001428 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429
1430 *'bomb'* *'nobomb'*
1431'bomb' boolean (default off)
1432 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 When writing a file and the following conditions are met, a BOM (Byte
1434 Order Mark) is prepended to the file:
1435 - this option is on
1436 - the 'binary' option is off
1437 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1438 endian variants.
1439 Some applications use the BOM to recognize the encoding of the file.
1440 Often used for UCS-2 files on MS-Windows. For other applications it
1441 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001442 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1444 check for the presence of the BOM is done and 'bomb' set accordingly.
1445 Unless 'binary' is set, it is removed from the first line, so that you
1446 don't see it when editing. When you don't change the options, the BOM
1447 will be restored when writing the file.
1448
1449 *'breakat'* *'brk'*
1450'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1451 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001452 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 feature}
1454 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001455 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1456 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001458 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001459'breakindent' 'bri' boolean (default off)
1460 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001461 {not available when compiled without the |+linebreak|
1462 feature}
1463 Every wrapped line will continue visually indented (same amount of
1464 space as the beginning of that line), thus preserving horizontal blocks
1465 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001466 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001467
1468 *'breakindentopt'* *'briopt'*
1469'breakindentopt' 'briopt' string (default empty)
1470 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001471 {not available when compiled without the |+linebreak|
1472 feature}
1473 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001474 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001475 min:{n} Minimum text width that will be kept after
1476 applying 'breakindent', even if the resulting
1477 text should normally be narrower. This prevents
1478 text indented almost to the right window border
1479 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001480 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001481 shift:{n} After applying 'breakindent', the wrapped line's
1482 beginning will be shifted by the given number of
1483 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001484 indentation (negative) or emphasizing the line
1485 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001486 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001487 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001488 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001489 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001490 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001491 numbered or bulleted list (using the
1492 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001493 list:-1 Uses the length of a match with 'formatlistpat'
1494 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001495 (default: 0)
1496 column:{n} Indent at column {n}. Will overrule the other
1497 sub-options. Note: an additional indent may be
1498 added for the 'showbreak' setting.
1499 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001500
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001502'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001504 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001506 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001507 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 buffer Use the directory of the related buffer.
1509 current Use the current directory.
1510 {path} Use the specified directory
1511
1512 *'bufhidden'* *'bh'*
1513'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001514 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515 This option specifies what happens when a buffer is no longer
1516 displayed in a window:
1517 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001518 hide hide the buffer (don't unload it), even if 'hidden' is
1519 not set
1520 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001521 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001522 delete delete the buffer from the buffer list, even if
1523 'hidden' is set; the |:hide| command will also delete
1524 the buffer, making it behave like |:bdelete|
1525 wipe wipe the buffer from the buffer list, even if
1526 'hidden' is set; the |:hide| command will also wipe
1527 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001529 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001530 are lost without a warning. Also, these values may break autocommands
1531 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 This option is used together with 'buftype' and 'swapfile' to specify
1533 special kinds of buffers. See |special-buffers|.
1534
1535 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1536'buflisted' 'bl' boolean (default: on)
1537 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 When this option is set, the buffer shows up in the buffer list. If
1539 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1540 This option is reset by Vim for buffers that are only used to remember
1541 a file name or marks. Vim sets it when starting to edit a buffer.
1542 But not when moving to a buffer with ":buffer".
1543
1544 *'buftype'* *'bt'* *E382*
1545'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001546 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 The value of this option specifies the type of a buffer:
1548 <empty> normal buffer
1549 nofile buffer which is not related to a file and will not be
1550 written
1551 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001552 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001553 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001555 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 help help buffer (you are not supposed to set this
1557 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001558 terminal buffer for a |terminal| (you are not supposed to set
1559 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001560 prompt buffer where only the last line can be edited, meant
1561 to be used by a plugin, see |prompt-buffer|
1562 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001563 popup buffer used in a popup window, see |popup|.
1564 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565
1566 This option is used together with 'bufhidden' and 'swapfile' to
1567 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001568 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569
1570 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001571 One such effect is that Vim will not check the timestamp of the file,
1572 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573
Bram Moolenaar280f1262006-01-30 00:14:18 +00001574 A "quickfix" buffer is only used for the error list and the location
1575 list. This value is set by the |:cwindow| and |:lwindow| commands and
1576 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
1578 "nofile" and "nowrite" buffers are similar:
1579 both: The buffer is not to be written to disk, ":w" doesn't
1580 work (":w filename" does work though).
1581 both: The buffer is never considered to be |'modified'|.
1582 There is no warning when the changes will be lost, for
1583 example when you quit Vim.
1584 both: A swap file is only created when using too much memory
1585 (when 'swapfile' has been reset there is never a swap
1586 file).
1587 nofile only: The buffer name is fixed, it is not handled like a
1588 file name. It is not modified in response to a |:cd|
1589 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001590 both: When using ":e bufname" and already editing "bufname"
1591 the buffer is made empty and autocommands are
1592 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001593 *E676*
1594 "acwrite" implies that the buffer name is not related to a file, like
1595 "nofile", but it will be written. Thus, in contrast to "nofile" and
1596 "nowrite", ":w" does work and a modified buffer can't be abandoned
1597 without saving. For writing there must be matching |BufWriteCmd|,
1598 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599
1600 *'casemap'* *'cmp'*
1601'casemap' 'cmp' string (default: "internal,keepascii")
1602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 Specifies details about changing the case of letters. It may contain
1604 these words, separated by a comma:
1605 internal Use internal case mapping functions, the current
1606 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001607 matters when 'encoding' is a Unicode encoding,
1608 "latin1" or "iso-8859-15". When "internal" is
1609 omitted, the towupper() and towlower() system library
1610 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1612 case mapping, the current locale is not effective.
1613 This probably only matters for Turkish.
1614
Bram Moolenaar938ae282023-02-20 20:44:55 +00001615 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001616'cdhome' 'cdh' boolean (default: off)
1617 global
1618 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1619 current working directory to the |$HOME| directory like in Unix.
1620 When off, those commands just print the current directory name.
1621 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001622 This option cannot be set from a |modeline| or in the |sandbox|, for
1623 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001624 NOTE: This option is reset when 'compatible' is set.
1625
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 *'cdpath'* *'cd'* *E344* *E346*
1627'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001630 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1631 searched for has a relative path, not an absolute part starting with
1632 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 The 'cdpath' option's value has the same form and semantics as
1634 |'path'|. Also see |file-searching|.
1635 The default value is taken from $CDPATH, with a "," prepended to look
1636 in the current directory first.
1637 If the default value taken from $CDPATH is not what you want, include
1638 a modified version of the following command in your vimrc file to
1639 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001640 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641< This option cannot be set from a |modeline| or in the |sandbox|, for
1642 security reasons.
1643 (parts of 'cdpath' can be passed to the shell to expand file names).
1644
1645 *'cedit'*
1646'cedit' string (Vi default: "", Vim default: CTRL-F)
1647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648 The key used in Command-line Mode to open the command-line window.
1649 The default is CTRL-F when 'compatible' is off.
1650 Only non-printable keys are allowed.
1651 The key can be specified as a single character, but it is difficult to
1652 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001653 :exe "set cedit=\<C-Y>"
1654 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655< |Nvi| also has this option, but it only uses the first character.
1656 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001657 NOTE: This option is set to the Vim default value when 'compatible'
1658 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659
1660 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1661'charconvert' 'ccv' string (default "")
1662 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001663 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 An expression that is used for character encoding conversion. It is
1665 evaluated when a file that is to be read or has been written has a
1666 different encoding from what is desired.
1667 'charconvert' is not used when the internal iconv() function is
1668 supported and is able to do the conversion. Using iconv() is
1669 preferred, because it is much faster.
1670 'charconvert' is not used when reading stdin |--|, because there is no
1671 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001672 The expression must return zero, false or an empty string for success,
1673 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 The possible encoding names encountered are in 'encoding'.
1675 Additionally, names given in 'fileencodings' and 'fileencoding' are
1676 used.
1677 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1678 is done internally by Vim, 'charconvert' is not used for this.
1679 'charconvert' is also used to convert the viminfo file, if the 'c'
1680 flag is present in 'viminfo'. Also used for Unicode conversion.
1681 Example: >
1682 set charconvert=CharConvert()
1683 fun CharConvert()
1684 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001685 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1686 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 return v:shell_error
1688 endfun
1689< The related Vim variables are:
1690 v:charconvert_from name of the current encoding
1691 v:charconvert_to name of the desired encoding
1692 v:fname_in name of the input file
1693 v:fname_out name of the output file
1694 Note that v:fname_in and v:fname_out will never be the same.
1695 Note that v:charconvert_from and v:charconvert_to may be different
1696 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001697
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001698 The advantage of using a function call without arguments is that it is
1699 faster, see |expr-option-function|.
1700
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 Encryption is not done by Vim when using 'charconvert'. If you want
1702 to encrypt the file after conversion, 'charconvert' should take care
1703 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001704
1705 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1706 replaced with the script ID (|local-function|). Example: >
1707 set charconvert=s:MyConvert()
1708 set charconvert=<SID>SomeConvert()
1709< Otherwise the expression is evaluated in the context of the script
1710 where the option was set, thus script-local items are available.
1711
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 This option cannot be set from a |modeline| or in the |sandbox|, for
1713 security reasons.
1714
1715 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1716'cindent' 'cin' boolean (default off)
1717 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001718 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 that trigger reindenting in insert mode and 'cinoptions' to set your
1720 preferred indent style.
1721 If 'indentexpr' is not empty, it overrules 'cindent'.
1722 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1723 the "=" operator indents using this algorithm rather than calling an
1724 external program.
1725 See |C-indenting|.
1726 When you don't like the way 'cindent' works, try the 'smartindent'
1727 option or 'indentexpr'.
1728 This option is not used when 'paste' is set.
1729 NOTE: This option is reset when 'compatible' is set.
1730
1731 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001732'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 A list of keys that, when typed in Insert mode, cause reindenting of
1735 the current line. Only used if 'cindent' is on and 'indentexpr' is
1736 empty.
1737 For the format of this option see |cinkeys-format|.
1738 See |C-indenting|.
1739
1740 *'cinoptions'* *'cino'*
1741'cinoptions' 'cino' string (default "")
1742 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1744 program. See |cinoptions-values| for the values of this option, and
1745 |C-indenting| for info on C indenting in general.
1746
laburnumT3f7855a2023-12-05 18:37:03 +01001747 *'cinscopedecls'* *'cinsd'*
1748'cinscopedecls' 'cinsd' string (default "public,protected,private")
1749 local to buffer
1750 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1751 Useful e.g. for working with the Qt framework that defines additional
1752 scope declarations "signals", "public slots" and "private slots": >
1753 set cinscopedecls+=signals,public\ slots,private\ slots
1754<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 *'cinwords'* *'cinw'*
1756'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1757 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 These keywords start an extra indent in the next line when
1759 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1760 an appropriate place (inside {}).
1761 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1762 matter, include the keyword both the uppercase and lowercase:
1763 "if,If,IF".
1764
laburnumT3f7855a2023-12-05 18:37:03 +01001765 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1767 for X-windows, "" otherwise)
1768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 {only in GUI versions or when the |+xterm_clipboard|
1770 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001771 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001772 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001773 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001774 prepend, e.g.: >
1775 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001776< When using the GUI see |'go-A'|.
1777 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001779 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 unnamed When included, Vim will use the clipboard register '*'
1781 for all yank, delete, change and put operations which
1782 would normally go to the unnamed register. When a
1783 register is explicitly specified, it will always be
1784 used regardless of whether "unnamed" is in 'clipboard'
1785 or not. The clipboard register can always be
1786 explicitly accessed using the "* notation. Also see
1787 |gui-clipboard|.
1788
Bram Moolenaar30b65812012-07-12 22:01:11 +02001789 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001790 unnamedplus A variant of the "unnamed" flag which uses the
1791 clipboard register '+' (|quoteplus|) instead of
1792 register '*' for all yank, delete, change and put
1793 operations which would normally go to the unnamed
1794 register. When "unnamed" is also included to the
1795 option, yank operations (but not delete, change or
1796 put) will additionally copy the text into register
1797 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001798 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001799 Availability can be checked with: >
1800 if has('unnamedplus')
1801<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001802 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 autoselect Works like the 'a' flag in 'guioptions': If present,
1804 then whenever Visual mode is started, or the Visual
1805 area extended, Vim tries to become the owner of the
1806 windowing system's global selection or put the
1807 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001808 register "*. See |'go-a'| and |quotestar| for details.
1809 When the GUI is active, the 'a' flag in 'guioptions'
1810 is used, when the GUI is not active, this "autoselect"
1811 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 Also applies to the modeless selection.
1813
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001814 *clipboard-autoselectplus*
1815 autoselectplus Like "autoselect" but using the + register instead of
1816 the * register. Compare to the 'P' flag in
1817 'guioptions'.
1818
1819 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 autoselectml Like "autoselect", but for the modeless selection
1821 only. Compare to the 'A' flag in 'guioptions'.
1822
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001823 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001824 html When the clipboard contains HTML, use this when
1825 pasting. When putting text on the clipboard, mark it
1826 as HTML. This works to copy rendered HTML from
1827 Firefox, paste it as raw HTML in Vim, select the HTML
1828 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001829 You probably want to add this only temporarily,
1830 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001831 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001832
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001833 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 exclude:{pattern}
1835 Defines a pattern that is matched against the name of
1836 the terminal 'term'. If there is a match, no
1837 connection will be made to the X server. This is
1838 useful in this situation:
1839 - Running Vim in a console.
1840 - $DISPLAY is set to start applications on another
1841 display.
1842 - You do not want to connect to the X server in the
1843 console, but do want this in a terminal emulator.
1844 To never connect to the X server use: >
1845 exclude:.*
1846< This has the same effect as using the |-X| argument.
1847 Note that when there is no connection to the X server
1848 the window title won't be restored and the clipboard
1849 cannot be accessed.
1850 The value of 'magic' is ignored, {pattern} is
1851 interpreted as if 'magic' was on.
1852 The rest of the option value will be used for
1853 {pattern}, this must be the last entry.
1854
1855 *'cmdheight'* *'ch'*
1856'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001857 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001858 Number of screen lines to use for the command-line. A larger value
1859 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001860 The value of this option is stored with the tab page, so that each tab
1861 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862
1863 *'cmdwinheight'* *'cwh'*
1864'cmdwinheight' 'cwh' number (default 7)
1865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 Number of screen lines to use for the command-line window. |cmdwin|
1867
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001868 *'colorcolumn'* *'cc'*
1869'colorcolumn' 'cc' string (default "")
1870 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001871 {not available when compiled without the |+syntax|
1872 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001873 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001874 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1875 text. Will make screen redrawing slower.
1876 The screen column can be an absolute number, or a number preceded with
1877 '+' or '-', which is added to or subtracted from 'textwidth'. >
1878
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001879 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001880 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1881 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1882<
1883 When 'textwidth' is zero then the items with '-' and '+' are not used.
1884 A maximum of 256 columns are highlighted.
1885
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 *'columns'* *'co'* *E594*
1887'columns' 'co' number (default 80 or terminal width)
1888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001890 initialization and does not have to be set by hand. Also see
1891 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 When Vim is running in the GUI or in a resizable window, setting this
1893 option will cause the window size to be changed. When you only want
1894 to use the size for the GUI, put the command in your |gvimrc| file.
1895 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001896 number of columns of the display, the display may be messed up. For
1897 the GUI it is always possible and Vim limits the number of columns to
1898 what fits on the screen. You can use this command to get the widest
1899 window possible: >
1900 :set columns=9999
1901< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902
1903 *'comments'* *'com'* *E524* *E525*
1904'comments' 'com' string (default
1905 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1906 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001907 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 |format-comments|. See |option-backslash| about using backslashes to
1909 insert a space.
1910
1911 *'commentstring'* *'cms'* *E537*
1912'commentstring' 'cms' string (default "/*%s*/")
1913 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 {not available when compiled without the |+folding|
1915 feature}
1916 A template for a comment. The "%s" in the value is replaced with the
1917 comment text. Currently only used to add markers for folding, see
Christian Brabandtd801edf2024-05-19 09:28:26 +02001918 |fold-marker|. Also used by comment plugins |comment-install|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919
1920 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001921'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001922 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 This option has the effect of making Vim either more Vi-compatible, or
1925 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001926
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001928 other options are also changed as a side effect.
1929 NOTE: Setting or resetting this option can have a lot of unexpected
1930 effects: Mappings are interpreted in another way, undo behaves
1931 differently, etc. If you set this option in your vimrc file, you
1932 should probably put it at the very start.
1933
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 By default this option is on and the Vi defaults are used for the
1935 options. This default was chosen for those people who want to use Vim
1936 just like Vi, and don't even (want to) know about the 'compatible'
1937 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001938 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001939 this option is switched off, and all options that have not been
1940 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001941 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001942 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001943 happen for the system-wide vimrc or gvimrc file, nor for a file given
1944 with the |-u| argument). Also see |compatible-default| and
1945 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 You can also set this option with the "-C" argument, and reset it with
1947 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001948 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949
Bram Moolenaar214641f2017-03-05 17:04:09 +01001950 When this option is set, numerous other options are set to make Vim as
1951 Vi-compatible as possible. When this option is unset, various options
1952 are set to make Vim more useful. The table below lists all the
1953 options affected.
1954 The {?} column indicates when the options are affected:
1955 + Means that the option is set to the value given in {set value} when
1956 'compatible' is set.
1957 & Means that the option is set to the value given in {set value} when
1958 'compatible' is set AND is set to its Vim default value when
1959 'compatible' is unset.
1960 - Means the option is NOT changed when setting 'compatible' but IS
1961 set to its Vim default when 'compatible' is unset.
1962 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963
Bram Moolenaar036986f2017-03-16 17:41:02 +01001964 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001965
1966 'allowrevins' + off no CTRL-_ command
1967 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001968 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001969 'arabicshape' + on correct character shapes
1970 'backspace' + "" normal backspace
1971 'backup' + off no backup file
1972 'backupcopy' & Unix: "yes" backup file is a copy
1973 else: "auto" copy or rename backup file
1974 'balloonexpr' + "" text to show in evaluation balloon
1975 'breakindent' + off don't indent when wrapping lines
1976 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001977 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001978 'cindent' + off no C code indentation
1979 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1980 'copyindent' + off don't copy indent structure
1981 'cpoptions' & (all flags) Vi-compatible flags
1982 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001983 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001984 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001985 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001986 'cscopeverbose' + off see |cscopeverbose|
1987 'delcombine' + off unicode: delete whole char combination
1988 'digraph' + off no digraphs
1989 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001990 this also disables |modifyOtherKeys|
1991 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001992 'expandtab' + off tabs not expanded to spaces
1993 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001994 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001995 'formatexpr' + "" use 'formatprg' for auto-formatting
1996 'formatoptions' & "vt" Vi compatible formatting
1997 'gdefault' + off no default 'g' flag for ":s"
1998 'history' & 0 no commandline history
1999 'hkmap' + off no Hebrew keyboard mapping
2000 'hkmapp' + off no phonetic Hebrew keyboard mapping
2001 'hlsearch' + off no highlighting of search matches
2002 'incsearch' + off no incremental searching
2003 'indentexpr' + "" no indenting by expression
2004 'insertmode' + off do not start in Insert mode
2005 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002007 'joinspaces' + on insert 2 spaces after period
2008 'modeline' & off no modelines
2009 'more' & off no pauses in listings
2010 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2011 'numberwidth' & 8 min number of columns for line number
2012 'preserveindent'+ off don't preserve current indent structure
2013 when changing it
2014 'revins' + off no reverse insert
2015 'ruler' + off no ruler
2016 'scrolljump' + 1 no jump scroll
2017 'scrolloff' + 0 no scroll offset
2018 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2019 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002020 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002021 'showcmd' & off command characters not shown
2022 'showmode' & off current mode not shown
2023 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2024 'smartcase' + off no automatic ignore case switch
2025 'smartindent' + off no smart indentation
2026 'smarttab' + off no smart tab size
2027 'softtabstop' + 0 tabs are always 'tabstop' positions
2028 'startofline' + on goto startofline with some commands
2029 'tagcase' & "followic" 'ignorecase' when searching tags file
2030 'tagrelative' & off tag file names are not relative
2031 'termguicolors' + off don't use highlight-(guifg|guibg)
2032 'textauto' & off no automatic textmode detection
2033 'textwidth' + 0 no automatic line wrap
2034 'tildeop' + off tilde is not an operator
2035 'ttimeout' + off no terminal timeout
2036 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002037 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002038 'virtualedit' + "" cursor can only be placed on characters
2039 'whichwrap' & "" left-right movements don't wrap
2040 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002042 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043
2044 *'complete'* *'cpt'* *E535*
2045'complete' 'cpt' string (default: ".,w,b,u,t,i")
2046 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 This option specifies how keyword completion |ins-completion| works
2048 when CTRL-P or CTRL-N are used. It is also used for whole-line
2049 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002050 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002051 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 w scan buffers from other windows
2053 b scan other loaded buffers that are in the buffer list
2054 u scan the unloaded buffers that are in the buffer list
2055 U scan the buffers that are not in the buffer list
2056 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002057 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 k{dict} scan the file {dict}. Several "k" flags can be given,
2059 patterns are valid too. For example: >
2060 :set cpt=k/usr/dict/*,k~/spanish
2061< s scan the files given with the 'thesaurus' option
2062 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2063 are valid too.
2064 i scan current and included files
2065 d scan current and included files for defined name or macro
2066 |i_CTRL-X_CTRL-D|
2067 ] tag completion
2068 t same as "]"
2069
2070 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2071 not executed, this may lead to unexpected completions from some files
2072 (gzipped files for example). Unloaded buffers are not scanned for
2073 whole-line completion.
2074
2075 The default is ".,w,b,u,t,i", which means to scan:
2076 1. the current buffer
2077 2. buffers in other windows
2078 3. other loaded buffers
2079 4. unloaded buffers
2080 5. tags
2081 6. included files
2082
2083 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002084 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2085 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002087 *'completefunc'* *'cfu'*
2088'completefunc' 'cfu' string (default: empty)
2089 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002090 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002091 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002092 This option specifies a function to be used for Insert mode completion
2093 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002094 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002095 invoked and what it should return. The value can be the name of a
2096 function, a |lambda| or a |Funcref|. See |option-value-function| for
2097 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002098 This option cannot be set from a |modeline| or in the |sandbox|, for
2099 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002100
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002101 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002102'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002103 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002104 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002105 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002106
2107 menu Use a popup menu to show the possible completions. The
2108 menu is only shown when there is more than one match and
2109 sufficient colors are available. |ins-completion-menu|
2110
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002111 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002112 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002113 match, e.g., what file it comes from.
2114
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002115 longest Only insert the longest common text of the matches. If
2116 the menu is displayed you can use CTRL-L to add more
2117 characters. Whether case is ignored depends on the kind
2118 of completion. For buffer text the 'ignorecase' option is
2119 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002120
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002121 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002122 completion in the preview window. Only works in
2123 combination with "menu" or "menuone".
2124
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002125 popup Show extra information about the currently selected
2126 completion in a popup window. Only works in combination
2127 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002128 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002129 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002130
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002131 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002132 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002133 |CompleteChanged| autocommand to fetch the info and call
2134 |popup_show()| once the popup has been filled.
2135 See the example at |complete-popuphidden|.
2136 {only works when compiled with the |+textprop| feature}
2137
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002138 noinsert Do not insert any text for a match until the user selects
2139 a match from the menu. Only works in combination with
2140 "menu" or "menuone". No effect if "longest" is present.
2141
2142 noselect Do not select a match in the menu, force the user to
2143 select one from the menu. Only works in combination with
2144 "menu" or "menuone".
2145
glepnira218cc62024-06-03 19:32:39 +02002146 fuzzy Enable |fuzzy-matching| for completion candidates. This
2147 allows for more flexible and intuitive matching, where
2148 characters can be skipped and matches can be found even
2149 if the exact sequence is not typed.
2150
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002151 *'completepopup'* *'cpp'*
2152'completepopup' 'cpp' string (default empty)
2153 global
2154 {not available when compiled without the |+textprop|
2155 or |+quickfix| feature}
2156 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002157 properties of the info popup when it is created. If an info popup
2158 window already exists it is closed, so that the option value is
2159 applied when it is created again.
2160 You can also use |popup_findinfo()| and then set properties for an
2161 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002162
laburnumT3f7855a2023-12-05 18:37:03 +01002163 *'completeslash'* *'csl'*
2164'completeslash' 'csl' string (default: "")
2165 local to buffer
2166 {only for MS-Windows}
2167 When this option is set it overrules 'shellslash' for completion:
2168 - When this option is set to "slash", a forward slash is used for path
2169 completion in insert mode. This is useful when editing HTML tag, or
2170 Makefile with 'noshellslash' on MS-Windows.
2171 - When this option is set to "backslash", backslash is used. This is
2172 useful when editing a batch file with 'shellslash' set on MS-Windows.
2173 - When this option is empty, same character is used as for
2174 'shellslash'.
2175 For Insert mode completion the buffer-local value is used. For
2176 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002177
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002178 *'concealcursor'* *'cocu'*
2179'concealcursor' 'cocu' string (default: "")
2180 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002181 {not available when compiled without the |+conceal|
2182 feature}
2183 Sets the modes in which text in the cursor line can also be concealed.
2184 When the current mode is listed then concealing happens just like in
2185 other lines.
2186 n Normal mode
2187 v Visual mode
2188 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002189 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002190
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002191 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002192 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002193 are moving around text is concealed, but when starting to insert text
2194 or selecting a Visual area the concealed text is displayed, so that
2195 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002196 Keep in mind that the cursor position is not always where it's
2197 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002198
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002199 *'conceallevel'* *'cole'*
2200'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002201 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002202 {not available when compiled without the |+conceal|
2203 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002204 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2205 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002206
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002207 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002208 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002209 1 Each block of concealed text is replaced with one
2210 character. If the syntax item does not have a custom
2211 replacement character defined (see |:syn-cchar|) the
2212 character defined in 'listchars' is used (default is a
2213 space).
2214 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002215 2 Concealed text is completely hidden unless it has a
2216 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002217 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002218 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002219
Bram Moolenaara7781e02010-07-19 20:13:22 +02002220 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002221 edit and copy the text. This can be changed with the 'concealcursor'
2222 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002223
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2225'confirm' 'cf' boolean (default off)
2226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 When 'confirm' is on, certain operations that would normally
2228 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2229 instead raise a |dialog| asking if you wish to save the current
2230 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2231 If 'confirm' is off you can still activate confirmation for one
2232 command only (this is most useful in mappings) with the |:confirm|
2233 command.
2234 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2235
2236 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2237'conskey' 'consk' boolean (default off)
2238 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002239 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240
2241 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2242'copyindent' 'ci' boolean (default off)
2243 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 Copy the structure of the existing lines indent when autoindenting a
2245 new line. Normally the new indent is reconstructed by a series of
2246 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2247 in which case only spaces are used). Enabling this option makes the
2248 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002249 existing line. 'expandtab' has no effect on these characters, a Tab
2250 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002252 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 Also see 'preserveindent'.
2254
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002255 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256'cpoptions' 'cpo' string (Vim default: "aABceFs",
2257 Vi default: all flags)
2258 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002260 this indicates Vi-compatible behavior. This is used for things where
2261 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 'cpoptions' stands for "compatible-options".
2263 Commas can be added for readability.
2264 To avoid problems with flags that are added in the future, use the
2265 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002266
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 NOTE: This option is set to the Vi default value when 'compatible' is
2268 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002269
2270 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2271 is saved, 'cpoptions' is set to the Vim default, and the saved value
2272 is restored at the end of the script. Changes to the value of
2273 'cpoptions' will be applied to the saved value, but keep in mind that
2274 removing a flag that is not present when 'cpoptions' is changed has no
2275 effect. In the |.vimrc| file the value is not restored, thus using
2276 `vim9script` in the |.vimrc| file results in using the Vim default.
2277
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002278 NOTE: This option is set to the POSIX default value at startup when
2279 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002280 variable exists |posix|. This means Vim tries to behave like the
2281 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282
2283 contains behavior ~
2284 *cpo-a*
2285 a When included, a ":read" command with a file name
2286 argument will set the alternate file name for the
2287 current window.
2288 *cpo-A*
2289 A When included, a ":write" command with a file name
2290 argument will set the alternate file name for the
2291 current window.
2292 *cpo-b*
2293 b "\|" in a ":map" command is recognized as the end of
2294 the map command. The '\' is included in the mapping,
2295 the text after the '|' is interpreted as the next
2296 command. Use a CTRL-V instead of a backslash to
2297 include the '|' in the mapping. Applies to all
2298 mapping, abbreviation, menu and autocmd commands.
2299 See also |map_bar|.
2300 *cpo-B*
2301 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002302 abbreviations, user commands and the "to" part of the
2303 menu commands. Remove this flag to be able to use a
2304 backslash like a CTRL-V. For example, the command
2305 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 'B' included: "\^[" (^[ is a real <Esc>)
2307 'B' excluded: "<Esc>" (5 characters)
2308 ('<' excluded in both cases)
2309 *cpo-c*
2310 c Searching continues at the end of any match at the
2311 cursor position, but not further than the start of the
2312 next line. When not present searching continues
2313 one character from the cursor position. With 'c'
2314 "abababababab" only gets three matches when repeating
2315 "/abab", without 'c' there are five matches.
2316 *cpo-C*
2317 C Do not concatenate sourced lines that start with a
2318 backslash. See |line-continuation|.
2319 *cpo-d*
2320 d Using "./" in the 'tags' option doesn't mean to use
2321 the tags file relative to the current file, but the
2322 tags file in the current directory.
2323 *cpo-D*
2324 D Can't use CTRL-K to enter a digraph after Normal mode
2325 commands with a character argument, like |r|, |f| and
2326 |t|.
2327 *cpo-e*
2328 e When executing a register with ":@r", always add a
2329 <CR> to the last line, also when the register is not
2330 linewise. If this flag is not present, the register
2331 is not linewise and the last line does not end in a
2332 <CR>, then the last line is put on the command-line
2333 and can be edited before hitting <CR>.
2334 *cpo-E*
2335 E It is an error when using "y", "d", "c", "g~", "gu" or
2336 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002337 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 This makes "y0" fail in the first column.
2339 *cpo-f*
2340 f When included, a ":read" command with a file name
2341 argument will set the file name for the current buffer,
2342 if the current buffer doesn't have a file name yet.
2343 *cpo-F*
2344 F When included, a ":write" command with a file name
2345 argument will set the file name for the current
2346 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002347 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348 *cpo-g*
2349 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002350 *cpo-H*
2351 H When using "I" on a line with only blanks, insert
2352 before the last blank. Without this flag insert after
2353 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 *cpo-i*
2355 i When included, interrupting the reading of a file will
2356 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002357 *cpo-I*
2358 I When moving the cursor up or down just after inserting
2359 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 *cpo-j*
2361 j When joining lines, only add two spaces after a '.',
2362 not after '!' or '?'. Also see 'joinspaces'.
2363 *cpo-J*
2364 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002365 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 white space.
2367 *cpo-k*
2368 k Disable the recognition of raw key codes in
2369 mappings, abbreviations, and the "to" part of menu
2370 commands. For example, if <Key> sends ^[OA (where ^[
2371 is <Esc>), the command ":map X ^[OA" results in X
2372 being mapped to:
2373 'k' included: "^[OA" (3 characters)
2374 'k' excluded: "<Key>" (one key code)
2375 Also see the '<' flag below.
2376 *cpo-K*
2377 K Don't wait for a key code to complete when it is
2378 halfway a mapping. This breaks mapping <F1><F1> when
2379 only part of the second <F1> has been read. It
2380 enables cancelling the mapping by typing <F1><Esc>.
2381 *cpo-l*
2382 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002383 literally, only "\]", "\^", "\-" and "\\" are special.
2384 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2386 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002387 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 *cpo-L*
2389 L When the 'list' option is set, 'wrapmargin',
2390 'textwidth', 'softtabstop' and Virtual Replace mode
2391 (see |gR|) count a <Tab> as two characters, instead of
2392 the normal behavior of a <Tab>.
2393 *cpo-m*
2394 m When included, a showmatch will always wait half a
2395 second. When not included, a showmatch will wait half
2396 a second or until a character is typed. |'showmatch'|
2397 *cpo-M*
2398 M When excluded, "%" matching will take backslashes into
2399 account. Thus in "( \( )" and "\( ( \)" the outer
2400 parenthesis match. When included "%" ignores
2401 backslashes, which is Vi compatible.
2402 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002403 n When included, the column used for 'number' and
2404 'relativenumber' will also be used for text of wrapped
2405 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 *cpo-o*
2407 o Line offset to search command is not remembered for
2408 next search.
2409 *cpo-O*
2410 O Don't complain if a file is being overwritten, even
2411 when it didn't exist when editing it. This is a
2412 protection against a file unexpectedly created by
2413 someone else. Vi didn't complain about this.
2414 *cpo-p*
2415 p Vi compatible Lisp indenting. When not present, a
2416 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002417 *cpo-P*
2418 P When included, a ":write" command that appends to a
2419 file will set the file name for the current buffer, if
2420 the current buffer doesn't have a file name yet and
2421 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002422 *cpo-q*
2423 q When joining multiple lines leave the cursor at the
2424 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425 *cpo-r*
2426 r Redo ("." command) uses "/" to repeat a search
2427 command, instead of the actually used search string.
2428 *cpo-R*
2429 R Remove marks from filtered lines. Without this flag
2430 marks are kept like |:keepmarks| was used.
2431 *cpo-s*
2432 s Set buffer options when entering the buffer for the
2433 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002434 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 set when the buffer is created.
2436 *cpo-S*
2437 S Set buffer options always when entering a buffer
2438 (except 'readonly', 'fileformat', 'filetype' and
2439 'syntax'). This is the (most) Vi compatible setting.
2440 The options are set to the values in the current
2441 buffer. When you change an option and go to another
2442 buffer, the value is copied. Effectively makes the
2443 buffer options global to all buffers.
2444
2445 's' 'S' copy buffer options
2446 no no when buffer created
2447 yes no when buffer first entered (default)
2448 X yes each time when buffer entered (vi comp.)
2449 *cpo-t*
2450 t Search pattern for the tag command is remembered for
2451 "n" command. Otherwise Vim only puts the pattern in
2452 the history for search pattern, but doesn't change the
2453 last used search pattern.
2454 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002455 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 *cpo-v*
2457 v Backspaced characters remain visible on the screen in
2458 Insert mode. Without this flag the characters are
2459 erased from the screen right away. With this flag the
2460 screen newly typed text overwrites backspaced
2461 characters.
2462 *cpo-w*
2463 w When using "cw" on a blank character, only change one
2464 character and not all blanks until the start of the
2465 next word.
2466 *cpo-W*
2467 W Don't overwrite a readonly file. When omitted, ":w!"
2468 overwrites a readonly file, if possible.
2469 *cpo-x*
2470 x <Esc> on the command-line executes the command-line.
2471 The default in Vim is to abandon the command-line,
2472 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002473 *cpo-X*
2474 X When using a count with "R" the replaced text is
2475 deleted only once. Also when repeating "R" with "."
2476 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002478 y A yank command can be redone with ".". Think twice if
2479 you really want to use this, it may break some
2480 plugins, since most people expect "." to only repeat a
2481 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002482 *cpo-Z*
2483 Z When using "w!" while the 'readonly' option is set,
2484 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 *cpo-!*
2486 ! When redoing a filter command, use the last used
2487 external command, whatever it was. Otherwise the last
2488 used -filter- command is used.
2489 *cpo-$*
2490 $ When making a change to one line, don't redisplay the
2491 line, but put a '$' at the end of the changed text.
2492 The changed text will be overwritten when you type the
2493 new text. The line is redisplayed if you type any
2494 command that moves the cursor from the insertion
2495 point.
2496 *cpo-%*
2497 % Vi-compatible matching is done for the "%" command.
2498 Does not recognize "#if", "#endif", etc.
2499 Does not recognize "/*" and "*/".
2500 Parens inside single and double quotes are also
2501 counted, causing a string that contains a paren to
2502 disturb the matching. For example, in a line like
2503 "if (strcmp("foo(", s))" the first paren does not
2504 match the last one. When this flag is not included,
2505 parens inside single and double quotes are treated
2506 specially. When matching a paren outside of quotes,
2507 everything inside quotes is ignored. When matching a
2508 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002509 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002510 This flag is also used for other features, such as
2511 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002512 *cpo--*
2513 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002514 it would go above the first line or below the last
2515 line. Without it the cursor moves to the first or
2516 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002517 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002518 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002519 *cpo-+*
2520 + When included, a ":write file" command will reset the
2521 'modified' flag of the buffer, even though the buffer
2522 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002523 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 * Use ":*" in the same way as ":@". When not included,
2525 ":*" is an alias for ":'<,'>", select the Visual area.
2526 *cpo-<*
2527 < Disable the recognition of special key codes in |<>|
2528 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002529 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 ":map X <Tab>" results in X being mapped to:
2531 '<' included: "<Tab>" (5 characters)
2532 '<' excluded: "^I" (^I is a real <Tab>)
2533 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002534 *cpo->*
2535 > When appending to a register, put a line break before
2536 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002537 *cpo-;*
2538 ; When using |,| or |;| to repeat the last |t| search
2539 and the cursor is right in front of the searched
2540 character, the cursor won't move. When not included,
2541 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002542 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002543
2544 POSIX flags. These are not included in the Vi default value, except
2545 when $VIM_POSIX was set on startup. |posix|
2546
2547 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002548 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002549 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002550 *cpo-&*
2551 & When ":preserve" was used keep the swap file when
2552 exiting normally while this buffer is still loaded.
2553 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002554 *cpo-\*
2555 \ Backslash in a [] range in a search pattern is taken
2556 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002557 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2558 '\' excluded: "/[ \-]" finds <Space> and '-'
2559 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002560 *cpo-/*
2561 / When "%" is used as the replacement string in a |:s|
2562 command, use the previous replacement string. |:s%|
2563 *cpo-{*
2564 { The |{| and |}| commands also stop at a "{" character
2565 at the start of a line.
2566 *cpo-.*
2567 . The ":chdir" and ":cd" commands fail if the current
2568 buffer is modified, unless ! is used. Vim doesn't
2569 need this, since it remembers the full path of an
2570 opened file.
2571 *cpo-bar*
2572 | The value of the $LINES and $COLUMNS environment
2573 variables overrule the terminal size values obtained
2574 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002575
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002576 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002577'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002578 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002579 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002580 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002581 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002582 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002583 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002584 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002585 blowfish Blowfish method. Medium strong encryption but it has
2586 an implementation flaw. Requires Vim 7.3 or later,
2587 files can NOT be read by Vim 7.2 and older. This adds
2588 a "seed" to the file, every time you write the file
2589 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002590 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002591 *blowfish2*
2592 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002593 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002594 and older. This adds a "seed" to the file, every time
2595 you write the file the encrypted bytes will be
2596 different. The whole undo file is encrypted, not just
2597 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002598 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002599 *E1197* *E1198* *E1199* *E1200* *E1201*
2600 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2601 Code. Medium strong till strong encryption.
2602 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002603 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002604 It adds a seed and a message authentication code (MAC)
2605 to the file. This needs at least a Vim 8.2.3022 to
2606 read the encrypted file.
2607 Encryption of swap files is not supported, therefore
2608 no swap file will be used when xchacha20 encryption is
2609 enabled.
2610 Encryption of undo files is not yet supported,
2611 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002612 CAREFUL: Files written with this method might have to
2613 be read back with the same version of Vim if the
2614 binary format changes later.
2615 Obsolete, please do no longer use.
2616 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2617 stores the key derivation parameters together with the
2618 encrypted file. Should work better in case the
2619 parameters in the libsodium library ever change.
2620 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002621 might have to be read back with the same version of
2622 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002623
Christian Brabandtaae58342023-04-23 17:50:22 +01002624 You should use "blowfish2", also to re-encrypt older files. The
2625 "xchacha20" method provides better encryption, but it does not work
2626 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002627
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002628 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002629 to the detected method of the file being read. Thus if you write it
2630 without changing 'cryptmethod' the same method will be used.
2631 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002632 explicitly write it, you don't get a warning unless there are other
2633 modifications. Also see |:X|.
2634
2635 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002636 the value "blowfish2". When setting the local value to an empty
2637 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002638
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002639 When a new encryption method is added in a later version of Vim, and
2640 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002641 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002642
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 *'cscopepathcomp'* *'cspc'*
2644'cscopepathcomp' 'cspc' number (default 0)
2645 global
2646 {not available when compiled without the |+cscope|
2647 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 Determines how many components of the path to show in a list of tags.
2649 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002650 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651
2652 *'cscopeprg'* *'csprg'*
2653'cscopeprg' 'csprg' string (default "cscope")
2654 global
2655 {not available when compiled without the |+cscope|
2656 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 Specifies the command to execute cscope. See |cscopeprg|.
2658 This option cannot be set from a |modeline| or in the |sandbox|, for
2659 security reasons.
2660
2661 *'cscopequickfix'* *'csqf'*
2662'cscopequickfix' 'csqf' string (default "")
2663 global
2664 {not available when compiled without the |+cscope|
2665 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 Specifies whether to use quickfix window to show cscope results.
2667 See |cscopequickfix|.
2668
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002669 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002670'cscoperelative' 'csre' boolean (default off)
2671 global
2672 {not available when compiled without the |+cscope|
2673 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002674 In the absence of a prefix (-P) for cscope. setting this option enables
2675 to use the basename of cscope.out path as the prefix.
2676 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002677 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002678
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2680'cscopetag' 'cst' boolean (default off)
2681 global
2682 {not available when compiled without the |+cscope|
2683 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 Use cscope for tag commands. See |cscope-options|.
2685 NOTE: This option is reset when 'compatible' is set.
2686
2687 *'cscopetagorder'* *'csto'*
2688'cscopetagorder' 'csto' number (default 0)
2689 global
2690 {not available when compiled without the |+cscope|
2691 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 Determines the order in which ":cstag" performs a search. See
2693 |cscopetagorder|.
2694 NOTE: This option is set to 0 when 'compatible' is set.
2695
2696 *'cscopeverbose'* *'csverb'*
2697 *'nocscopeverbose'* *'nocsverb'*
2698'cscopeverbose' 'csverb' boolean (default off)
2699 global
2700 {not available when compiled without the |+cscope|
2701 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 Give messages when adding a cscope database. See |cscopeverbose|.
2703 NOTE: This option is reset when 'compatible' is set.
2704
Bram Moolenaar860cae12010-06-05 23:22:07 +02002705 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2706'cursorbind' 'crb' boolean (default off)
2707 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002708 When this option is set, as the cursor in the current
2709 window moves other cursorbound windows (windows that also have
2710 this option set) move their cursors to the corresponding line and
2711 column. This option is useful for viewing the
2712 differences between two versions of a file (see 'diff'); in diff mode,
2713 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002714 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002715
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002716 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2717'cursorcolumn' 'cuc' boolean (default off)
2718 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002719 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002720 feature}
2721 Highlight the screen column of the cursor with CursorColumn
2722 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2723 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002724 If you only want the highlighting in the current window you can use
2725 these autocommands: >
2726 au WinLeave * set nocursorline nocursorcolumn
2727 au WinEnter * set cursorline cursorcolumn
2728<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002729
2730 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2731'cursorline' 'cul' boolean (default off)
2732 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002733 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002734 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002735 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2736 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002737 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002738 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002739
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002740 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002741'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002742 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002743 {not available when compiled without the |+syntax|
2744 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002745 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002746 Valid values:
2747 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002748 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002749 "screenline" Highlight only the screen line of the cursor with
2750 CursorLine |hl-CursorLine|.
2751 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002752 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002753
2754 Special value:
2755 "both" Alias for the values "line,number".
2756
2757 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002758
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 *'debug'*
2760'debug' string (default "")
2761 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002762 These values can be used:
2763 msg Error messages that would otherwise be omitted will be given
2764 anyway.
2765 throw Error messages that would otherwise be omitted will be given
2766 anyway and also throw an exception and set |v:errmsg|.
2767 beep A message will be given when otherwise only a beep would be
2768 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002769 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002770 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2771 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772
2773 *'define'* *'def'*
2774'define' 'def' string (default "^\s*#\s*define")
2775 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002776 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 pattern, just like for the "/" command. This option is used for the
2778 commands like "[i" and "[d" |include-search|. The 'isident' option is
2779 used to recognize the defined name after the match:
2780 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2781 See |option-backslash| about inserting backslashes to include a space
2782 or backslash.
2783 The default value is for C programs. For C++ this value would be
2784 useful, to include const type declarations: >
2785 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002786< You can also use "\ze" just before the name and continue the pattern
2787 to check what is following. E.g. for Javascript, if a function is
2788 defined with "func_name = function(args)": >
2789 ^\s*\ze\i\+\s*=\s*function(
2790< If the function is defined with "func_name : function() {...": >
2791 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002793 To avoid that use `:let` with a single quote string: >
2794 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002795<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796
2797 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2798'delcombine' 'deco' boolean (default off)
2799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 If editing Unicode and this option is set, backspace and Normal mode
2801 "x" delete each combining character on its own. When it is off (the
2802 default) the character along with its combining characters are
2803 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002804 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805
2806 This is useful for Arabic, Hebrew and many other languages where one
2807 may have combining characters overtop of base characters, and want
2808 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002809 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810
2811 *'dictionary'* *'dict'*
2812'dictionary' 'dict' string (default "")
2813 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 List of file names, separated by commas, that are used to lookup words
2815 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2816 contain a list of words. This can be one word per line, or several
2817 words per line, separated by non-keyword characters (white space is
2818 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002819
2820 When this option is empty or an entry "spell" is present, and spell
2821 checking is enabled, words in the word lists for the currently active
2822 'spelllang' are used. See |spell|.
2823
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002824 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 after a comma are ignored, otherwise spaces are included in the file
2826 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002827 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 Where to find a list of words?
2829 - On FreeBSD, there is the file "/usr/share/dict/words".
2830 - In the Simtel archive, look in the "msdos/linguist" directory.
2831 - In "miscfiles" of the GNU collection.
2832 The use of |:set+=| and |:set-=| is preferred when adding or removing
2833 directories from the list. This avoids problems when a future version
2834 uses another default.
2835 Backticks cannot be used in this option for security reasons.
2836
2837 *'diff'* *'nodiff'*
2838'diff' boolean (default off)
2839 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840 {not available when compiled without the |+diff|
2841 feature}
2842 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002843 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844
2845 *'dex'* *'diffexpr'*
2846'diffexpr' 'dex' string (default "")
2847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 {not available when compiled without the |+diff|
2849 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002850 Expression which is evaluated to obtain a diff file (either ed-style
2851 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 This option cannot be set from a |modeline| or in the |sandbox|, for
2853 security reasons.
2854
2855 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002856'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 {not available when compiled without the |+diff|
2859 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002860 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 All are optional. Items must be separated by a comma.
2862
2863 filler Show filler lines, to keep the text
2864 synchronized with a window that has inserted
2865 lines at the same position. Mostly useful
2866 when windows are side-by-side and 'scrollbind'
2867 is set.
2868
2869 context:{n} Use a context of {n} lines between a change
2870 and a fold that contains unchanged lines.
2871 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002872 When using zero the context is actually one,
2873 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002874 for a deleted line. Set it to a very large
2875 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 See |fold-diff|.
2877
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002878 iblank Ignore changes where lines are all blank. Adds
2879 the "-B" flag to the "diff" command if
2880 'diffexpr' is empty. Check the documentation
2881 of the "diff" command for what this does
2882 exactly.
2883 NOTE: the diff windows will get out of sync,
2884 because no differences between blank lines are
2885 taken into account.
2886
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 icase Ignore changes in case of text. "a" and "A"
2888 are considered the same. Adds the "-i" flag
2889 to the "diff" command if 'diffexpr' is empty.
2890
2891 iwhite Ignore changes in amount of white space. Adds
2892 the "-b" flag to the "diff" command if
2893 'diffexpr' is empty. Check the documentation
2894 of the "diff" command for what this does
2895 exactly. It should ignore adding trailing
2896 white space, but not leading white space.
2897
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002898 iwhiteall Ignore all white space changes. Adds
2899 the "-w" flag to the "diff" command if
2900 'diffexpr' is empty. Check the documentation
2901 of the "diff" command for what this does
2902 exactly.
2903
2904 iwhiteeol Ignore white space changes at end of line.
2905 Adds the "-Z" flag to the "diff" command if
2906 'diffexpr' is empty. Check the documentation
2907 of the "diff" command for what this does
2908 exactly.
2909
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002910 horizontal Start diff mode with horizontal splits (unless
2911 explicitly specified otherwise).
2912
2913 vertical Start diff mode with vertical splits (unless
2914 explicitly specified otherwise).
2915
Bram Moolenaarc8234772019-11-10 21:00:27 +01002916 closeoff When a window is closed where 'diff' is set
2917 and there is only one window remaining in the
2918 same tab page with 'diff' set, execute
2919 `:diffoff` in that window. This undoes a
2920 `:diffsplit` command.
2921
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002922 hiddenoff Do not use diff mode for a buffer when it
2923 becomes hidden.
2924
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002925 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2926 starting diff mode. Without this 2 is used.
2927
Bram Moolenaar4223d432021-02-10 13:18:17 +01002928 followwrap Follow the 'wrap' option and leave as it is.
2929
Bram Moolenaare828b762018-09-10 17:51:58 +02002930 internal Use the internal diff library. This is
2931 ignored when 'diffexpr' is set. *E960*
2932 When running out of memory when writing a
2933 buffer this item will be ignored for diffs
2934 involving that buffer. Set the 'verbose'
2935 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936
Bram Moolenaare828b762018-09-10 17:51:58 +02002937 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002938 Use the indent heuristic for the internal
2939 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002940
zeertzjqd086b8f2024-02-25 15:42:52 +08002941 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002942 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002943 algorithms are:
2944 myers the default algorithm
2945 minimal spend extra time to generate the
2946 smallest possible diff
2947 patience patience diff algorithm
2948 histogram histogram diff algorithm
2949
2950 Examples: >
2951 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002953 :set diffopt=internal,filler,foldcolumn:3
2954 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955<
2956 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2957'digraph' 'dg' boolean (default off)
2958 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 {not available when compiled without the |+digraphs|
2960 feature}
2961 Enable the entering of digraphs in Insert mode with {char1} <BS>
2962 {char2}. See |digraphs|.
2963 NOTE: This option is reset when 'compatible' is set.
2964
2965 *'directory'* *'dir'*
2966'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002967 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 for Unix: ".,~/tmp,/var/tmp,/tmp")
2969 global
2970 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002971 Recommended value: ".,~/vimswap//" - this will put the swap file next
2972 to the edited file if possible, and in your personal swap directory
2973 otherwise. Make sure "~/vimswap//" is only readable for you.
2974
2975 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 - The swap file will be created in the first directory where this is
2977 possible.
2978 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002979 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 - A directory "." means to put the swap file in the same directory as
2981 the edited file. On Unix, a dot is prepended to the file name, so
2982 it doesn't show in a directory listing. On MS-Windows the "hidden"
2983 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002984 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2985 the swap file relative to where the edited file is. The leading "."
2986 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002987 - For Unix and Win32, if a directory ends in two path separators "//",
2988 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002989 with all path separators replaced by percent '%' signs (including
2990 the colon following the drive letter on Win32). This will ensure
2991 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002992 On Win32, it is also possible to end with "\\". However, When a
2993 separating comma is following, you must use "//", since "\\" will
2994 include the comma in the file name. Therefore it is recommended to
2995 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 - Spaces after the comma are ignored, other spaces are considered part
2997 of the directory name. To have a space at the start of a directory
2998 name, precede it with a backslash.
2999 - To include a comma in a directory name precede it with a backslash.
3000 - A directory name may end in an ':' or '/'.
3001 - Environment variables are expanded |:set_env|.
3002 - Careful with '\' characters, type one before a space, type two to
3003 get one in the option (see |option-backslash|), for example: >
3004 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3005< - For backwards compatibility with Vim version 3.0 a '>' at the start
3006 of the option is removed.
3007 Using "." first in the list is recommended. This means that editing
3008 the same file twice will result in a warning. Using "/tmp" on Unix is
3009 discouraged: When the system crashes you lose the swap file.
3010 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003011 choice than "/tmp". But others on the computer may be able to see the
3012 files, and it can contain a lot of files, your swap files get lost in
3013 the crowd. That is why a "tmp" directory in your home directory is
3014 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 The use of |:set+=| and |:set-=| is preferred when adding or removing
3016 directories from the list. This avoids problems when a future version
3017 uses another default.
3018 This option cannot be set from a |modeline| or in the |sandbox|, for
3019 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020
3021 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003022'display' 'dy' string (default "", set to "truncate" in
3023 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003025 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 flags:
3027 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003028 in a window will be displayed. "@@@" is put in the
3029 last columns of the last screen line to indicate the
3030 rest of the line is not displayed.
3031 truncate Like "lastline", but "@@@" is displayed in the first
3032 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 uhex Show unprintable characters hexadecimal as <xx>
3034 instead of using ^C and ~C.
3035
Bram Moolenaard0796902016-09-16 20:02:31 +02003036 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003037 doesn't fit is replaced with "@" lines.
3038
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003039 The "@" character can be changed by setting the "lastline" item in
3040 'fillchars'. The character is highlighted with |hl-NonText|.
3041
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 *'eadirection'* *'ead'*
3043'eadirection' 'ead' string (default "both")
3044 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 Tells when the 'equalalways' option applies:
3046 ver vertically, width of windows is not affected
3047 hor horizontally, height of windows is not affected
3048 both width and height of windows is affected
3049
3050 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3051'edcompatible' 'ed' boolean (default off)
3052 global
3053 Makes the 'g' and 'c' flags of the ":substitute" command to be
3054 toggled each time the flag is given. See |complex-change|. See
3055 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003056 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003057 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058
Bram Moolenaar03413f42016-04-12 21:07:15 +02003059 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003060'emoji' 'emo' boolean (default: on)
3061 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003062 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003063 This excludes "text emoji" characters, which are normally displayed as
3064 single width. Unfortunately there is no good specification for this
3065 and it has been determined on trial-and-error basis. Use the
3066 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003067
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003069'encoding' 'enc' string (default for MS-Windows: "utf-8",
3070 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 Sets the character encoding used inside Vim. It applies to text in
3073 the buffers, registers, Strings in expressions, text stored in the
3074 viminfo file, etc. It sets the kind of characters which Vim can work
3075 with. See |encoding-names| for the possible values.
3076
3077 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003078 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003080 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081
Bram Moolenaar865242e2010-07-14 21:12:05 +02003082 This option cannot be set from a |modeline|. It would most likely
3083 corrupt the text.
3084
Bram Moolenaar3df01732017-02-17 22:47:16 +01003085 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3086 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 'encoding', "utf-8" is the natural choice for the environment and
3088 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003089 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 versions, and to avoid changing the encoding of newly created files
3091 without your knowledge (in case 'fileencodings' is empty).
3092
3093 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003094 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 iconv() or as specified with 'charconvert'.
3096
Bram Moolenaar207f0092020-08-30 17:20:20 +02003097 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003098 can use: >
3099 if has("multi_byte_encoding")
3100<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 Normally 'encoding' will be equal to your current locale. This will
3102 be the default if Vim recognizes your environment settings. If
3103 'encoding' is not set to the current locale, 'termencoding' must be
3104 set to convert typed and displayed text. See |encoding-table|.
3105
3106 When you set this option, it fires the |EncodingChanged| autocommand
3107 event so that you can set up fonts if necessary.
3108
3109 When the option is set, the value is converted to lowercase. Thus
3110 you can set it with uppercase values too. Underscores are translated
3111 to '-' signs.
3112 When the encoding is recognized, it is changed to the standard name.
3113 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3114 "iso-8859-2" and "utf8" becomes "utf-8".
3115
3116 Note: "latin1" is also used when the encoding could not be detected.
3117 This only works when editing files in the same encoding! When the
3118 actual character set is not latin1, make sure 'fileencoding' and
3119 'fileencodings' are empty. When conversion is needed, switch to using
3120 utf-8.
3121
3122 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3123 You don't notice this while editing, but it does matter for the
3124 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3125 setting 'encoding' to one of these values instead of utf-8 only has
3126 effect for encoding used for files when 'fileencoding' is empty.
3127
Bram Moolenaar661b1822005-07-28 22:36:45 +00003128 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3129 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003131 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003132'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003134 Indicates that a CTRL-Z character was found at the end of the file
3135 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003137 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003138 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003139 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003140
3141 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3142'endofline' 'eol' boolean (default on)
3143 local to buffer
3144 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003145 is on, or 'fixeol' option is off, no <EOL> will be written for the
3146 last line in the file. This option is automatically set or reset when
3147 starting to edit a new file, depending on whether file has an <EOL>
3148 for the last line in the file. Normally you don't have to set or
3149 reset this option.
3150 When 'binary' is off and 'fixeol' is on the value is not used when
3151 writing the file. When 'binary' is on or 'fixeol' is off it is used
3152 to remember the presence of a <EOL> for the last line in the file, so
3153 that when you write the file the situation from the original file can
3154 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003155 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156
3157 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3158'equalalways' 'ea' boolean (default on)
3159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003161 splitting or closing a window. This also happens the moment the
3162 option is switched on. When off, splitting a window will reduce the
3163 size of the current window and leave the other windows the same. When
3164 closing a window the extra lines are given to the window next to it
3165 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 When mixing vertically and horizontally split windows, a minimal size
3167 is computed and some windows may be larger if there is room. The
3168 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003169 Changing the height and width of a window can be avoided by setting
3170 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003171 If a window size is specified when creating a new window sizes are
3172 currently not equalized (it's complicated, but may be implemented in
3173 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174
3175 *'equalprg'* *'ep'*
3176'equalprg' 'ep' string (default "")
3177 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003179 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003180 or 'indentexpr'. When Vim was compiled without internal formatting,
3181 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003182 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 about including spaces and backslashes.
3184 This option cannot be set from a |modeline| or in the |sandbox|, for
3185 security reasons.
3186
3187 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3188'errorbells' 'eb' boolean (default off)
3189 global
3190 Ring the bell (beep or screen flash) for error messages. This only
3191 makes a difference for error messages, the bell will be used always
3192 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003193 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003194 screen flash or do nothing. See 'belloff' to finetune when to ring the
3195 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196
3197 *'errorfile'* *'ef'*
3198'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3199 others: "errors.err")
3200 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 {not available when compiled without the |+quickfix|
3202 feature}
3203 Name of the errorfile for the QuickFix mode (see |:cf|).
3204 When the "-q" command-line argument is used, 'errorfile' is set to the
3205 following argument. See |-q|.
3206 NOT used for the ":make" command. See 'makeef' for that.
3207 Environment variables are expanded |:set_env|.
3208 See |option-backslash| about including spaces and backslashes.
3209 This option cannot be set from a |modeline| or in the |sandbox|, for
3210 security reasons.
3211
3212 *'errorformat'* *'efm'*
3213'errorformat' 'efm' string (default is very long)
3214 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 {not available when compiled without the |+quickfix|
3216 feature}
3217 Scanf-like description of the format for the lines in the error file
3218 (see |errorformat|).
3219
3220 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3221'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 Function keys that start with an <Esc> are recognized in Insert
3224 mode. When this option is off, the cursor and function keys cannot be
3225 used in Insert mode if they start with an <Esc>. The advantage of
3226 this is that the single <Esc> is recognized immediately, instead of
3227 after one second. Instead of resetting this option, you might want to
3228 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3229 when 'esckeys' is off, you can still map anything, but the cursor keys
3230 won't work by default.
3231 NOTE: This option is set to the Vi default value when 'compatible' is
3232 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003233 NOTE: when this option is off then the |modifyOtherKeys| and
3234 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3235 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236
3237 *'eventignore'* *'ei'*
3238'eventignore' 'ei' string (default "")
3239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003241 When set to "all" or when "all" is one of the items, all autocommand
3242 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003243 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 :set ei=WinEnter,WinLeave
3245<
3246 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3247'expandtab' 'et' boolean (default off)
3248 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003250 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3252 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003253 This option is reset when the 'paste' option is set and restored when
3254 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 NOTE: This option is reset when 'compatible' is set.
3256
3257 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3258'exrc' 'ex' boolean (default off)
3259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003261 directory.
3262
3263 Setting this option is a potential security leak. E.g., consider
3264 unpacking a package or fetching files from github, a .vimrc in there
3265 might be a trojan horse. BETTER NOT SET THIS OPTION!
3266 Instead, define an autocommand in your .vimrc to set options for a
3267 matching directory.
3268
3269 If you do switch this option on you should also consider setting the
3270 'secure' option (see |initialization|).
3271 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 This option cannot be set from a |modeline| or in the |sandbox|, for
3273 security reasons.
3274
3275 *'fileencoding'* *'fenc'* *E213*
3276'fileencoding' 'fenc' string (default: "")
3277 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003279
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003281 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 When 'fileencoding' is empty, the same value as 'encoding' will be
3283 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003284 No error will be given when the value is set, only when it is used,
3285 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003286 Conversion will also be done when 'encoding' and 'fileencoding' are
3287 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3288 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003290 'encoding' is "utf-8" or another Unicode encoding, conversion
3291 is most likely done in a way that the reverse conversion
3292 results in the same text. When 'encoding' is not "utf-8" some
3293 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003294
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 See 'encoding' for the possible values. Additionally, values may be
3296 specified that can be handled by the converter, see
3297 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003298
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 When reading a file 'fileencoding' will be set from 'fileencodings'.
3300 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003301 'fileencoding', use the |++enc| argument. One exception: when
3302 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003303 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003304
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3306 When the option is set, the value is converted to lowercase. Thus
3307 you can set it with uppercase values too. '_' characters are
3308 replaced with '-'. If a name is recognized from the list for
3309 'encoding', it is replaced by the standard name. For example
3310 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003311
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 When this option is set, after starting to edit a file, the 'modified'
3313 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003314
3315 Keep in mind that changing 'fenc' from a modeline happens
3316 AFTER the text has been read, thus it applies to when the file will be
3317 written. If you do set 'fenc' in a modeline, you might want to set
3318 'nomodified' to avoid not being able to ":q".
3319
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 This option can not be changed when 'modifiable' is off.
3321
3322 *'fe'*
3323 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003324 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 old short name was 'fe', which is no longer used.
3326
3327 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003328'fileencodings' 'fencs' string (default: "ucs-bom",
3329 "ucs-bom,utf-8,default,latin1" when
3330 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 This is a list of character encodings considered when starting to edit
3333 an existing file. When a file is read, Vim tries to use the first
3334 mentioned character encoding. If an error is detected, the next one
3335 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003336 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 an empty string, which means the value of 'encoding' is used.
3338 WARNING: Conversion can cause loss of information! When
3339 'encoding' is "utf-8" (or one of the other Unicode variants)
3340 conversion is most likely done in a way that the reverse
3341 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003342 "utf-8" some non-ASCII characters may be lost! You can use
3343 the |++bad| argument to specify what is done with characters
3344 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 For an empty file or a file with only ASCII characters most encodings
3346 will work and the first entry of 'fileencodings' will be used (except
3347 "ucs-bom", which requires the BOM to be present). If you prefer
3348 another encoding use an BufReadPost autocommand event to test if your
3349 preferred encoding is to be used. Example: >
3350 au BufReadPost * if search('\S', 'w') == 0 |
3351 \ set fenc=iso-2022-jp | endif
3352< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3353 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003354 When the |++enc| argument is used then the value of 'fileencodings' is
3355 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003356 Note that 'fileencodings' is not used for a new file, the global value
3357 of 'fileencoding' is used instead. You can set it with: >
3358 :setglobal fenc=iso-8859-2
3359< This means that a non-existing file may get a different encoding than
3360 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 The special value "ucs-bom" can be used to check for a Unicode BOM
3362 (Byte Order Mark) at the start of the file. It must not be preceded
3363 by "utf-8" or another Unicode encoding for this to work properly.
3364 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3365 because Vim cannot detect an error, thus the encoding is always
3366 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003367 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003368 environment. On MS-Windows this is the system encoding. Otherwise
3369 this is the default value for 'encoding'. It is useful when
3370 'encoding' is set to "utf-8" and your environment uses a non-latin1
3371 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003372 When 'encoding' is "utf-8" and a file contains an illegal byte
3373 sequence it won't be recognized as UTF-8. You can use the |8g8|
3374 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 WRONG VALUES: WHAT'S WRONG:
3376 latin1,utf-8 "latin1" will always be used
3377 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3378 file
3379 cp1250,latin1 "cp1250" will always be used
3380 If 'fileencodings' is empty, 'fileencoding' is not modified.
3381 See 'fileencoding' for the possible values.
3382 Setting this option does not have an effect until the next time a file
3383 is read.
3384
3385 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003386'fileformat' 'ff' string (MS-Windows default: "dos",
3387 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 This gives the <EOL> of the current buffer, which is used for
3390 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003391 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 unix <NL>
3393 mac <CR>
3394 When "dos" is used, CTRL-Z at the end of a file is ignored.
3395 See |file-formats| and |file-read|.
3396 For the character encoding of the file see 'fileencoding'.
3397 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003398 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 This option is set automatically when starting to edit a file and
3400 'fileformats' is not empty and 'binary' is off.
3401 When this option is set, after starting to edit a file, the 'modified'
3402 option is set, because the file would be different when written.
3403 This option can not be changed when 'modifiable' is off.
3404 For backwards compatibility: When this option is set to "dos",
3405 'textmode' is set, otherwise 'textmode' is reset.
3406
3407 *'fileformats'* *'ffs'*
3408'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003409 Vim+Vi MS-Windows: "dos,unix",
3410 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 Vi Cygwin: "unix,dos",
3412 Vi others: "")
3413 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 This gives the end-of-line (<EOL>) formats that will be tried when
3415 starting to edit a new buffer and when reading a file into an existing
3416 buffer:
3417 - When empty, the format defined with 'fileformat' will be used
3418 always. It is not set automatically.
3419 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003420 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 'fileformats' name will be used when a file is read into an existing
3422 buffer, no matter what 'fileformat' for that buffer is set to.
3423 - When more than one name is present, separated by commas, automatic
3424 <EOL> detection will be done when reading a file. When starting to
3425 edit a file, a check is done for the <EOL>:
3426 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3427 'fileformat' is set to "dos".
3428 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003429 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003431 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3432 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003433 This means that "mac" is only chosen when:
3434 "unix" is not present or no <NL> is found in the file, and
3435 "dos" is not present or no <CR><NL> is found in the file.
3436 Except: if "unix" was chosen, but there is a <CR> before
3437 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003438 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 4. If 'fileformat' is still not set, the first name from
3440 'fileformats' is used.
3441 When reading a file into an existing buffer, the same is done, but
3442 this happens like 'fileformat' has been set appropriately for that
3443 file only, the option is not changed.
3444 When 'binary' is set, the value of 'fileformats' is not used.
3445
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003446 When Vim starts up with an empty buffer the first item is used. You
3447 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003448
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3450 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3451 done:
3452 - When 'fileformats' is empty, there is no automatic detection. Dos
3453 format will be used.
3454 - When 'fileformats' is set to one or more names, automatic detection
3455 is done. This is based on the first <NL> in the file: If there is a
3456 <CR> in front of it, Dos format is used, otherwise Unix format is
3457 used.
3458 Also see |file-formats|.
3459 For backwards compatibility: When this option is set to an empty
3460 string or one format (no comma is included), 'textauto' is reset,
3461 otherwise 'textauto' is set.
3462 NOTE: This option is set to the Vi default value when 'compatible' is
3463 set and to the Vim default value when 'compatible' is reset.
3464
Bram Moolenaarbf884932013-04-05 22:26:15 +02003465 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3466'fileignorecase' 'fic' boolean (default on for systems where case in file
3467 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003468 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003469 When set case is ignored when using file names and directories.
3470 See 'wildignorecase' for only ignoring case when doing completion.
3471
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 *'filetype'* *'ft'*
3473'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003474 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 When this option is set, the FileType autocommand event is triggered.
3476 All autocommands that match with the value of this option will be
3477 executed. Thus the value of 'filetype' is used in place of the file
3478 name.
3479 Otherwise this option does not always reflect the current file type.
3480 This option is normally set when the file type is detected. To enable
3481 this use the ":filetype on" command. |:filetype|
3482 Setting this option to a different value is most useful in a modeline,
3483 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003484 Example, for in an IDL file:
3485 /* vim: set filetype=idl : */ ~
3486 |FileType| |filetypes|
3487 When a dot appears in the value then this separates two filetype
3488 names. Example:
3489 /* vim: set filetype=c.doxygen : */ ~
3490 This will use the "c" filetype first, then the "doxygen" filetype.
3491 This works both for filetype plugins and for syntax files. More than
3492 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 This option is not copied to another buffer, independent of the 's' or
3494 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003495 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496
3497 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003498'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003499 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003500 Characters to fill the statuslines, vertical separators and special
3501 lines in the window.
3502 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003503 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003505 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003506 stl ' ' statusline of the current window
3507 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003508 vert '|' vertical separators |:vsplit|
3509 fold '-' filling 'foldtext'
3510 foldopen '-' mark the beginning of a fold
3511 foldclose '+' show a closed fold
3512 foldsep '|' open fold middle character
3513 diff '-' deleted lines of the 'diff' option
3514 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003515 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003517 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518
3519 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003520 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3521<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003522 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3523 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003524 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003525
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003527 item name highlight group ~
3528 stl StatusLine |hl-StatusLine|
3529 stlnc StatusLineNC |hl-StatusLineNC|
3530 vert VertSplit |hl-VertSplit|
3531 fold Folded |hl-Folded|
3532 diff DiffDelete |hl-DiffDelete|
3533 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003534 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003536 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3537'fixendofline' 'fixeol' boolean (default on)
3538 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003539 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003540 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003541 preserve the situation from the original file.
3542 When the 'binary' option is set the value of this option doesn't
3543 matter.
3544 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003545 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003546
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003548'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 {only available when compiled with the |+rightleft|
3551 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003552 This option was for using Farsi, which has been removed. See
3553 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
3555 *'foldclose'* *'fcl'*
3556'foldclose' 'fcl' string (default "")
3557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 {not available when compiled without the |+folding|
3559 feature}
3560 When set to "all", a fold is closed when the cursor isn't in it and
3561 its level is higher than 'foldlevel'. Useful if you want folds to
3562 automatically close when moving out of them.
3563
3564 *'foldcolumn'* *'fdc'*
3565'foldcolumn' 'fdc' number (default 0)
3566 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 {not available when compiled without the |+folding|
3568 feature}
3569 When non-zero, a column with the specified width is shown at the side
3570 of the window which indicates open and closed folds. The maximum
3571 value is 12.
3572 See |folding|.
3573
3574 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3575'foldenable' 'fen' boolean (default on)
3576 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 {not available when compiled without the |+folding|
3578 feature}
3579 When off, all folds are open. This option can be used to quickly
3580 switch between showing all text unfolded and viewing the text with
3581 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003582 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 'foldenable' is off.
3584 This option is set by commands that create a new fold or close a fold.
3585 See |folding|.
3586
3587 *'foldexpr'* *'fde'*
3588'foldexpr' 'fde' string (default: "0")
3589 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003591 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003593 for each line to obtain its fold level. The context is set to the
3594 script where 'foldexpr' was set, script-local items can be accessed.
3595 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003596
Bram Moolenaar30b65812012-07-12 22:01:11 +02003597 The expression will be evaluated in the |sandbox| if set from a
3598 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003599 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003600 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003601
3602 It is not allowed to change text or jump to another window while
3603 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604
3605 *'foldignore'* *'fdi'*
3606'foldignore' 'fdi' string (default: "#")
3607 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 {not available when compiled without the |+folding|
3609 feature}
3610 Used only when 'foldmethod' is "indent". Lines starting with
3611 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003612 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 The default "#" works well for C programs. See |fold-indent|.
3614
3615 *'foldlevel'* *'fdl'*
3616'foldlevel' 'fdl' number (default: 0)
3617 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 {not available when compiled without the |+folding|
3619 feature}
3620 Sets the fold level: Folds with a higher level will be closed.
3621 Setting this option to zero will close all folds. Higher numbers will
3622 close fewer folds.
3623 This option is set by commands like |zm|, |zM| and |zR|.
3624 See |fold-foldlevel|.
3625
3626 *'foldlevelstart'* *'fdls'*
3627'foldlevelstart' 'fdls' number (default: -1)
3628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 {not available when compiled without the |+folding|
3630 feature}
3631 Sets 'foldlevel' when starting to edit another buffer in a window.
3632 Useful to always start editing with all folds closed (value zero),
3633 some folds closed (one) or no folds closed (99).
3634 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003635 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 ignores this option and closes all folds.
3637 It is also done before BufReadPre autocommands, to allow an autocmd to
3638 overrule the 'foldlevel' value for specific files.
3639 When the value is negative, it is not used.
3640
3641 *'foldmarker'* *'fmr'* *E536*
3642'foldmarker' 'fmr' string (default: "{{{,}}}")
3643 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 {not available when compiled without the |+folding|
3645 feature}
3646 The start and end marker used when 'foldmethod' is "marker". There
3647 must be one comma, which separates the start and end marker. The
3648 marker is a literal string (a regular expression would be too slow).
3649 See |fold-marker|.
3650
3651 *'foldmethod'* *'fdm'*
3652'foldmethod' 'fdm' string (default: "manual")
3653 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 {not available when compiled without the |+folding|
3655 feature}
3656 The kind of folding used for the current window. Possible values:
3657 |fold-manual| manual Folds are created manually.
3658 |fold-indent| indent Lines with equal indent form a fold.
3659 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3660 |fold-marker| marker Markers are used to specify folds.
3661 |fold-syntax| syntax Syntax highlighting items specify folds.
3662 |fold-diff| diff Fold text that is not changed.
3663
3664 *'foldminlines'* *'fml'*
3665'foldminlines' 'fml' number (default: 1)
3666 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 {not available when compiled without the |+folding|
3668 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003669 Sets the number of screen lines above which a fold can be displayed
3670 closed. Also for manually closed folds. With the default value of
3671 one a fold can only be closed if it takes up two or more screen lines.
3672 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003673 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 "zc" to close a fold, which is displayed open because it's smaller
3675 than 'foldminlines', a following "zc" may close a containing fold.
3676
3677 *'foldnestmax'* *'fdn'*
3678'foldnestmax' 'fdn' number (default: 20)
3679 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 {not available when compiled without the |+folding|
3681 feature}
3682 Sets the maximum nesting of folds for the "indent" and "syntax"
3683 methods. This avoids that too many folds will be created. Using more
3684 than 20 doesn't work, because the internal limit is 20.
3685
3686 *'foldopen'* *'fdo'*
3687'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3688 search,tag,undo")
3689 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 {not available when compiled without the |+folding|
3691 feature}
3692 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003693 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003695 NOTE: When the command is part of a mapping this option is not used.
3696 Add the |zv| command to the mapping to get the same effect.
3697 (rationale: the mapping may want to control opening folds itself)
3698
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 item commands ~
3700 all any
3701 block "(", "{", "[[", "[{", etc.
3702 hor horizontal movements: "l", "w", "fx", etc.
3703 insert any command in Insert mode
3704 jump far jumps: "G", "gg", etc.
3705 mark jumping to a mark: "'m", CTRL-O, etc.
3706 percent "%"
3707 quickfix ":cn", ":crew", ":make", etc.
3708 search search for a pattern: "/", "n", "*", "gd", etc.
3709 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003710 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 tag jumping to a tag: ":ta", CTRL-T, etc.
3712 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 When a movement command is used for an operator (e.g., "dl" or "y%")
3714 this option is not used. This means the operator will include the
3715 whole closed fold.
3716 Note that vertical movements are not here, because it would make it
3717 very difficult to move onto a closed fold.
3718 In insert mode the folds containing the cursor will always be open
3719 when text is inserted.
3720 To close folds you can re-apply 'foldlevel' with the |zx| command or
3721 set the 'foldclose' option to "all".
3722
3723 *'foldtext'* *'fdt'*
3724'foldtext' 'fdt' string (default: "foldtext()")
3725 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 {not available when compiled without the |+folding|
3727 feature}
3728 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003729 fold. The context is set to the script where 'foldexpr' was set,
3730 script-local items can be accessed. See |fold-foldtext| for the
3731 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732
Bram Moolenaar30b65812012-07-12 22:01:11 +02003733 The expression will be evaluated in the |sandbox| if set from a
3734 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003735 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003736
3737 It is not allowed to change text or jump to another window while
3738 evaluating 'foldtext' |textlock|.
3739
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003740 *'formatexpr'* *'fex'*
3741'formatexpr' 'fex' string (default "")
3742 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003743 {not available when compiled without the |+eval|
3744 feature}
3745 Expression which is evaluated to format a range of lines for the |gq|
3746 operator or automatic formatting (see 'formatoptions'). When this
3747 option is empty 'formatprg' is used.
3748
3749 The |v:lnum| variable holds the first line to be formatted.
3750 The |v:count| variable holds the number of lines to be formatted.
3751 The |v:char| variable holds the character that is going to be
3752 inserted if the expression is being evaluated due to
3753 automatic formatting. This can be empty. Don't insert
3754 it yet!
3755
3756 Example: >
3757 :set formatexpr=mylang#Format()
3758< This will invoke the mylang#Format() function in the
3759 autoload/mylang.vim file in 'runtimepath'. |autoload|
3760
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003761 The advantage of using a function call without arguments is that it is
3762 faster, see |expr-option-function|.
3763
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003764 The expression is also evaluated when 'textwidth' is set and adding
3765 text beyond that limit. This happens under the same conditions as
3766 when internal formatting is used. Make sure the cursor is kept in the
3767 same spot relative to the text then! The |mode()| function will
3768 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003769
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003770 When the expression evaluates to non-zero Vim will fall back to using
3771 the internal format mechanism.
3772
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003773 If the expression starts with s: or |<SID>|, then it is replaced with
3774 the script ID (|local-function|). Example: >
3775 set formatexpr=s:MyFormatExpr()
3776 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003777< Otherwise, the expression is evaluated in the context of the script
3778 where the option was set, thus script-local items are available.
3779
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003780 The expression will be evaluated in the |sandbox| when set from a
3781 modeline, see |sandbox-option|. That stops the option from working,
3782 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003783 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003784 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003785
Bram Moolenaar86b68352004-12-27 21:59:20 +00003786 *'formatlistpat'* *'flp'*
3787'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3788 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003789 A pattern that is used to recognize a list header. This is used for
3790 the "n" flag in 'formatoptions'.
3791 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003792 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003793 while still checking more characters. There must be a character
3794 following the pattern, when it matches the whole line it is handled
3795 like there is no match.
3796 The default recognizes a number, followed by an optional punctuation
3797 character and white space.
3798
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003799 *'formatoptions'* *'fo'*
3800'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3801 local to buffer
3802 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003803 formatting is to be done.
3804 See |fo-table| for possible values and |gq| for how to format text.
3805 When the 'paste' option is on, no formatting is done (like
3806 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003807 To avoid problems with flags that are added in the future, use the
3808 "+=" and "-=" feature of ":set" |add-option-flags|.
3809 NOTE: This option is set to the Vi default value when 'compatible' is
3810 set and to the Vim default value when 'compatible' is reset.
3811
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 *'formatprg'* *'fp'*
3813'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003814 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003816 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003818 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003819 If the 'formatexpr' option is not empty it will be used instead.
3820 Otherwise, if 'formatprg' option is an empty string, the internal
3821 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003822 Environment variables are expanded |:set_env|. See |option-backslash|
3823 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003824 This option cannot be set from a |modeline| or in the |sandbox|, for
3825 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826
Bram Moolenaard94464e2015-11-02 15:28:18 +01003827 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003828'fsync' 'fs' boolean (default on)
3829 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003830 When on, the library function fsync() will be called after writing a
3831 file. This will flush a file to disk, ensuring that it is safely
3832 written even on filesystems which do metadata-only journaling. This
3833 will force the harddrive to spin up on Linux systems running in laptop
3834 mode, so it may be undesirable in some situations. Be warned that
3835 turning this off increases the chances of data loss after a crash. On
3836 systems without an fsync() implementation, this variable is always
3837 off.
3838 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003839 'fsync' also applies to |writefile()| (unless a flag is used to
3840 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003841 This option cannot be set from a |modeline| or in the |sandbox|, for
3842 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003843
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3845'gdefault' 'gd' boolean (default off)
3846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 When on, the ":substitute" flag 'g' is default on. This means that
3848 all matches in a line are substituted instead of one. When a 'g' flag
3849 is given to a ":substitute" command, this will toggle the substitution
3850 of all or one match. See |complex-change|.
3851
3852 command 'gdefault' on 'gdefault' off ~
3853 :s/// subst. all subst. one
3854 :s///g subst. one subst. all
3855 :s///gg subst. all subst. one
3856
3857 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003858 Setting this option may break plugins that rely on the default
3859 behavior of the 'g' flag. This will also make the 'g' flag have the
3860 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003861 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862
3863 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003864'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 Format to recognize for the ":grep" command output.
3867 This is a scanf-like string that uses the same format as the
3868 'errorformat' option: see |errorformat|.
3869
3870 *'grepprg'* *'gp'*
3871'grepprg' 'gp' string (default "grep -n ",
3872 Unix: "grep -n $* /dev/null",
3873 Win32: "findstr /n" or "grep -n",
3874 VMS: "SEARCH/NUMBERS ")
3875 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003876 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 and '#' characters, which are expanded like when used in a command-
3878 line. The placeholder "$*" is allowed to specify where the arguments
3879 will be included. Environment variables are expanded |:set_env|. See
3880 |option-backslash| about including spaces and backslashes.
3881 When your "grep" accepts the "-H" argument, use this to make ":grep"
3882 also work well with a single file: >
3883 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003884< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003885 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3886 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003887 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 apply equally to 'grepprg'.
3889 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3890 otherwise it's "grep -n".
3891 This option cannot be set from a |modeline| or in the |sandbox|, for
3892 security reasons.
3893
3894 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3895'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3896 ve:ver35-Cursor,
3897 o:hor50-Cursor,
3898 i-ci:ver25-Cursor/lCursor,
3899 r-cr:hor20-Cursor/lCursor,
3900 sm:block-Cursor
3901 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003902 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 "n-v-c:block,o:hor50,i-ci:hor15,
3904 r-cr:hor30,sm:block")
3905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003907 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003909 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003910 height of the cursor can be changed. This can be done by specifying a
3911 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003912 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3913 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003915 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 mode-list and an argument-list:
3917 mode-list:argument-list,mode-list:argument-list,..
3918 The mode-list is a dash separated list of these modes:
3919 n Normal mode
3920 v Visual mode
3921 ve Visual mode with 'selection' "exclusive" (same as 'v',
3922 if not specified)
3923 o Operator-pending mode
3924 i Insert mode
3925 r Replace mode
3926 c Command-line Normal (append) mode
3927 ci Command-line Insert mode
3928 cr Command-line Replace mode
3929 sm showmatch in Insert mode
3930 a all modes
3931 The argument-list is a dash separated list of these arguments:
3932 hor{N} horizontal bar, {N} percent of the character height
3933 ver{N} vertical bar, {N} percent of the character width
3934 block block cursor, fills the whole character
3935 [only one of the above three should be present]
3936 blinkwait{N} *cursor-blinking*
3937 blinkon{N}
3938 blinkoff{N}
3939 blink times for cursor: blinkwait is the delay before
3940 the cursor starts blinking, blinkon is the time that
3941 the cursor is shown and blinkoff is the time that the
3942 cursor is not shown. The times are in msec. When one
3943 of the numbers is zero, there is no blinking. The
3944 default is: "blinkwait700-blinkon400-blinkoff250".
3945 These numbers are used for a missing entry. This
3946 means that blinking is enabled by default. To switch
3947 blinking off you can use "blinkon0". The cursor only
3948 blinks when Vim is waiting for input, not while
3949 executing a command.
3950 To make the cursor blink in an xterm, see
3951 |xterm-blink|.
3952 {group-name}
3953 a highlight group name, that sets the color and font
3954 for the cursor
3955 {group-name}/{group-name}
3956 Two highlight group names, the first is used when
3957 no language mappings are used, the other when they
3958 are. |language-mapping|
3959
3960 Examples of parts:
3961 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3962 block cursor with colors from the "nCursor"
3963 highlight group
3964 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3965 In Insert and Command-line Insert mode, use a
3966 30% vertical bar cursor with colors from the
3967 "iCursor" highlight group. Blink a bit
3968 faster.
3969
3970 The 'a' mode is different. It will set the given argument-list for
3971 all modes. It does not reset anything to defaults. This can be used
3972 to do a common setting for all modes. For example, to switch off
3973 blinking: "a:blinkon0"
3974
3975 Examples of cursor highlighting: >
3976 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3977 :highlight Cursor gui=NONE guifg=bg guibg=fg
3978<
3979 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003980 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981'guifont' 'gfn' string (default "")
3982 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 {only available when compiled with GUI enabled}
3984 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003985 In its simplest form the value is just one font name.
3986 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987
3988 *'guifontset'* *'gfs'*
3989 *E250* *E252* *E234* *E597* *E598*
3990'guifontset' 'gfs' string (default "")
3991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 {only available when compiled with GUI enabled and
3993 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003994 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 When not empty, specifies two (or more) fonts to be used. The first
3996 one for normal English, the second one for your special language. See
3997 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003998
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4000'guifontwide' 'gfw' string (default "")
4001 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 {only available when compiled with GUI enabled}
4003 When not empty, specifies a comma-separated list of fonts to be used
4004 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004005 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004006
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 *'guiheadroom'* *'ghr'*
4008'guiheadroom' 'ghr' number (default 50)
4009 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004010 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 The number of pixels subtracted from the screen height when fitting
4012 the GUI window on the screen. Set this before the GUI is started,
4013 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004014 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 lines will be left for window decorations and other items on the
4016 screen. Set it to a negative value to allow windows taller than the
4017 screen.
4018
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004019 *'guiligatures'* *'gli'* *E1243*
4020'guiligatures' 'gli' string (default "")
4021 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004022 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004023 List of ASCII characters that, when combined together, can create more
4024 complex shapes. Each character must be a printable ASCII character
4025 with a value in the 32-127 range.
4026 Example: >
4027 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4028< Changing this option updates screen output immediately. Set it to an
4029 empty string to disable ligatures.
4030
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004032'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4033 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004034 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004035 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004038 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 sequence of letters which describes what components and options of the
4040 GUI should be used.
4041 To avoid problems with flags that are added in the future, use the
4042 "+=" and "-=" feature of ":set" |add-option-flags|.
4043
Bram Moolenaar13568252018-03-16 20:46:58 +01004044 Valid characters are as follows:
4045 *'go-!'*
4046 '!' External commands are executed in a terminal window. Without
4047 this flag the MS-Windows GUI will open a console window to
4048 execute the command. The Unix GUI will simulate a dumb
4049 terminal to list the command output.
4050 The terminal window will be positioned at the bottom, and grow
4051 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004052 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 'a' Autoselect: If present, then whenever VISUAL mode is started,
4054 or the Visual area extended, Vim tries to become the owner of
4055 the windowing system's global selection. This means that the
4056 Visually highlighted text is available for pasting into other
4057 applications as well as into Vim itself. When the Visual mode
4058 ends, possibly due to an operation on the text, or when an
4059 application wants to paste the selection, the highlighted text
4060 is automatically yanked into the "* selection register.
4061 Thus the selection is still available for pasting into other
4062 applications after the VISUAL mode has ended.
4063 If not present, then Vim won't become the owner of the
4064 windowing system's global selection unless explicitly told to
4065 by a yank or delete operation for the "* register.
4066 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004067 *'go-P'*
4068 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004069 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004070 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004071 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 applies to the modeless selection.
4073
4074 'guioptions' autoselect Visual autoselect modeless ~
4075 "" - -
4076 "a" yes yes
4077 "A" - yes
4078 "aA" yes yes
4079
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004080 When using a terminal see the 'clipboard' option.
4081
Bram Moolenaar02467872007-05-06 13:22:01 +00004082 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 'c' Use console dialogs instead of popup dialogs for simple
4084 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004085 *'go-d'*
4086 'd' Use dark theme variant if available. Currently only works for
4087 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004088 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004089 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004090 'guitablabel' can be used to change the text in the labels.
4091 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004092 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004093 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004094 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 'f' Foreground: Don't use fork() to detach the GUI from the shell
4096 where it was started. Use this for programs that wait for the
4097 editor to finish (e.g., an e-mail program). Alternatively you
4098 can use "gvim -f" or ":gui -f" to start the GUI in the
4099 foreground. |gui-fork|
4100 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004101 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004102 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4104 corner of the window. It's black&white on non-GTK, because of
4105 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004106 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004108 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004109 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004111 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004113 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004114 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 'g' Grey menu items: Make menu items that are not active grey. If
4116 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004117 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 't' Include tearoff menu items. Currently only works for Win32,
4119 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004120 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004121 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4122 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004123 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004125 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 'R' Right-hand scrollbar is present when there is a vertically
4127 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004128 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004130 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 'L' Left-hand scrollbar is present when there is a vertically
4132 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004133 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4135 the longest visible line, or on the cursor line if the 'h'
4136 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004137 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 'h' Limit horizontal scrollbar size to the length of the cursor
4139 line. Reduces computations. |gui-horiz-scroll|
4140
4141 And yes, you may even have scrollbars on the left AND the right if
4142 you really want to :-). See |gui-scrollbars| for more information.
4143
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004144 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 'v' Use a vertical button layout for dialogs. When not included,
4146 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004147 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004148 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 'p' Use Pointer callbacks for X11 GUI. This is required for some
4150 window managers. If the cursor is not blinking or hollow at
4151 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004152 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004154 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004155 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004156 *'go-k'*
4157 'k' Keep the GUI window size when adding/removing a scrollbar, or
4158 toolbar, tabline, etc. Instead, the behavior is similar to
4159 when the window is maximized and will adjust 'lines' and
4160 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004161 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004162 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004163
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 *'guipty'* *'noguipty'*
4165'guipty' boolean (default on)
4166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 {only available when compiled with GUI enabled}
4168 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4169 I/O to/from shell commands. See |gui-pty|.
4170
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004171 *'guitablabel'* *'gtl'*
4172'guitablabel' 'gtl' string (default empty)
4173 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004174 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004175 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004176 pages line. When empty and when the result is empty Vim will use a
4177 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004178
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004179 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004180 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004181 The expression will be evaluated in the |sandbox| when set from a
4182 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004183 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004184
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004185 Only used when the GUI tab pages line is displayed. 'e' must be
4186 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4187 used.
4188
Bram Moolenaar57657d82006-04-21 22:12:41 +00004189 *'guitabtooltip'* *'gtt'*
4190'guitabtooltip' 'gtt' string (default empty)
4191 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004192 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004193 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004194 pages line. When empty Vim will use a default tooltip.
4195 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004196 You can include a line break. Simplest method is to use |:let|: >
4197 :let &guitabtooltip = "line one\nline two"
4198<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004199
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004201'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 (others) "$VIMRUNTIME/doc/help.txt")
4203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 Name of the main help file. All distributed help files should be
4205 placed together in one directory. Additionally, all "doc" directories
4206 in 'runtimepath' will be used.
4207 Environment variables are expanded |:set_env|. For example:
4208 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004209 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 spaces and backslashes.
4211 This option cannot be set from a |modeline| or in the |sandbox|, for
4212 security reasons.
4213
4214 *'helpheight'* *'hh'*
4215'helpheight' 'hh' number (default 20)
4216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 Minimal initial height of the help window when it is opened with the
4218 ":help" command. The initial height of the help window is half of the
4219 current window, or (when the 'ea' option is on) the same as other
4220 windows. When the height is less than 'helpheight', the height is
4221 set to 'helpheight'. Set to zero to disable.
4222
4223 *'helplang'* *'hlg'*
4224'helplang' 'hlg' string (default: messages language or empty)
4225 global
4226 {only available when compiled with the |+multi_lang|
4227 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004228 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 for which the desired help can be found. The English help will always
4230 be used as a last resort. You can add "en" to prefer English over
4231 another language, but that will only find tags that exist in that
4232 language and not in the English help.
4233 Example: >
4234 :set helplang=de,it
4235< This will first search German, then Italian and finally English help
4236 files.
4237 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4238 try to find the tag in the current language before using this option.
4239 See |help-translated|.
4240
4241 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4242'hidden' 'hid' boolean (default off)
4243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 When off a buffer is unloaded when it is |abandon|ed. When on a
4245 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4246 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004247
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004249 hidden even if the 'hidden' option is off when these three are true:
4250 - the buffer is modified
4251 - 'autowrite' is off or writing is not possible
4252 - the '!' flag was used
4253 Also see |windows.txt|.
4254
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004255 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 This option is set for one command with ":hide {command}" |:hide|.
4257 WARNING: It's easy to forget that you have changes in hidden buffers.
4258 Think twice when using ":q!" or ":qa!".
4259
4260 *'highlight'* *'hl'*
4261'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004262 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4263 d:Directory,e:ErrorMsg,i:IncSearch,
4264 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004265 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004266 N:CursorLineNr,r:Question,s:StatusLine,
4267 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004268 v:Visual,V:VisualNOS,w:WarningMsg,
4269 W:WildMenu,f:Folded,F:FoldColumn,
4270 A:DiffAdd,C:DiffChange,D:DiffDelete,
4271 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004272 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004273 L:SpellLocal,+:Pmenu,=:PmenuSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004274 [:PmenuKind,]:PmenuKindSel,
4275 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004276 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4277 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004278 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004279 z:StatusLineTerm,Z:StatusLineTermNC,
4280 g:MsgArea")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004283 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004285 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004287 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4288 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 characters from 'showbreak'
4290 |hl-Directory| d directories in CTRL-D listing and other special
4291 things in listings
4292 |hl-ErrorMsg| e error messages
4293 h (obsolete, ignored)
4294 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004295 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4297 |hl-MoreMsg| m |more-prompt|
4298 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004299 |hl-MsgArea| g |Command-line| and message area
Bram Moolenaar64486672010-05-16 15:46:46 +02004300 |hl-LineNr| n line number for ":number" and ":#" commands, and
4301 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004302 |hl-LineNrAbove| a line number above the cursor for when the
4303 'relativenumber' option is set.
4304 |hl-LineNrBelow| b line number below the cursor for when the
4305 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004306 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4307 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 |hl-Question| r |hit-enter| prompt and yes/no questions
4309 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004310 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4312 |hl-VertSplit| c column used to separate vertically split windows
4313 |hl-Visual| v Visual mode
4314 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4315 Selection" Only X11 Gui's |gui-x11| and
4316 |xterm-clipboard|.
4317 |hl-WarningMsg| w warning messages
4318 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4319 |hl-Folded| f line used for closed folds
4320 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004321 |hl-DiffAdd| A added line in diff mode
4322 |hl-DiffChange| C changed line in diff mode
4323 |hl-DiffDelete| D deleted line in diff mode
4324 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004326 |hl-Conceal| - the placeholders used for concealed characters
4327 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004328 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004329 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004330 |hl-SpellRare| R rare word |spell|
4331 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004332 |hl-Pmenu| + popup menu normal line
4333 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004334 |hl-PmenuKind| [ popup menu "kind" normal line
4335 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004336 |hl-PmenuExtra| { popup menu "extra" normal line
4337 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004338 |hl-PmenuSbar| x popup menu scrollbar
4339 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340
4341 The display modes are:
4342 r reverse (termcap entry "mr" and "me")
4343 i italic (termcap entry "ZH" and "ZR")
4344 b bold (termcap entry "md" and "me")
4345 s standout (termcap entry "so" and "se")
4346 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004347 c undercurl (termcap entry "Us" and "Ce")
4348 2 double underline (termcap entry "Ds" and "Ce")
4349 d dotted underline (termcap entry "ds" and "Ce")
4350 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004351 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 n no highlighting
4353 - no highlighting
4354 : use a highlight group
4355 The default is used for occasions that are not included.
4356 If you want to change what the display modes do, see |dos-colors|
4357 for an example.
4358 When using the ':' display mode, this must be followed by the name of
4359 a highlight group. A highlight group can be used to define any type
4360 of highlighting, including using color. See |:highlight| on how to
4361 define one. The default uses a different group for each occasion.
4362 See |highlight-default| for the default highlight groups.
4363
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004365'history' 'hi' number (Vim default: 50, Vi default: 0,
4366 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004369 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004371 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 NOTE: This option is set to the Vi default value when 'compatible' is
4373 set and to the Vim default value when 'compatible' is reset.
4374
4375 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4376'hkmap' 'hk' boolean (default off)
4377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 {only available when compiled with the |+rightleft|
4379 feature}
4380 When on, the keyboard is mapped for the Hebrew character set.
4381 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4382 toggle this option. See |rileft.txt|.
4383 NOTE: This option is reset when 'compatible' is set.
4384
4385 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4386'hkmapp' 'hkp' boolean (default off)
4387 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 {only available when compiled with the |+rightleft|
4389 feature}
4390 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4391 This is useful if you have a non-Hebrew keyboard.
4392 See |rileft.txt|.
4393 NOTE: This option is reset when 'compatible' is set.
4394
Bram Moolenaar036986f2017-03-16 17:41:02 +01004395 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4396'hlsearch' 'hls' boolean (default off)
4397 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004398 {not available when compiled without the
4399 |+extra_search| feature}
4400 When there is a previous search pattern, highlight all its matches.
4401 The type of highlighting used can be set with the 'l' occasion in the
4402 'highlight' option. This uses the "Search" highlight group by
4403 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004404 are not applied. If the "CurSearch" highlight group is set then the
4405 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004406 See also: 'incsearch' and |:match|.
4407 When you get bored looking at the highlighted matches, you can turn it
4408 off with |:nohlsearch|. This does not change the option value, as
4409 soon as you use a search command, the highlighting comes back.
4410 'redrawtime' specifies the maximum time spent on finding matches.
4411 When the search pattern can match an end-of-line, Vim will try to
4412 highlight all of the matched text. However, this depends on where the
4413 search starts. This will be the first line in the window or the first
4414 line below a closed fold. A match in a previous line which is not
4415 drawn may not continue in a newly drawn line.
4416 You can specify whether the highlight status is restored on startup
4417 with the 'h' flag in 'viminfo' |viminfo-h|.
4418 NOTE: This option is reset when 'compatible' is set.
4419
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 *'icon'* *'noicon'*
4421'icon' boolean (default off, on when title can be restored)
4422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 When on, the icon text of the window will be set to the value of
4424 'iconstring' (if it is not empty), or to the name of the file
4425 currently being edited. Only the last part of the name is used.
4426 Overridden by the 'iconstring' option.
4427 Only works if the terminal supports setting window icons (currently
4428 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4429 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4430 builtin termcap).
4431 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004432 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004434 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435
4436 *'iconstring'*
4437'iconstring' string (default "")
4438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 When this option is not empty, it will be used for the icon text of
4440 the window. This happens only when the 'icon' option is on.
4441 Only works if the terminal supports setting window icon text
4442 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004443 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 When Vim was compiled with HAVE_X11 defined, the original icon will be
4445 restored if possible |X11|.
4446 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004447 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004449 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 {not available when compiled without the |+statusline| feature}
4451
4452 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4453'ignorecase' 'ic' boolean (default off)
4454 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004455 Ignore case in search patterns, |cmdline-completion|, when
4456 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004457 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 Can be overruled by using "\c" or "\C" in the pattern, see
4459 |/ignorecase|.
4460
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004461 *'imactivatefunc'* *'imaf'*
4462'imactivatefunc' 'imaf' string (default "")
4463 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004464 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004465 activate or deactivate the Input Method. The value can be the name of
4466 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4467 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004468 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004469 The expression will be evaluated in the |sandbox| when set from a
4470 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004471
4472 Example: >
4473 function ImActivateFunc(active)
4474 if a:active
4475 ... do something
4476 else
4477 ... do something
4478 endif
4479 " return value is not used
4480 endfunction
4481 set imactivatefunc=ImActivateFunc
4482<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 *'imactivatekey'* *'imak'*
4484'imactivatekey' 'imak' string (default "")
4485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004487 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 Specifies the key that your Input Method in X-Windows uses for
4489 activation. When this is specified correctly, vim can fully control
4490 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4491 You can't use this option to change the activation key, the option
4492 tells Vim what the key is.
4493 Format:
4494 [MODIFIER_FLAG-]KEY_STRING
4495
4496 These characters can be used for MODIFIER_FLAG (case is ignored):
4497 S Shift key
4498 L Lock key
4499 C Control key
4500 1 Mod1 key
4501 2 Mod2 key
4502 3 Mod3 key
4503 4 Mod4 key
4504 5 Mod5 key
4505 Combinations are allowed, for example "S-C-space" or "SC-space" are
4506 both shift+ctrl+space.
4507 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4508
4509 Example: >
4510 :set imactivatekey=S-space
4511< "S-space" means shift+space. This is the activation key for kinput2 +
4512 canna (Japanese), and ami (Korean).
4513
4514 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4515'imcmdline' 'imc' boolean (default off)
4516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 When set the Input Method is always on when starting to edit a command
4518 line, unless entering a search pattern (see 'imsearch' for that).
4519 Setting this option is useful when your input method allows entering
4520 English characters directly, e.g., when it's used to type accented
4521 characters with dead keys.
4522
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004523 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 When set the Input Method is never used. This is useful to disable
4527 the IM when it doesn't work properly.
4528 Currently this option is on by default for SGI/IRIX machines. This
4529 may change in later releases.
4530
4531 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004532'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 Specifies whether :lmap or an Input Method (IM) is to be used in
4535 Insert mode. Valid values:
4536 0 :lmap is off and IM is off
4537 1 :lmap is ON and IM is off
4538 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 To always reset the option to zero when leaving Insert mode with <Esc>
4540 this can be used: >
4541 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4542< This makes :lmap and IM turn off automatically when leaving Insert
4543 mode.
4544 Note that this option changes when using CTRL-^ in Insert mode
4545 |i_CTRL-^|.
4546 The value is set to 1 when setting 'keymap' to a valid keymap name.
4547 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004548 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 methods. Use 'imdisable' to disable XIM then.
4550
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004551 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004552 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004553 |+multi_byte_ime| or |global-ime|.
4554
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004556'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 Specifies whether :lmap or an Input Method (IM) is to be used when
4559 entering a search pattern. Valid values:
4560 -1 the value of 'iminsert' is used, makes it look like
4561 'iminsert' is also used when typing a search pattern
4562 0 :lmap is off and IM is off
4563 1 :lmap is ON and IM is off
4564 2 :lmap is off and IM is ON
4565 Note that this option changes when using CTRL-^ in Command-line mode
4566 |c_CTRL-^|.
4567 The value is set to 1 when it is not -1 and setting the 'keymap'
4568 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004569 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 methods. Use 'imdisable' to disable XIM then.
4571
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004572 *'imstatusfunc'* *'imsf'*
4573'imstatusfunc' 'imsf' string (default "")
4574 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004575 This option specifies a function that is called to obtain the status
4576 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004577 The value can be the name of a function, a |lambda| or a |Funcref|.
4578 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004579 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004580
4581 Example: >
4582 function ImStatusFunc()
4583 let is_active = ...do something
4584 return is_active ? 1 : 0
4585 endfunction
4586 set imstatusfunc=ImStatusFunc
4587<
4588 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004589 The expression will be evaluated in the |sandbox| when set from a
4590 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004591
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004592 *'imstyle'* *'imst'*
4593'imstyle' 'imst' number (default 1)
4594 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004595 {only available when compiled with |+xim| and
4596 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004597 This option specifies the input style of Input Method:
4598 0 use on-the-spot style
4599 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004600 See: |xim-input-style|
4601
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004602 For a long time on-the-spot style had been used in the GTK version of
4603 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004604 |single-repeat|, etc. Therefore over-the-spot style becomes the
4605 default now. This should work fine for most people, however if you
4606 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004607 The expression will be evaluated in the |sandbox| when set from a
4608 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004609
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 *'include'* *'inc'*
4611'include' 'inc' string (default "^\s*#\s*include")
4612 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 {not available when compiled without the
4614 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004615 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 pattern, just like for the "/" command (See |pattern|). The default
4617 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004618 "]I", "[d", etc.
4619 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004620 comes after the matched pattern. But if "\zs" appears in the pattern
4621 then the text matched from "\zs" to the end, or until "\ze" if it
4622 appears, is used as the file name. Use this to include characters
4623 that are not in 'isfname', such as a space. You can then use
4624 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004625 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626
4627 *'includeexpr'* *'inex'*
4628'includeexpr' 'inex' string (default "")
4629 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004631 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004633 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004634 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004636 Note the double backslash: the `:set` command first halves them, then
4637 one remains it the value, where "\." matches a dot literally. For
4638 simple character replacements `tr()` avoids the need for escaping: >
4639 :setlocal includeexpr=tr(v:fname,'.','/')
4640<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004642 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 Also used for |<cfile>|.
4644
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004645 If the expression starts with s: or |<SID>|, then it is replaced with
4646 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004647 setlocal includeexpr=s:MyIncludeExpr()
4648 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004649< Otherwise, the expression is evaluated in the context of the script
4650 where the option was set, thus script-local items are available.
4651
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004652 It is more efficient if the value is just a function call without
4653 arguments, see |expr-option-function|.
4654
Bram Moolenaar30b65812012-07-12 22:01:11 +02004655 The expression will be evaluated in the |sandbox| when set from a
4656 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004657 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004658
4659 It is not allowed to change text or jump to another window while
4660 evaluating 'includeexpr' |textlock|.
4661
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004663'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004664 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004667 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004668 While typing a search command, show where the pattern, as it was typed
4669 so far, matches. The matched string is highlighted. If the pattern
4670 is invalid or not found, nothing is shown. The screen will be updated
4671 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004672 Also applies to the pattern in commands: >
4673 :global
4674 :lvimgrep
4675 :lvimgrepadd
4676 :smagic
4677 :snomagic
4678 :sort
4679 :substitute
4680 :vglobal
4681 :vimgrep
4682 :vimgrepadd
4683< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004684 original position when no match is found and when pressing <Esc>. You
4685 still need to finish the search command with <Enter> to move the
4686 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004687 You can use the CTRL-G and CTRL-T keys to move to the next and
4688 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004689 When compiled with the |+reltime| feature Vim only searches for about
4690 half a second. With a complicated pattern and/or a lot of text the
4691 match may not be found. This is to avoid that Vim hangs while you
4692 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004693 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004694 When 'hlsearch' is on, all matched strings are highlighted too while
4695 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004696 If you don't want to turn 'hlsearch' on, but want to highlight all
4697 matches while searching, you can turn on and off 'hlsearch' with
4698 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004699 augroup vimrc-incsearch-highlight
4700 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004701 autocmd CmdlineEnter /,\? :set hlsearch
4702 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004703 augroup END
4704<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004705 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004706 to the command line. If 'ignorecase' and 'smartcase' are set and the
4707 command line has no uppercase characters, the added character is
4708 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004709 CTRL-R CTRL-W can be used to add the word at the end of the current
4710 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 NOTE: This option is reset when 'compatible' is set.
4712
4713 *'indentexpr'* *'inde'*
4714'indentexpr' 'inde' string (default "")
4715 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004716 {not available when compiled without the |+eval|
4717 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 Expression which is evaluated to obtain the proper indent for a line.
4719 It is used when a new line is created, for the |=| operator and
4720 in Insert mode as specified with the 'indentkeys' option.
4721 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004722 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004723 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 When 'paste' is set this option is not used for indenting.
4725 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004726 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004728
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004729 If the expression starts with s: or |<SID>|, then it is replaced with
4730 the script ID (|local-function|). Example: >
4731 set indentexpr=s:MyIndentExpr()
4732 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004733< Otherwise, the expression is evaluated in the context of the script
4734 where the option was set, thus script-local items are available.
4735
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004736 The advantage of using a function call without arguments is that it is
4737 faster, see |expr-option-function|.
4738
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 The expression must return the number of spaces worth of indent. It
4740 can return "-1" to keep the current indent (this means 'autoindent' is
4741 used for the indent).
4742 Functions useful for computing the indent are |indent()|, |cindent()|
4743 and |lispindent()|.
4744 The evaluation of the expression must not have side effects! It must
4745 not change the text, jump to another window, etc. Afterwards the
4746 cursor position is always restored, thus the cursor may be moved.
4747 Normally this option would be set to call a function: >
4748 :set indentexpr=GetMyIndent()
4749< Error messages will be suppressed, unless the 'debug' option contains
4750 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004751 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004752 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753
Bram Moolenaar30b65812012-07-12 22:01:11 +02004754 The expression will be evaluated in the |sandbox| when set from a
4755 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004756 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004757
4758 It is not allowed to change text or jump to another window while
4759 evaluating 'indentexpr' |textlock|.
4760
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004762'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 A list of keys that, when typed in Insert mode, cause reindenting of
4765 the current line. Only happens if 'indentexpr' isn't empty.
4766 The format is identical to 'cinkeys', see |indentkeys-format|.
4767 See |C-indenting| and |indent-expression|.
4768
4769 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4770'infercase' 'inf' boolean (default off)
4771 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004773 'ignorecase' is also on, the case of the match is adjusted depending
4774 on the typed text. If the typed text contains a lowercase letter
4775 where the match has an upper case letter, the completed part is made
4776 lowercase. If the typed text has no lowercase letters and the match
4777 has a lowercase letter where the typed text has an uppercase letter,
4778 and there is a letter before it, the completed part is made uppercase.
4779 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780
4781 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4782'insertmode' 'im' boolean (default off)
4783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 Makes Vim work in a way that Insert mode is the default mode. Useful
4785 if you want to use Vim as a modeless editor. Used for |evim|.
4786 These Insert mode commands will be useful:
4787 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004788 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 this is a mapping, it is executed as if 'insertmode' was off.
4790 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004792 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4793 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794
4795 These items change when 'insertmode' is set:
4796 - when starting to edit of a file, Vim goes to Insert mode.
4797 - <Esc> in Insert mode is a no-op and beeps.
4798 - <Esc> in Normal mode makes Vim go to Insert mode.
4799 - CTRL-L in Insert mode is a command, it is not inserted.
4800 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4801 However, when <Esc> is used inside a mapping, it behaves like
4802 'insertmode' was not set. This was done to be able to use the same
4803 mappings with 'insertmode' set or not set.
4804 When executing commands with |:normal| 'insertmode' is not used.
4805
4806 NOTE: This option is reset when 'compatible' is set.
4807
4808 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004809'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4811 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4812 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4813 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4814 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 The characters specified by this option are included in file names and
4817 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004818 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 Multi-byte characters 256 and above are always included, only the
4820 characters up to 255 are specified with this option.
4821 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004822 Think twice before adding white space to this option. Although a
4823 space may appear inside a file name, the effect will be that Vim
4824 doesn't know where a file name starts or ends when doing completion.
4825 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826
4827 Note that on systems using a backslash as path separator, Vim tries to
4828 do its best to make it work as you would expect. That is a bit
4829 tricky, since Vi originally used the backslash to escape special
4830 characters. Vim will not remove a backslash in front of a normal file
4831 name character on these systems, but it will on Unix and alikes. The
4832 '&' and '^' are not included by default, because these are special for
4833 cmd.exe.
4834
4835 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004836 Each part can be a single character number or a range. A range is two
4837 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 decimal number between 0 and 255 or the ASCII character itself (does
4839 not work for digits). Example:
4840 "_,-,128-140,#-43" (include '_' and '-' and the range
4841 128 to 140 and '#' to 43)
4842 If a part starts with '^', the following character number or range
4843 will be excluded from the option. The option is interpreted from left
4844 to right. Put the excluded character after the range where it is
4845 included. To include '^' itself use it as the last character of the
4846 option or the end of a range. Example:
4847 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4848 If the character is '@', all characters where isalpha() returns TRUE
4849 are included. Normally these are the characters a to z and A to Z,
4850 plus accented characters. To include '@' itself use "@-@". Examples:
4851 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004852 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 "a-z,A-Z,@-@" All letters plus the '@' character.
4854 A comma can be included by using it where a character number is
4855 expected. Example:
4856 "48-57,,,_" Digits, comma and underscore.
4857 A comma can be excluded by prepending a '^'. Example:
4858 " -~,^,,9" All characters from space to '~', excluding
4859 comma, plus <Tab>.
4860 See |option-backslash| about including spaces and backslashes.
4861
4862 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004863'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 "@,48-57,_,128-167,224-235"
4865 otherwise: "@,48-57,_,192-255")
4866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 The characters given by this option are included in identifiers.
4868 Identifiers are used in recognizing environment variables and after a
4869 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004870 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004871 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004873 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4875
4876 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004877'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 "@,48-57,_,128-167,224-235"
4879 otherwise: "@,48-57,_,192-255"
4880 Vi default: "@,48-57,_")
4881 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004883 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004884 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004885 characters above 255 check the "word" character class (any character
4886 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004887 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 For a help file it is set to all non-blank printable characters except
4889 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4890 command).
4891 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004892 This option also influences syntax highlighting, unless the syntax
4893 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 NOTE: This option is set to the Vi default value when 'compatible' is
4895 set and to the Vim default value when 'compatible' is reset.
4896
4897 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004898'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 "@,~-255"; otherwise: "@,161-255")
4900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 The characters given by this option are displayed directly on the
4902 screen. It is also used for "\p" in a |pattern|. The characters from
4903 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4904 even when they are not included in 'isprint' or excluded. See
4905 'isfname' for a description of the format of this option.
4906
4907 Non-printable characters are displayed with two characters:
4908 0 - 31 "^@" - "^_"
4909 32 - 126 always single characters
4910 127 "^?"
4911 128 - 159 "~@" - "~_"
4912 160 - 254 "| " - "|~"
4913 255 "~?"
4914 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4915 displayed as <xx>, with the hexadecimal value of the byte.
4916 When 'display' contains "uhex" all unprintable characters are
4917 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004918 The SpecialKey highlighting will be used for unprintable characters.
4919 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920
4921 Multi-byte characters 256 and above are always included, only the
4922 characters up to 255 are specified with this option. When a character
4923 is printable but it is not available in the current font, a
4924 replacement character will be shown.
4925 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4926 There is no option to specify these characters.
4927
4928 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4929'joinspaces' 'js' boolean (default on)
4930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 Insert two spaces after a '.', '?' and '!' with a join command.
4932 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4933 Otherwise only one space is inserted.
4934 NOTE: This option is set when 'compatible' is set.
4935
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004936 *'jumpoptions'* *'jop'*
4937'jumpoptions' 'jop' string (default "")
4938 global
4939 List of words that change the behavior of the |jumplist|.
4940 stack Make the jumplist behave like the tagstack.
4941 Relative location of entries in the jumplist is
4942 preserved at the cost of discarding subsequent entries
4943 when navigating backwards in the jumplist and then
4944 jumping to a location. |jumplist-stack|
4945
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 *'key'*
4947'key' string (default "")
4948 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004949 {only available when compiled with the |+cryptv|
4950 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004952 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 Careful: Do not set the key value by hand, someone might see the typed
4954 key. Use the |:X| command. But you can make 'key' empty: >
4955 :set key=
4956< It is not possible to get the value of this option with ":set key" or
4957 "echo &key". This is to avoid showing it to someone who shouldn't
4958 know. It also means you cannot see it yourself once you have set it,
4959 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004960 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4961 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004962 You can use "&key" in an expression to detect whether encryption is
4963 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964
4965 *'keymap'* *'kmp'* *E544*
4966'keymap' 'kmp' string (default "")
4967 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 {only available when compiled with the |+keymap|
4969 feature}
4970 Name of a keyboard mapping. See |mbyte-keymap|.
4971 Setting this option to a valid keymap name has the side effect of
4972 setting 'iminsert' to one, so that the keymap becomes effective.
4973 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004974 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975
4976 *'keymodel'* *'km'*
4977'keymodel' 'km' string (default "")
4978 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004979 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 can do. These values can be used:
4981 startsel Using a shifted special key starts selection (either
4982 Select mode or Visual mode, depending on "key" being
4983 present in 'selectmode').
4984 stopsel Using a not-shifted special key stops selection.
4985 Special keys in this context are the cursor keys, <End>, <Home>,
4986 <PageUp> and <PageDown>.
4987 The 'keymodel' option is set by the |:behave| command.
4988
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004989 *'keyprotocol'* *'kpc'*
4990'keyprotocol' 'kpc' string (default: see below)
4991 global
4992 Specifies what keyboard protocol to use depending on the value of
4993 'term'. The supported keyboard protocols names are:
4994 none whatever the terminal uses
4995 mok2 modifyOtherKeys level 2, as supported by xterm
4996 kitty Kitty keyboard protocol, as supported by Kitty
4997
Bram Moolenaara87749e2022-11-30 10:23:17 +00004998 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004999 a pattern that is matched against the 'term' option, a colon and the
5000 protocol name to be used. To illustrate this, the default value would
5001 be set with: >
5002 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
5003
5004< This means that when 'term' contains "kitty, "foot" or "wezterm"
5005 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00005006 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005007
5008 The first match is used, thus if you want to have "kitty" use the
5009 kitty protocol, but "badkitty" not, then you should match "badkitty"
5010 first and use the "none" value: >
5011 set keyprotocol=badkitty:none,kitty:kitty
5012<
5013 The option is used after 'term' has been changed. First the termcap
5014 entries are set, possibly using the builtin list, see |builtin-terms|.
5015 Then this option is inspected and if there is a match and a protocol
5016 is specified the following happens:
5017 none Nothing, the regular t_TE and t_TI values remain
5018
5019 mok2 The t_TE value is changed to:
5020 CSI >4;m disables modifyOtherKeys
5021 The t_TI value is changed to:
5022 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005023 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005024
5025 kitty The t_TE value is changed to:
5026 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005027 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005028 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005029 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005030 CSI ?u request kitty keyboard protocol state
5031 CSI >c request the termresponse
5032
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005033 If you notice problems, such as characters being displayed that
5034 disappear after `CTRL-L`, you might want to try making this option
5035 empty. Then set the 'term' option to have it take effect: >
5036 set keyprotocol=
5037 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005038<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005039
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 *'keywordprg'* *'kp'*
5041'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005042 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 Program to use for the |K| command. Environment variables are
5045 expanded |:set_env|. ":help" may be used to access the Vim internal
5046 help. (Note that previously setting the global option to the empty
5047 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005048 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005049 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005050 When "man", "man -s" or an Ex command is used, Vim will automatically
5051 translate a count for the "K" command and pass it as the first
5052 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 See |option-backslash| about including spaces and backslashes.
5054 Example: >
5055 :set keywordprg=man\ -s
5056< This option cannot be set from a |modeline| or in the |sandbox|, for
5057 security reasons.
5058
5059 *'langmap'* *'lmap'* *E357* *E358*
5060'langmap' 'lmap' string (default "")
5061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 {only available when compiled with the |+langmap|
5063 feature}
5064 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005065 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005066 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 care of translating these special characters to the original meaning
5068 of the key. This means you don't have to change the keyboard mode to
5069 be able to execute Normal mode commands.
5070 This is the opposite of the 'keymap' option, where characters are
5071 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005072 Also consider setting 'langremap' to off, to prevent 'langmap' from
5073 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005074 This option cannot be set from a |modeline| or in the |sandbox|, for
5075 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005077 Example (for Greek, in UTF-8): *greek* >
5078 :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 +00005079< Example (exchanges meaning of z and y for commands): >
5080 :set langmap=zy,yz,ZY,YZ
5081<
5082 The 'langmap' option is a list of parts, separated with commas. Each
5083 part can be in one of two forms:
5084 1. A list of pairs. Each pair is a "from" character immediately
5085 followed by the "to" character. Examples: "aA", "aAbBcC".
5086 2. A list of "from" characters, a semi-colon and a list of "to"
5087 characters. Example: "abc;ABC"
5088 Example: "aA,fgh;FGH,cCdDeE"
5089 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005090 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091
5092 This will allow you to activate vim actions without having to switch
5093 back and forth between the languages. Your language characters will
5094 be understood as normal vim English characters (according to the
5095 langmap mappings) in the following cases:
5096 o Normal/Visual mode (commands, buffer/register names, user mappings)
5097 o Insert/Replace Mode: Register names after CTRL-R
5098 o Insert/Replace Mode: Mappings
5099 Characters entered in Command-line mode will NOT be affected by
5100 this option. Note that this option can be changed at any time
5101 allowing to switch between mappings for different languages/encodings.
5102 Use a mapping to avoid having to type it each time!
5103
5104 *'langmenu'* *'lm'*
5105'langmenu' 'lm' string (default "")
5106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 {only available when compiled with the |+menu| and
5108 |+multi_lang| features}
5109 Language to use for menu translation. Tells which file is loaded
5110 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005111 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112< (without the spaces). For example, to always use the Dutch menus, no
5113 matter what $LANG is set to: >
5114 :set langmenu=nl_NL.ISO_8859-1
5115< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005116 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 If your $LANG is set to a non-English language but you do want to use
5118 the English menus: >
5119 :set langmenu=none
5120< This option must be set before loading menus, switching on filetype
5121 detection or syntax highlighting. Once the menus are defined setting
5122 this option has no effect. But you could do this: >
5123 :source $VIMRUNTIME/delmenu.vim
5124 :set langmenu=de_DE.ISO_8859-1
5125 :source $VIMRUNTIME/menu.vim
5126< Warning: This deletes all menus that you defined yourself!
5127
Bram Moolenaard94464e2015-11-02 15:28:18 +01005128 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005129'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005130 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005131 {only available when compiled with the |+langmap|
5132 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005133 This is just like 'langremap' but with the value inverted. It only
5134 exists for backwards compatibility. When setting 'langremap' then
5135 'langnoremap' is set to the inverted value, and the other way around.
5136
5137 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005138'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005139 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005140 {only available when compiled with the |+langmap|
5141 feature}
5142 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005143 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005144 'langmap' disables some of your mappings, try resetting this option.
5145 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005146 that works for you to avoid mappings to break.
5147
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 *'laststatus'* *'ls'*
5149'laststatus' 'ls' number (default 1)
5150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 The value of this option influences when the last window will have a
5152 status line:
5153 0: never
5154 1: only if there are at least two windows
5155 2: always
5156 The screen looks nicer with a status line if you have several
5157 windows, but it takes another screen line. |status-line|
5158
5159 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5160'lazyredraw' 'lz' boolean (default off)
5161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 When this option is set, the screen will not be redrawn while
5163 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005164 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005166 This may occasionally cause display errors. It is only meant to be set
5167 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005168 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169
5170 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5171'linebreak' 'lbr' boolean (default off)
5172 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005173 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005175 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 than at the last character that fits on the screen. Unlike
5177 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005178 it only affects the way the file is displayed, not its contents.
5179 If 'breakindent' is set, line is visually indented. Then, the value
5180 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005181 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 Note that <Tab> characters after an <EOL> are mostly not displayed
5183 with the right amount of white space.
5184
5185 *'lines'* *E593*
5186'lines' number (default 24 or terminal height)
5187 global
5188 Number of lines of the Vim window.
5189 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005190 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 When Vim is running in the GUI or in a resizable window, setting this
5192 option will cause the window size to be changed. When you only want
5193 to use the size for the GUI, put the command in your |gvimrc| file.
5194 Vim limits the number of lines to what fits on the screen. You can
5195 use this command to get the tallest window possible: >
5196 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005197< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005198 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 When you set this option and Vim is unable to change the physical
5200 number of lines of the display, the display may be messed up.
5201
5202 *'linespace'* *'lsp'*
5203'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 {only in the GUI}
5206 Number of pixel lines inserted between characters. Useful if the font
5207 uses the full character cell height, making lines touch each other.
5208 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005209 With some fonts there can be too much room between lines (to have
5210 space for ascents and descents). Then it makes sense to set
5211 'linespace' to a negative value. This may cause display problems
5212 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213
5214 *'lisp'* *'nolisp'*
5215'lisp' boolean (default off)
5216 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 Lisp mode: When <Enter> is typed in insert mode set the indent for
5218 the next line to Lisp standards (well, sort of). Also happens with
5219 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5220 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5221 better. Also see 'lispwords'.
5222 The '-' character is included in keyword characters. Redefines the
5223 "=" operator to use this same indentation algorithm rather than
5224 calling an external program if 'equalprg' is empty.
5225 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005227 *'lispoptions'* *'lop'*
5228'lispoptions' 'lop' string (default "")
5229 local to buffer
5230 Comma-separated list of items that influence the Lisp indenting when
5231 enabled with the |'lisp'| option. Currently only one item is
5232 supported:
5233 expr:1 use 'indentexpr' for Lisp indenting when it is set
5234 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5235 Note that when using 'indentexpr' the `=` operator indents all the
5236 lines, otherwise the first line is not indented (Vi-compatible).
5237
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 *'lispwords'* *'lw'*
5239'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005240 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005241 Comma-separated list of words that influence the Lisp indenting when
5242 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243
5244 *'list'* *'nolist'*
5245'list' boolean (default off)
5246 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005247 List mode: By default show tabs as CTRL-I is displayed, display $
5248 after end of line. Useful to see the difference between tabs and
5249 spaces and for trailing blanks. Further changed by the 'listchars'
5250 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005251
5252 The cursor is displayed at the start of the space a Tab character
5253 occupies, not at the end as usual in Normal mode. To get this cursor
5254 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005255 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005256<
5257 Note that list mode will also affect formatting (set with 'textwidth'
5258 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259 changing the way tabs are displayed.
5260
5261 *'listchars'* *'lcs'*
5262'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005263 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005264 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005265 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005266 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 eol:c Character to show at the end of each line. When
5268 omitted, there is no extra character at the end of the
5269 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005270 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005271 tab:xy[z] Two or three characters to be used to show a tab.
5272 The third character is optional.
5273
5274 tab:xy The 'x' is always used, then 'y' as many times as will
5275 fit. Thus "tab:>-" displays:
5276 >
5277 >-
5278 >--
5279 etc.
5280
5281 tab:xyz The 'z' is always used, then 'x' is prepended, and
5282 then 'y' is used as many times as will fit. Thus
5283 "tab:<->" displays:
5284 >
5285 <>
5286 <->
5287 <-->
5288 etc.
5289
5290 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005291 *lcs-space*
5292 space:c Character to show for a space. When omitted, spaces
5293 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005294 *lcs-multispace*
5295 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005296 One or more characters to use cyclically to show for
5297 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005298 setting, except for single spaces. When omitted, the
5299 "space" setting is used. For example,
5300 `:set listchars=multispace:---+` shows ten consecutive
5301 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005302 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005303 *lcs-lead*
5304 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005305 leading spaces are blank. Overrides the "space" and
5306 "multispace" settings for leading spaces. You can
5307 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005308 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005309< *lcs-leadmultispace*
5310 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005311 Like the |lcs-multispace| value, but for leading
5312 spaces only. Also overrides |lcs-lead| for leading
5313 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005314 `:set listchars=leadmultispace:---+` shows ten
5315 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005316 ---+---+--XXX ~
5317 Where "XXX" denotes the first non-blank characters in
5318 the line.
5319 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005320 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005321 trailing spaces are blank. Overrides the "space" and
5322 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005323 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 extends:c Character to show in the last column, when 'wrap' is
5325 off and the line continues beyond the right of the
5326 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005327 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005328 precedes:c Character to show in the first visible column of the
5329 physical line, when there is text preceding the
5330 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005331 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005332 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005333 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005334 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005335 nbsp:c Character to show for a non-breakable space character
5336 (0xA0 (160 decimal) and U+202F). Left blank when
5337 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005339 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005341 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005343 Each character can be specified as hex: >
5344 set listchars=eol:\\x24
5345 set listchars=eol:\\u21b5
5346 set listchars=eol:\\U000021b5
5347< Note that a double backslash is used. The number of hex characters
5348 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5349
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 Examples: >
5351 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005352 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 :set lcs=extends:>,precedes:<
5354< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005355 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5356 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005357 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358
5359 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5360'loadplugins' 'lpl' boolean (default on)
5361 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 When on the plugin scripts are loaded when starting up |load-plugins|.
5363 This option can be reset in your |vimrc| file to disable the loading
5364 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005365 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5366 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367
Bram Moolenaard94464e2015-11-02 15:28:18 +01005368 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005369'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005370 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005371 {only available when compiled with the |+lua/dyn|
5372 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005373 Specifies the name of the Lua shared library. The default is
5374 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005375 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005376 This option cannot be set from a |modeline| or in the |sandbox|, for
5377 security reasons.
5378
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005379 *'macatsui'* *'nomacatsui'*
5380'macatsui' boolean (default on)
5381 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005382 {not supported}
5383 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005384
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 *'magic'* *'nomagic'*
5386'magic' boolean (default on)
5387 global
5388 Changes the special characters that can be used in search patterns.
5389 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005390 WARNING: Switching this option off most likely breaks plugins! That
5391 is because many patterns assume it's on and will fail when it's off.
5392 Only switch it off when working with old Vi scripts. In any other
5393 situation write patterns that work when 'magic' is on. Include "\M"
5394 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005395 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5396 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397
5398 *'makeef'* *'mef'*
5399'makeef' 'mef' string (default: "")
5400 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 {not available when compiled without the |+quickfix|
5402 feature}
5403 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5404 and the |:grep| command.
5405 When it is empty, an internally generated temp file will be used.
5406 When "##" is included, it is replaced by a number to make the name
5407 unique. This makes sure that the ":make" command doesn't overwrite an
5408 existing file.
5409 NOT used for the ":cf" command. See 'errorfile' for that.
5410 Environment variables are expanded |:set_env|.
5411 See |option-backslash| about including spaces and backslashes.
5412 This option cannot be set from a |modeline| or in the |sandbox|, for
5413 security reasons.
5414
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005415 *'makeencoding'* *'menc'*
5416'makeencoding' 'menc' string (default "")
5417 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005418 Encoding used for reading the output of external commands. When empty,
5419 encoding is not converted.
5420 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5421 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5422 and `:laddfile`.
5423
5424 This would be mostly useful when you use MS-Windows and set 'encoding'
5425 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5426 'makeencoding' to "char" has the same effect as setting to the system
5427 locale encoding. Example: >
5428 :set encoding=utf-8
5429 :set makeencoding=char " system locale is used
5430<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 *'makeprg'* *'mp'*
5432'makeprg' 'mp' string (default "make", VMS: "MMS")
5433 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005434 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005435 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5436 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005437 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005438 Environment variables are expanded |:set_env|. See |option-backslash|
5439 about including spaces and backslashes.
5440 Note that a '|' must be escaped twice: once for ":set" and once for
5441 the interpretation of a command. When you use a filter called
5442 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 :set makeprg=gmake\ \\\|\ myfilter
5444< The placeholder "$*" can be given (even multiple times) to specify
5445 where the arguments will be included, for example: >
5446 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5447< This option cannot be set from a |modeline| or in the |sandbox|, for
5448 security reasons.
5449
5450 *'matchpairs'* *'mps'*
5451'matchpairs' 'mps' string (default "(:),{:},[:]")
5452 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005454 other.
5455 Only character pairs are allowed that are different, thus you cannot
5456 jump between two double quotes.
5457 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005458 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005459 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 :set mps+=<:>
5461
5462< A more exotic example, to jump between the '=' and ';' in an
5463 assignment, useful for languages like C and Java: >
5464 :au FileType c,cpp,java set mps+==:;
5465
5466< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005467 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468
5469 *'matchtime'* *'mat'*
5470'matchtime' 'mat' number (default 5)
5471 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 Tenths of a second to show the matching paren, when 'showmatch' is
5473 set. Note that this is not in milliseconds, like other options that
5474 set a time. This is to be compatible with Nvi.
5475
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005476 *'maxcombine'* *'mco'*
5477'maxcombine' 'mco' number (default 2)
5478 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005479 The maximum number of combining characters supported for displaying.
5480 Only used when 'encoding' is "utf-8".
5481 The default is OK for most languages. Hebrew may require 4.
5482 Maximum value is 6.
5483 Even when this option is set to 2 you can still edit text with more
5484 combining characters, you just can't see them. Use |g8| or |ga|.
5485 See |mbyte-combining|.
5486
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 *'maxfuncdepth'* *'mfd'*
5488'maxfuncdepth' 'mfd' number (default 100)
5489 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005490 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005491 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 Maximum depth of function calls for user functions. This normally
5493 catches endless recursion. When using a recursive function with
5494 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5495 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005496 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005497 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005499 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500
5501 *'maxmapdepth'* *'mmd'* *E223*
5502'maxmapdepth' 'mmd' number (default 1000)
5503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 Maximum number of times a mapping is done without resulting in a
5505 character to be used. This normally catches endless mappings, like
5506 ":map x y" with ":map y x". It still does not catch ":map g wg",
5507 because the 'w' is used before the next mapping is done. See also
5508 |key-mapping|.
5509
5510 *'maxmem'* *'mm'*
5511'maxmem' 'mm' number (default between 256 to 5120 (system
5512 dependent) or half the amount of memory
5513 available)
5514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5516 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005517 other memory to be freed.
5518 The maximum usable value is about 2000000. Use this to work without a
5519 limit.
5520 The value is ignored when 'swapfile' is off.
5521 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005523 *'maxmempattern'* *'mmp'*
5524'maxmempattern' 'mmp' number (default 1000)
5525 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005526 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005527 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005528 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005529 When Vim runs into the limit it gives an error message and mostly
5530 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005531 Running into the limit often means that the pattern is very
5532 inefficient or too complex. This may already happen with the pattern
5533 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005534 Might also happen on redraw, when syntax rules try to match a complex
5535 text structure.
5536 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5537 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005538
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 *'maxmemtot'* *'mmt'*
5540'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5541 dependent) or half the amount of memory
5542 available)
5543 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005544 Maximum amount of memory in Kbyte to use for all buffers together.
5545 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005546 without a limit.
5547 On 64 bit machines higher values might work. But hey, do you really
5548 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005549 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005550 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005551 Buffers with 'swapfile' off still count to the total amount of memory
5552 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005553 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554
5555 *'menuitems'* *'mis'*
5556'menuitems' 'mis' number (default 25)
5557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558 {not available when compiled without the |+menu|
5559 feature}
5560 Maximum number of items to use in a menu. Used for menus that are
5561 generated from a list of items, e.g., the Buffers menu. Changing this
5562 option has no direct effect, the menu must be refreshed first.
5563
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005564 *'mkspellmem'* *'msm'*
5565'mkspellmem' 'msm' string (default "460000,2000,500")
5566 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005567 {not available when compiled without the |+syntax|
5568 feature}
5569 Parameters for |:mkspell|. This tunes when to start compressing the
5570 word tree. Compression can be slow when there are many words, but
5571 it's needed to avoid running out of memory. The amount of memory used
5572 per word depends very much on how similar the words are, that's why
5573 this tuning is complicated.
5574
5575 There are three numbers, separated by commas:
5576 {start},{inc},{added}
5577
5578 For most languages the uncompressed word tree fits in memory. {start}
5579 gives the amount of memory in Kbyte that can be used before any
5580 compression is done. It should be a bit smaller than the amount of
5581 memory that is available to Vim.
5582
5583 When going over the {start} limit the {inc} number specifies the
5584 amount of memory in Kbyte that can be allocated before another
5585 compression is done. A low number means compression is done after
5586 less words are added, which is slow. A high number means more memory
5587 will be allocated.
5588
5589 After doing compression, {added} times 1024 words can be added before
5590 the {inc} limit is ignored and compression is done when any extra
5591 amount of memory is needed. A low number means there is a smaller
5592 chance of hitting the {inc} limit, less memory is used but it's
5593 slower.
5594
5595 The languages for which these numbers are important are Italian and
5596 Hungarian. The default works for when you have about 512 Mbyte. If
5597 you have 1 Gbyte you could use: >
5598 :set mkspellmem=900000,3000,800
5599< If you have less than 512 Mbyte |:mkspell| may fail for some
5600 languages, no matter what you set 'mkspellmem' to.
5601
dkearns8ebdbc92023-10-29 06:26:19 +11005602 This option cannot be set from a |modeline| or in the |sandbox|, for
5603 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005604
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005606'modeline' 'ml' boolean (Vim default: on (off for root),
5607 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005608 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005609 If 'modeline' is on 'modelines' gives the number of lines that is
5610 checked for set commands. If 'modeline' is off or 'modelines' is zero
5611 no lines are checked. See |modeline|.
5612
5613 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5614'modelineexpr' 'mle' boolean (default: off)
5615 global
5616 When on allow some options that are an expression to be set in the
5617 modeline. Check the option for whether it is affected by
5618 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005619 This option cannot be set from a |modeline| or in the |sandbox|, for
5620 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005621
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 *'modelines'* *'mls'*
5623'modelines' 'mls' number (default 5)
5624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 If 'modeline' is on 'modelines' gives the number of lines that is
5626 checked for set commands. If 'modeline' is off or 'modelines' is zero
5627 no lines are checked. See |modeline|.
5628 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5629 set and to the Vim default value when 'compatible' is reset.
5630
5631 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005632 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633'modifiable' 'ma' boolean (default on)
5634 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 When off the buffer contents cannot be changed. The 'fileformat' and
5636 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005637 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638
5639 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5640'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005641 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 When on, the buffer is considered to be modified. This option is set
5643 when:
5644 1. A change was made to the text since it was last written. Using the
5645 |undo| command to go back to the original text will reset the
5646 option. But undoing changes that were made before writing the
5647 buffer will set the option again, since the text is different from
5648 when it was written.
5649 2. 'fileformat' or 'fileencoding' is different from its original
5650 value. The original value is set when the buffer is read or
5651 written. A ":set nomodified" command also resets the original
5652 values to the current values and the 'modified' option will be
5653 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005654 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005655 This option is not set when a change is made to the buffer as the
5656 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5657 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5658 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5660 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005661 Note that the text may actually be the same, e.g. 'modified' is set
5662 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663
5664 *'more'* *'nomore'*
5665'more' boolean (Vim default: on, Vi default: off)
5666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 When on, listings pause when the whole screen is filled. You will get
5668 the |more-prompt|. When this option is off there are no pauses, the
5669 listing continues until finished.
5670 NOTE: This option is set to the Vi default value when 'compatible' is
5671 set and to the Vim default value when 'compatible' is reset.
5672
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005673 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005674'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005675 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005677 Enable the use of the mouse. Works for most terminals (xterm, Win32
5678 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5679 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5680 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005681 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 v Visual mode
5683 i Insert mode
5684 c Command-line mode
5685 h all previous modes when editing a help file
5686 a all previous modes
5687 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005688 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005690< If your terminal can't overrule the mouse events going to the
5691 application, use: >
5692 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005693< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005694 back to Vim using the mouse events.
5695 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5696 "xterm".
5697
5698 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 modeless selection. This doesn't move the text cursor.
5700
5701 See |mouse-using|. Also see |'clipboard'|.
5702
5703 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005704 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 the mouse buttons can still be used by keeping the shift key pressed.
5706 Also see the 'clipboard' option.
5707
5708 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5709'mousefocus' 'mousef' boolean (default off)
5710 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711 {only works in the GUI}
5712 The window that the mouse pointer is on is automatically activated.
5713 When changing the window layout or window focus in another way, the
5714 mouse pointer is moved to the window with keyboard focus. Off is the
5715 default because it makes using the pull down menus a little goofy, as
5716 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005717 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005718 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719
5720 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5721'mousehide' 'mh' boolean (default on)
5722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 {only works in the GUI}
5724 When on, the mouse pointer is hidden when characters are typed.
5725 The mouse pointer is restored when the mouse is moved.
5726
5727 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005728'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 Sets the model to use for the mouse. The name mostly specifies what
5731 the right mouse button is used for:
5732 extend Right mouse button extends a selection. This works
5733 like in an xterm.
5734 popup Right mouse button pops up a menu. The shifted left
5735 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005736 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 popup_setpos Like "popup", but the cursor will be moved to the
5738 position where the mouse was clicked, and thus the
5739 selected operation will act upon the clicked object.
5740 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005741 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 course, that right clicking outside a selection will
5743 end Visual mode.
5744 Overview of what button does what for each model:
5745 mouse extend popup(_setpos) ~
5746 left click place cursor place cursor
5747 left drag start selection start selection
5748 shift-left search word extend selection
5749 right click extend selection popup menu (place cursor)
5750 right drag extend selection -
5751 middle click paste paste
5752
5753 In the "popup" model the right mouse button produces a pop-up menu.
5754 You need to define this first, see |popup-menu|.
5755
5756 Note that you can further refine the meaning of buttons with mappings.
5757 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5758 selection (because that's handled in the GUI code directly).
5759
5760 The 'mousemodel' option is set by the |:behave| command.
5761
h_east59858792023-10-25 22:47:05 +09005762 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005763'mousemoveevent' 'mousemev' boolean (default off)
5764 global
5765 {only works in the GUI}
5766 When on, mouse move events are delivered to the input queue and are
5767 available for mapping. The default, off, avoids the mouse movement
5768 overhead except when needed. See |gui-mouse-mapping|.
5769 Warning: Setting this option can make pending mappings to be aborted
5770 when the mouse is moved.
5771 Currently only works in the GUI, may be made to work in a terminal
5772 later.
5773
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005775'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5776 vs:leftright,vd:lrsizing,m:no,
5777 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 {only available when compiled with the |+mouseshape|
5780 feature}
5781 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005782 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 like used for 'guicursor'. Each part consist of a mode/location-list
5784 and an argument-list:
5785 mode-list:shape,mode-list:shape,..
5786 The mode-list is a dash separated list of these modes/locations:
5787 In a normal window: ~
5788 n Normal mode
5789 v Visual mode
5790 ve Visual mode with 'selection' "exclusive" (same as 'v',
5791 if not specified)
5792 o Operator-pending mode
5793 i Insert mode
5794 r Replace mode
5795
5796 Others: ~
5797 c appending to the command-line
5798 ci inserting in the command-line
5799 cr replacing in the command-line
5800 m at the 'Hit ENTER' or 'More' prompts
5801 ml idem, but cursor in the last line
5802 e any mode, pointer below last window
5803 s any mode, pointer on a status line
5804 sd any mode, while dragging a status line
5805 vs any mode, pointer on a vertical separator line
5806 vd any mode, while dragging a vertical separator line
5807 a everywhere
5808
5809 The shape is one of the following:
5810 avail name looks like ~
5811 w x arrow Normal mouse pointer
5812 w x blank no pointer at all (use with care!)
5813 w x beam I-beam
5814 w x updown up-down sizing arrows
5815 w x leftright left-right sizing arrows
5816 w x busy The system's usual busy pointer
5817 w x no The system's usual 'no input' pointer
5818 x udsizing indicates up-down resizing
5819 x lrsizing indicates left-right resizing
5820 x crosshair like a big thin +
5821 x hand1 black hand
5822 x hand2 white hand
5823 x pencil what you write with
5824 x question big ?
5825 x rightup-arrow arrow pointing right-up
5826 w x up-arrow arrow pointing up
5827 x <number> any X11 pointer number (see X11/cursorfont.h)
5828
5829 The "avail" column contains a 'w' if the shape is available for Win32,
5830 x for X11.
5831 Any modes not specified or shapes not available use the normal mouse
5832 pointer.
5833
5834 Example: >
5835 :set mouseshape=s:udsizing,m:no
5836< will make the mouse turn to a sizing arrow over the status lines and
5837 indicate no input when the hit-enter prompt is displayed (since
5838 clicking the mouse has no effect in this state.)
5839
5840 *'mousetime'* *'mouset'*
5841'mousetime' 'mouset' number (default 500)
5842 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005843 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 time in msec between two mouse clicks for the second click to be
5845 recognized as a multi click.
5846
laburnumT3f7855a2023-12-05 18:37:03 +01005847 *'mzquantum'* *'mzq'*
5848'mzquantum' 'mzq' number (default 100)
5849 global
5850 {not available when compiled without the |+mzscheme|
5851 feature}
5852 The number of milliseconds between polls for MzScheme threads.
5853 Negative or zero value means no thread scheduling.
5854 NOTE: This option is set to the Vim default value when 'compatible'
5855 is reset.
5856
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005857 *'mzschemedll'*
5858'mzschemedll' string (default depends on the build)
5859 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005860 {only available when compiled with the |+mzscheme/dyn|
5861 feature}
5862 Specifies the name of the MzScheme shared library. The default is
5863 DYNAMIC_MZSCH_DLL which was specified at compile time.
5864 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005865 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005866 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005867 This option cannot be set from a |modeline| or in the |sandbox|, for
5868 security reasons.
5869
5870 *'mzschemegcdll'*
5871'mzschemegcdll' string (default depends on the build)
5872 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005873 {only available when compiled with the |+mzscheme/dyn|
5874 feature}
5875 Specifies the name of the MzScheme GC shared library. The default is
5876 DYNAMIC_MZGC_DLL which was specified at compile time.
5877 The value can be equal to 'mzschemedll' if it includes the GC code.
5878 Environment variables are expanded |:set_env|.
5879 This option cannot be set from a |modeline| or in the |sandbox|, for
5880 security reasons.
5881
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005883'nrformats' 'nf' string (default "bin,octal,hex",
5884 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 This defines what bases Vim will consider for numbers when using the
5887 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5888 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005889 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005891 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005892 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005894 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895 considered to be hexadecimal. Example: Using CTRL-X on
5896 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005897 bin If included, numbers starting with "0b" or "0B" will be
5898 considered to be binary. Example: Using CTRL-X on
5899 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005900 unsigned If included, numbers are recognized as unsigned. Thus a
5901 leading dash or negative sign won't be considered as part of
5902 the number. Examples:
5903 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5904 (without "unsigned" it would become "9-2021").
5905 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5906 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005907 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5908 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909 Numbers which simply begin with a digit in the range 1-9 are always
5910 considered decimal. This also happens for numbers that are not
5911 recognized as octal or hex.
5912
5913 *'number'* *'nu'* *'nonumber'* *'nonu'*
5914'number' 'nu' boolean (default off)
5915 local to window
5916 Print the line number in front of each line. When the 'n' option is
5917 excluded from 'cpoptions' a wrapped line will not use the column of
5918 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005919 The 'numberwidth' option can be used to set the room used for the line
5920 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 When a long, wrapped line doesn't start with the first character, '-'
5922 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005923 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5924 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005925 *number_relativenumber*
5926 The 'relativenumber' option changes the displayed number to be
5927 relative to the cursor. Together with 'number' there are these
5928 four combinations (cursor in line 3):
5929
Bram Moolenaar3848e002016-03-19 18:42:29 +01005930 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005931 'nornu' 'nornu' 'rnu' 'rnu'
5932
5933 |apple | 1 apple | 2 apple | 2 apple
5934 |pear | 2 pear | 1 pear | 1 pear
5935 |nobody | 3 nobody | 0 nobody |3 nobody
5936 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005938 *'numberwidth'* *'nuw'*
5939'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5940 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005941 {only available when compiled with the |+linebreak|
5942 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005943 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005944 when the 'number' or 'relativenumber' option is set or printing lines
5945 with a line number. Since one space is always between the number and
5946 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005947 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005948 fit the highest line number in the buffer respectively the number of
5949 rows in the window, depending on whether 'number' or 'relativenumber'
5950 is set. Thus with the Vim default of 4 there is room for a line number
5951 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005952 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005953 NOTE: This option is set to the Vi default value when 'compatible' is
5954 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005955
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005956 *'omnifunc'* *'ofu'*
5957'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005958 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005959 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005960 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005961 This option specifies a function to be used for Insert mode omni
5962 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005963 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005964 invoked and what it should return. The value can be the name of a
5965 function, a |lambda| or a |Funcref|. See |option-value-function| for
5966 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005967 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005968 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005969 This option cannot be set from a |modeline| or in the |sandbox|, for
5970 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005971
Bram Moolenaar02467872007-05-06 13:22:01 +00005972 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005973'opendevice' 'odev' boolean (default off)
5974 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005975 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005976 Enable reading and writing from devices. This may get Vim stuck on a
5977 device that can be opened but doesn't actually do the I/O. Therefore
5978 it is off by default.
5979 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5980 result in editing a device.
5981
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005982 *'operatorfunc'* *'opfunc'*
5983'operatorfunc' 'opfunc' string (default: empty)
5984 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005985 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005986 See |:map-operator| for more info and an example. The value can be
5987 the name of a function, a |lambda| or a |Funcref|. See
5988 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005989
5990 This option cannot be set from a |modeline| or in the |sandbox|, for
5991 security reasons.
5992
Bram Moolenaar251e1912011-06-19 05:09:16 +02005993 *'osfiletype'* *'oft'*
5994'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005996 This option was supported on RISC OS, which has been removed.
5997
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005998 *'packpath'* *'pp'*
5999'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006000 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006001 This option cannot be set from a |modeline| or in the |sandbox|, for
6002 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006003
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006005'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 global
6007 Specifies the nroff macros that separate paragraphs. These are pairs
6008 of two letters (see |object-motions|).
6009
6010 *'paste'* *'nopaste'*
6011'paste' boolean (default off)
6012 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006013 Put Vim in Paste mode. This is useful if you want to cut or copy
6014 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 unexpected effects.
6016 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006017 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 knows about pasting and will mostly do the right thing without 'paste'
6019 being set. The same is true for a terminal where Vim handles the
6020 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006021 This option is reset when starting the GUI. Thus if you set it in
6022 your .vimrc it will work in a terminal, but not in the GUI. Setting
6023 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6024 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025 When the 'paste' option is switched on (also when it was already on):
6026 - mapping in Insert mode and Command-line mode is disabled
6027 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006029 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006030 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 - 'revins' is reset
6032 - 'ruler' is reset
6033 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006034 - 'smarttab' is reset
6035 - 'softtabstop' is set to 0
6036 - 'textwidth' is set to 0
6037 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006038 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006041 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006042 - 'indentexpr'
6043 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006044 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 NOTE: When you start editing another file while the 'paste' option is
6046 on, settings from the modelines or autocommands may change the
6047 settings again, causing trouble when pasting text. You might want to
6048 set the 'paste' option again.
6049 When the 'paste' option is reset the mentioned options are restored to
6050 the value before the moment 'paste' was switched from off to on.
6051 Resetting 'paste' before ever setting it does not have any effect.
6052 Since mapping doesn't work while 'paste' is active, you need to use
6053 the 'pastetoggle' option to toggle the 'paste' option with some key.
6054
6055 *'pastetoggle'* *'pt'*
6056'pastetoggle' 'pt' string (default "")
6057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058 When non-empty, specifies the key sequence that toggles the 'paste'
6059 option. This is like specifying a mapping: >
6060 :map {keys} :set invpaste<CR>
6061< Where {keys} is the value of 'pastetoggle'.
6062 The difference is that it will work even when 'paste' is set.
6063 'pastetoggle' works in Insert mode and Normal mode, but not in
6064 Command-line mode.
6065 Mappings are checked first, thus overrule 'pastetoggle'. However,
6066 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6067 this: >
6068 :map <F10> :set paste<CR>
6069 :map <F11> :set nopaste<CR>
6070 :imap <F10> <C-O>:set paste<CR>
6071 :imap <F11> <nop>
6072 :set pastetoggle=<F11>
6073< This will make <F10> start paste mode and <F11> stop paste mode.
6074 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6075 mode everything is inserted literally, except the 'pastetoggle' key
6076 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006077 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078
6079 *'pex'* *'patchexpr'*
6080'patchexpr' 'pex' string (default "")
6081 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 {not available when compiled without the |+diff|
6083 feature}
6084 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006085 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006086 This option cannot be set from a |modeline| or in the |sandbox|, for
6087 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088
Bram Moolenaardbc28022014-07-26 13:40:44 +02006089 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090'patchmode' 'pm' string (default "")
6091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 When non-empty the oldest version of a file is kept. This can be used
6093 to keep the original version of a file if you are changing files in a
6094 source distribution. Only the first time that a file is written a
6095 copy of the original file will be kept. The name of the copy is the
6096 name of the original file with the string in the 'patchmode' option
6097 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006098 ".orig" or ".org". 'backupdir' must not be empty for this to work
6099 (Detail: The backup file is renamed to the patchmode file after the
6100 new file has been successfully written, that's why it must be possible
6101 to write a backup file). If there was no file to be backed up, an
6102 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 When the 'backupskip' pattern matches, a patchmode file is not made.
6104 Using 'patchmode' for compressed files appends the extension at the
6105 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6106 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006107 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006109 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 other systems: ".,,")
6112 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006114 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6115 provided that the file being searched for has a relative path (not
6116 starting with "/", "./" or "../"). The directories in the 'path'
6117 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 - Use commas to separate directory names: >
6119 :set path=.,/usr/local/include,/usr/include
6120< - Spaces can also be used to separate directory names (for backwards
6121 compatibility with version 3.0). To have a space in a directory
6122 name, precede it with an extra backslash, and escape the space: >
6123 :set path=.,/dir/with\\\ space
6124< - To include a comma in a directory name precede it with an extra
6125 backslash: >
6126 :set path=.,/dir/with\\,comma
6127< - To search relative to the directory of the current file, use: >
6128 :set path=.
6129< - To search in the current directory use an empty string between two
6130 commas: >
6131 :set path=,,
6132< - A directory name may end in a ':' or '/'.
6133 - Environment variables are expanded |:set_env|.
6134 - When using |netrw.vim| URLs can be used. For example, adding
6135 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006136 - Search upwards and downwards in a directory tree using "*", "**" and
6137 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 - Careful with '\' characters, type two to get one in the option: >
6139 :set path=.,c:\\include
6140< Or just use '/' instead: >
6141 :set path=.,c:/include
6142< Don't forget "." or files won't even be found in the same directory as
6143 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006144 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 it is something like 256 or 1024 characters.
6146 You can check if all the include files are found, using the value of
6147 'path', see |:checkpath|.
6148 The use of |:set+=| and |:set-=| is preferred when adding or removing
6149 directories from the list. This avoids problems when a future version
6150 uses another default. To remove the current directory use: >
6151 :set path-=
6152< To add the current directory use: >
6153 :set path+=
6154< To use an environment variable, you probably need to replace the
6155 separator. Here is an example to append $INCL, in which directory
6156 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006157 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158< Replace the ';' with a ':' or whatever separator is used. Note that
6159 this doesn't work when $INCL contains a comma or white space.
6160
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006161 *'perldll'*
6162'perldll' string (default depends on the build)
6163 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006164 {only available when compiled with the |+perl/dyn|
6165 feature}
6166 Specifies the name of the Perl shared library. The default is
6167 DYNAMIC_PERL_DLL, which was specified at compile time.
6168 Environment variables are expanded |:set_env|.
6169 This option cannot be set from a |modeline| or in the |sandbox|, for
6170 security reasons.
6171
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6173'preserveindent' 'pi' boolean (default off)
6174 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 When changing the indent of the current line, preserve as much of the
6176 indent structure as possible. Normally the indent is replaced by a
6177 series of tabs followed by spaces as required (unless |'expandtab'| is
6178 enabled, in which case only spaces are used). Enabling this option
6179 means the indent will preserve as many existing characters as possible
6180 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006181 'expandtab' does not apply to the preserved white space, a Tab remains
6182 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 NOTE: When using ">>" multiple times the resulting indent is a mix of
6184 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006185 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 Also see 'copyindent'.
6187 Use |:retab| to clean up white space.
6188
6189 *'previewheight'* *'pvh'*
6190'previewheight' 'pvh' number (default 12)
6191 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006192 {not available when compiled without the |+quickfix|
6193 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006195 commands. Used for |CTRL-W_}| when no count is given. Not used when
6196 'previewpopup' is set.
6197
6198 *'previewpopup'* *'pvp'*
6199'previewpopup' 'pvp' string (default empty)
6200 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006201 {not available when compiled without the |+textprop|
6202 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006203 When not empty a popup window is used for commands that would open a
6204 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006205 Not used for the insert completion info, add "popup" to
6206 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207
6208 *'previewwindow'* *'nopreviewwindow'*
6209 *'pvw'* *'nopvw'* *E590*
6210'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006211 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006212 {not available when compiled without the |+quickfix|
6213 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006214 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 set. It's normally not set directly, but by using one of the commands
6216 |:ptag|, |:pedit|, etc.
6217
6218 *'printdevice'* *'pdev'*
6219'printdevice' 'pdev' string (default empty)
6220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221 {only available when compiled with the |+printer|
6222 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006223 The name of the printer to be used for |:hardcopy|.
6224 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006225 This option cannot be set from a |modeline| or in the |sandbox|, for
6226 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227
Bram Moolenaar8299df92004-07-10 09:47:34 +00006228 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006229'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 {only available when compiled with the |+printer|
6232 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006233 Sets the character encoding used when printing.
6234 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235
6236 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006237'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 {only available when compiled with the |+printer|
6240 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006241 Expression used to print the PostScript produced with |:hardcopy|.
6242 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006243 This option cannot be set from a |modeline| or in the |sandbox|, for
6244 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245
Bram Moolenaar8299df92004-07-10 09:47:34 +00006246 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247'printfont' 'pfn' string (default "courier")
6248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 {only available when compiled with the |+printer|
6250 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006251 The name of the font that will be used for |:hardcopy|.
6252 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253
6254 *'printheader'* *'pheader'*
6255'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 {only available when compiled with the |+printer|
6258 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006259 The format of the header produced in |:hardcopy| output.
6260 See |pheader-option|.
6261
6262 *'printmbcharset'* *'pmbcs'*
6263'printmbcharset' 'pmbcs' string (default "")
6264 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006265 {only available when compiled with the |+printer|
6266 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006267 The CJK character set to be used for CJK output from |:hardcopy|.
6268 See |pmbcs-option|.
6269
6270 *'printmbfont'* *'pmbfn'*
6271'printmbfont' 'pmbfn' string (default "")
6272 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006273 {only available when compiled with the |+printer|
6274 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006275 List of font names to be used for CJK output from |:hardcopy|.
6276 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277
6278 *'printoptions'* *'popt'*
6279'printoptions' 'popt' string (default "")
6280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006282 List of items that control the format of the output of |:hardcopy|.
6283 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006285 *'prompt'* *'noprompt'*
6286'prompt' boolean (default on)
6287 global
6288 When on a ":" prompt is used in Ex mode.
6289
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006290 *'pumheight'* *'ph'*
6291'pumheight' 'ph' number (default 0)
6292 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006293 Determines the maximum number of items to show in the popup menu for
6294 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006295 |ins-completion-menu|.
6296
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006297 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006298'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006299 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006300 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006301 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006302
Bram Moolenaard94464e2015-11-02 15:28:18 +01006303 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006304'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006305 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006306 {only available when compiled with the |+python/dyn|
6307 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006308 Specifies the name of the Python 2.x shared library. The default is
6309 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006310 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006311 This option cannot be set from a |modeline| or in the |sandbox|, for
6312 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006313
Bram Moolenaar94073162018-01-31 21:49:05 +01006314 *'pythonhome'*
6315'pythonhome' string (default "")
6316 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006317 {only available when compiled with the |+python/dyn|
6318 feature}
6319 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6320 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6321 which was specified at compile time, will be used for the Python 2.x
6322 home directory.
6323 Environment variables are expanded |:set_env|.
6324 This option cannot be set from a |modeline| or in the |sandbox|, for
6325 security reasons.
6326
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006327 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006328'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006329 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006330 {only available when compiled with the |+python3/dyn|
6331 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006332 Specifies the name of the Python 3 shared library. The default is
6333 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006334 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006335 This option cannot be set from a |modeline| or in the |sandbox|, for
6336 security reasons.
6337
Bram Moolenaar94073162018-01-31 21:49:05 +01006338 *'pythonthreehome'*
6339'pythonthreehome' string (default "")
6340 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006341 {only available when compiled with the |+python3/dyn|
6342 feature}
6343 Specifies the name of the Python 3 home directory. When
6344 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6345 PYTHON3_HOME, which was specified at compile time, will be used for
6346 the Python 3 home directory.
6347 Environment variables are expanded |:set_env|.
6348 This option cannot be set from a |modeline| or in the |sandbox|, for
6349 security reasons.
6350
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006351 *'pyxversion'* *'pyx'*
6352'pyxversion' 'pyx' number (default depends on the build)
6353 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006354 {only available when compiled with the |+python| or
6355 the |+python3| feature}
6356 Specifies the python version used for pyx* functions and commands
6357 |python_x|. The default value is as follows:
6358
6359 Compiled with Default ~
6360 |+python| and |+python3| 0
6361 only |+python| 2
6362 only |+python3| 3
6363
6364 Available values are 0, 2 and 3.
6365 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6366 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6367 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6368 to 2 if Python 2 is available.
6369 See also: |has-pythonx|
6370
6371 If Vim is compiled with only |+python| or |+python3| setting
6372 'pyxversion' has no effect. The pyx* functions and commands are
6373 always the same as the compiled version.
6374
6375 This option cannot be set from a |modeline| or in the |sandbox|, for
6376 security reasons.
6377
Bram Moolenaar858ba062020-05-31 23:11:59 +02006378 *'quickfixtextfunc'* *'qftf'*
6379'quickfixtextfunc' 'qftf' string (default "")
6380 global
6381 {only available when compiled with the |+quickfix|
6382 feature}
6383 This option specifies a function to be used to get the text to display
6384 in the quickfix and location list windows. This can be used to
6385 customize the information displayed in the quickfix or location window
6386 for each entry in the corresponding quickfix or location list. See
6387 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006388 function and an example. The value can be the name of a function, a
6389 |lambda| or a |Funcref|. See |option-value-function| for more
6390 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006391
6392 This option cannot be set from a |modeline| or in the |sandbox|, for
6393 security reasons.
6394
Bram Moolenaar677ee682005-01-27 14:41:15 +00006395 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006396'quoteescape' 'qe' string (default "\")
6397 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006398 The characters that are used to escape quotes in a string. Used for
6399 objects like a', a" and a` |a'|.
6400 When one of the characters in this option is found inside a string,
6401 the following character will be skipped. The default value makes the
6402 text "foo\"bar\\" considered to be one string.
6403
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6405'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006406 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 If on, writes fail unless you use a '!'. Protects you from
6408 accidentally overwriting a file. Default on when Vim is started
6409 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006410 When using ":w!" the 'readonly' option is reset for the current
6411 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006412 When using the ":view" command the 'readonly' option is set for the
6413 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006414 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006416 *'redrawtime'* *'rdt'*
6417'redrawtime' 'rdt' number (default 2000)
6418 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006419 {only available when compiled with the |+reltime|
6420 feature}
6421 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006422 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006423 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006424 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006425 matches will be highlighted.
6426 For syntax highlighting the time applies per window. When over the
6427 limit syntax highlighting is disabled until |CTRL-L| is used.
6428 This is used to avoid that Vim hangs when using a very complicated
6429 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006430
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006431 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006432'regexpengine' 're' number (default 0)
6433 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006434 This selects the default regexp engine. |two-engines|
6435 The possible values are:
6436 0 automatic selection
6437 1 old engine
6438 2 NFA engine
6439 Note that when using the NFA engine and the pattern contains something
6440 that is not supported the pattern will not match. This is only useful
6441 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006442 Using automatic selection enables Vim to switch the engine, if the
6443 default engine becomes too costly. E.g., when the NFA engine uses too
6444 many states. This should prevent Vim from hanging on a combination of
6445 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006446
Bram Moolenaar64486672010-05-16 15:46:46 +02006447 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6448'relativenumber' 'rnu' boolean (default off)
6449 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006450 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006451 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006452 precede some vertical motion commands (e.g. j k + -) with, without
6453 having to calculate it yourself. Especially useful in combination with
6454 other commands (e.g. y d c < > gq gw =).
6455 When the 'n' option is excluded from 'cpoptions' a wrapped
6456 line will not use the column of line numbers (this is the default when
6457 'compatible' isn't set).
6458 The 'numberwidth' option can be used to set the room used for the line
6459 number.
6460 When a long, wrapped line doesn't start with the first character, '-'
6461 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006462 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6463 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006464
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006465 The number in front of the cursor line also depends on the value of
6466 'number', see |number_relativenumber| for all combinations of the two
6467 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006468
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 *'remap'* *'noremap'*
6470'remap' boolean (default on)
6471 global
6472 Allows for mappings to work recursively. If you do not want this for
6473 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006474 NOTE: To avoid portability problems with Vim scripts, always keep
6475 this option at the default "on". Only switch it off when working with
6476 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477
zeertzjqd086b8f2024-02-25 15:42:52 +08006478 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006479'renderoptions' 'rop' string (default: empty)
6480 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006481 {only available when compiled with GUI and DIRECTX on
6482 MS-Windows}
6483 Select a text renderer and set its options. The options depend on the
6484 renderer.
6485
6486 Syntax: >
6487 set rop=type:{renderer}(,{name}:{value})*
6488<
6489 Currently, only one optional renderer is available.
6490
6491 render behavior ~
6492 directx Vim will draw text using DirectX (DirectWrite). It makes
6493 drawn glyphs more beautiful than default GDI.
6494 It requires 'encoding' is "utf-8", and only works on
6495 MS-Windows Vista or newer version.
6496
6497 Options:
6498 name meaning type value ~
6499 gamma gamma float 1.0 - 2.2 (maybe)
6500 contrast enhancedContrast float (unknown)
6501 level clearTypeLevel float (unknown)
6502 geom pixelGeometry int 0 - 2 (see below)
6503 renmode renderingMode int 0 - 6 (see below)
6504 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006505 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006506
Bram Moolenaar92467d32017-12-05 13:22:16 +01006507 See this URL for detail (except for scrlines):
6508 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006509
6510 For geom: structure of a device pixel.
6511 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6512 1 - DWRITE_PIXEL_GEOMETRY_RGB
6513 2 - DWRITE_PIXEL_GEOMETRY_BGR
6514
6515 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006516 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006517
6518 For renmode: method of rendering glyphs.
6519 0 - DWRITE_RENDERING_MODE_DEFAULT
6520 1 - DWRITE_RENDERING_MODE_ALIASED
6521 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6522 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6523 4 - DWRITE_RENDERING_MODE_NATURAL
6524 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6525 6 - DWRITE_RENDERING_MODE_OUTLINE
6526
6527 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006528 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006529
6530 For taamode: antialiasing mode used for drawing text.
6531 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6532 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6533 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6534 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6535
6536 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006537 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6538
Bram Moolenaara338adc2018-01-31 20:51:47 +01006539 For scrlines:
6540 This was used for optimizing scrolling behavior, however this
6541 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006542
6543 Example: >
6544 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006545 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006546 set rop=type:directx
6547<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006548 If select a raster font (Courier, Terminal or FixedSys which
6549 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006550 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006551
6552 NOTE: It is known that some fonts and options combination
6553 causes trouble on drawing glyphs.
6554
Bram Moolenaar92467d32017-12-05 13:22:16 +01006555 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006556 special made fonts (True-Type fonts which includes only
6557 bitmap glyphs).
6558 - 'taamode:3' will not work with some vector fonts.
6559
6560 NOTE: With this option, you can display colored emoji
6561 (emoticon) in Windows 8.1 or later. To display colored emoji,
6562 there are some conditions which you should notice.
6563
6564 - If your font includes non-colored emoji already, it will
6565 be used.
6566 - If your font doesn't have emoji, the system chooses an
6567 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6568 will be used.
6569 - When this alternative font didn't have fixed width glyph,
6570 emoji might be rendered beyond the bounding box of drawing
6571 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006572
6573 Other render types are currently not supported.
6574
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 *'report'*
6576'report' number (default 2)
6577 global
6578 Threshold for reporting number of lines changed. When the number of
6579 changed lines is more than 'report' a message will be given for most
6580 ":" commands. If you want it always, set 'report' to 0.
6581 For the ":substitute" command the number of substitutions is used
6582 instead of the number of lines.
6583
6584 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6585'restorescreen' 'rs' boolean (default on)
6586 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006587 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 When set, the screen contents is restored when exiting Vim. This also
6589 happens when executing external commands.
6590
6591 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6592 options in your .vimrc. To disable restoring:
6593 set t_ti= t_te=
6594 To enable restoring (for an xterm):
6595 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6596 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6597
6598 *'revins'* *'ri'* *'norevins'* *'nori'*
6599'revins' 'ri' boolean (default off)
6600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 {only available when compiled with the |+rightleft|
6602 feature}
6603 Inserting characters in Insert mode will work backwards. See "typing
6604 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6605 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006606 NOTE: This option is reset when 'compatible' is set.
6607 This option is reset when 'paste' is set and restored when 'paste' is
6608 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609
6610 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6611'rightleft' 'rl' boolean (default off)
6612 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 {only available when compiled with the |+rightleft|
6614 feature}
6615 When on, display orientation becomes right-to-left, i.e., characters
6616 that are stored in the file appear from the right to the left.
6617 Using this option, it is possible to edit files for languages that
6618 are written from the right to the left such as Hebrew and Arabic.
6619 This option is per window, so it is possible to edit mixed files
6620 simultaneously, or to view the same file in both ways (this is
6621 useful whenever you have a mixed text file with both right-to-left
6622 and left-to-right strings so that both sets are displayed properly
6623 in different windows). Also see |rileft.txt|.
6624
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006625 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626'rightleftcmd' 'rlc' string (default "search")
6627 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 {only available when compiled with the |+rightleft|
6629 feature}
6630 Each word in this option enables the command line editing to work in
6631 right-to-left mode for a group of commands:
6632
6633 search "/" and "?" commands
6634
6635 This is useful for languages such as Hebrew, Arabic and Farsi.
6636 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6637
Bram Moolenaard94464e2015-11-02 15:28:18 +01006638 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006639'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006640 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006641 {only available when compiled with the |+ruby/dyn|
6642 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006643 Specifies the name of the Ruby shared library. The default is
6644 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006645 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006646 This option cannot be set from a |modeline| or in the |sandbox|, for
6647 security reasons.
6648
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006650'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006653 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 text in the file is shown on the far right:
6655 Top first line is visible
6656 Bot last line is visible
6657 All first and last line are visible
6658 45% relative position in the file
6659 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006660 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006661 ruler is shown there. Otherwise it is shown in the last line of the
6662 screen. If the statusline is given by 'statusline' (i.e. not empty),
6663 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006665 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 the text column (byte number) and the screen column are shown,
6667 separated with a dash.
6668 For an empty line "0-1" is shown.
6669 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006670 This option is reset when 'paste' is set and restored when 'paste' is
6671 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 If you don't want to see the ruler all the time but want to know where
6673 you are, use "g CTRL-G" |g_CTRL-G|.
6674 NOTE: This option is reset when 'compatible' is set.
6675
6676 *'rulerformat'* *'ruf'*
6677'rulerformat' 'ruf' string (default empty)
6678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 {not available when compiled without the |+statusline|
6680 feature}
6681 When this option is not empty, it determines the content of the ruler
6682 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006683 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006684 This option cannot be set in a modeline when 'modelineexpr' is off.
6685
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 The default ruler width is 17 characters. To make the ruler 15
6687 characters wide, put "%15(" at the start and "%)" at the end.
6688 Example: >
6689 :set rulerformat=%15(%c%V\ %p%%%)
6690<
6691 *'runtimepath'* *'rtp'* *vimfiles*
6692'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006693 Unix: "$HOME/.vim or
6694 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 $VIM/vimfiles,
6696 $VIMRUNTIME,
6697 $VIM/vimfiles/after,
6698 $HOME/.vim/after"
6699 Amiga: "home:vimfiles,
6700 $VIM/vimfiles,
6701 $VIMRUNTIME,
6702 $VIM/vimfiles/after,
6703 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006704 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 $VIM/vimfiles,
6706 $VIMRUNTIME,
6707 $VIM/vimfiles/after,
6708 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006709 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 $VIMRUNTIME,
6711 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006712 Haiku: "$BE_USER_SETTINGS/vim,
6713 $VIM/vimfiles,
6714 $VIMRUNTIME,
6715 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006716 $BE_USER_SETTINGS/vim/after"
6717 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 $VIM/vimfiles,
6719 $VIMRUNTIME,
6720 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006721 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 This is a list of directories which will be searched for runtime
6724 files:
6725 filetype.vim filetypes by file name |new-filetype|
6726 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006727 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 colors/ color scheme files |:colorscheme|
6729 compiler/ compiler files |:compiler|
6730 doc/ documentation |write-local-help|
6731 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006732 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 indent/ indent scripts |indent-expression|
6734 keymap/ key mapping files |mbyte-keymap|
6735 lang/ menu translations |:menutrans|
6736 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006737 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 plugin/ plugin scripts |write-plugin|
6739 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006740 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 syntax/ syntax files |mysyntaxfile|
6742 tutor/ files for vimtutor |tutor|
6743
6744 And any other file searched for with the |:runtime| command.
6745
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006746 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6747
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 The defaults for most systems are setup to search five locations:
6749 1. In your home directory, for your personal preferences.
6750 2. In a system-wide Vim directory, for preferences from the system
6751 administrator.
6752 3. In $VIMRUNTIME, for files distributed with Vim.
6753 *after-directory*
6754 4. In the "after" directory in the system-wide Vim directory. This is
6755 for the system administrator to overrule or add to the distributed
6756 defaults (rarely needed)
6757 5. In the "after" directory in your home directory. This is for
6758 personal preferences to overrule or add to the distributed defaults
6759 or system-wide settings (rarely needed).
6760
Bram Moolenaard0796902016-09-16 20:02:31 +02006761 More entries are added when using |packages|. If it gets very long
6762 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6763 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006764
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6766 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006767 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 wildcards.
6769 See |:runtime|.
6770 Example: >
6771 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6772< This will use the directory "~/vimruntime" first (containing your
6773 personal Vim runtime files), then "/mygroup/vim" (shared between a
6774 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6775 files).
6776 You probably should always include $VIMRUNTIME somewhere, to use the
6777 distributed runtime files. You can put a directory before $VIMRUNTIME
6778 to find files which replace a distributed runtime files. You can put
6779 a directory after $VIMRUNTIME to find files which add to distributed
6780 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006781 When Vim is started with |--clean| the home directory entries are not
6782 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 This option cannot be set from a |modeline| or in the |sandbox|, for
6784 security reasons.
6785
6786 *'scroll'* *'scr'*
6787'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006788 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6790 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006791 changes. This may happen when enabling the |status-line| or
6792 'tabline' option after setting the 'scroll' option.
6793 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006794 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006795 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796
6797 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6798'scrollbind' 'scb' boolean (default off)
6799 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006800 See also |scroll-binding|. When this option is set, scrolling the
6801 current window also scrolls other scrollbind windows (windows that
6802 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 differences between two versions of a file, see 'diff'.
6804 See |'scrollopt'| for options that determine how this option should be
6805 interpreted.
6806 This option is mostly reset when splitting a window to edit another
6807 file. This means that ":split | edit file" results in two windows
6808 with scroll-binding, but ":split file" does not.
6809
Bram Moolenaarae20f342019-11-05 21:09:23 +01006810 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6811'scrollfocus' 'scf' boolean (default off)
6812 global
6813 {only for MS-Windows GUI}
6814 When using the scroll wheel and this option is set, the window under
6815 the mouse pointer is scrolled. With this option off the current
6816 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006817 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006818
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 *'scrolljump'* *'sj'*
6820'scrolljump' 'sj' number (default 1)
6821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 Minimal number of lines to scroll when the cursor gets off the
6823 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6824 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006825 When set to a negative number from -1 to -100 this is used as the
6826 percentage of the window height. Thus -50 scrolls half the window
6827 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 NOTE: This option is set to 1 when 'compatible' is set.
6829
6830 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006831'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006832 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 Minimal number of screen lines to keep above and below the cursor.
6834 This will make some context visible around where you are working. If
6835 you set it to a very large value (999) the cursor line will always be
6836 in the middle of the window (except at the start or end of the file or
6837 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006838 After using the local value, go back the global value with one of
6839 these two: >
6840 setlocal scrolloff<
6841 setlocal scrolloff=-1
6842< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 NOTE: This option is set to 0 when 'compatible' is set.
6844
6845 *'scrollopt'* *'sbo'*
6846'scrollopt' 'sbo' string (default "ver,jump")
6847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006849 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6850 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 The following words are available:
6852 ver Bind vertical scrolling for 'scrollbind' windows
6853 hor Bind horizontal scrolling for 'scrollbind' windows
6854 jump Applies to the offset between two windows for vertical
6855 scrolling. This offset is the difference in the first
6856 displayed line of the bound windows. When moving
6857 around in a window, another 'scrollbind' window may
6858 reach a position before the start or after the end of
6859 the buffer. The offset is not changed though, when
6860 moving back the 'scrollbind' window will try to scroll
6861 to the desired position when possible.
6862 When now making that window the current one, two
6863 things can be done with the relative offset:
6864 1. When "jump" is not included, the relative offset is
6865 adjusted for the scroll position in the new current
6866 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006867 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 2. When "jump" is included, the other windows are
6869 scrolled to keep the same relative offset. When
6870 going back to the other window, it still uses the
6871 same relative offset.
6872 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006873 When 'diff' mode is active there always is vertical scroll binding,
6874 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875
6876 *'sections'* *'sect'*
6877'sections' 'sect' string (default "SHNHH HUnhsh")
6878 global
6879 Specifies the nroff macros that separate sections. These are pairs of
6880 two letters (See |object-motions|). The default makes a section start
6881 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6882
6883 *'secure'* *'nosecure'* *E523*
6884'secure' boolean (default off)
6885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 When on, ":autocmd", shell and write commands are not allowed in
6887 ".vimrc" and ".exrc" in the current directory and map commands are
6888 displayed. Switch it off only if you know that you will not run into
6889 problems, or when the 'exrc' option is off. On Unix this option is
6890 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006891 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 'secure' at the end of your ~/.vimrc then.
6893 This option cannot be set from a |modeline| or in the |sandbox|, for
6894 security reasons.
6895
6896 *'selection'* *'sel'*
6897'selection' 'sel' string (default "inclusive")
6898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 This option defines the behavior of the selection. It is only used
6900 in Visual and Select mode.
6901 Possible values:
6902 value past line inclusive ~
6903 old no yes
6904 inclusive yes yes
6905 exclusive yes no
6906 "past line" means that the cursor is allowed to be positioned one
6907 character past the line.
6908 "inclusive" means that the last character of the selection is included
6909 in an operation. For example, when "x" is used to delete the
6910 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006911 When "old" is used and 'virtualedit' allows the cursor to move past
6912 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 Note that when "exclusive" is used and selecting from the end
6914 backwards, you cannot include the last character of a line, when
6915 starting in Normal mode and 'virtualedit' empty.
6916
6917 The 'selection' option is set by the |:behave| command.
6918
6919 *'selectmode'* *'slm'*
6920'selectmode' 'slm' string (default "")
6921 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006922 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 Select mode instead of Visual mode, when a selection is started.
6924 Possible values:
6925 mouse when using the mouse
6926 key when using shifted special keys
6927 cmd when using "v", "V" or CTRL-V
6928 See |Select-mode|.
6929 The 'selectmode' option is set by the |:behave| command.
6930
6931 *'sessionoptions'* *'ssop'*
6932'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006933 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006935 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 feature}
6937 Changes the effect of the |:mksession| command. It is a comma
6938 separated list of words. Each word enables saving and restoring
6939 something:
6940 word save and restore ~
6941 blank empty windows
6942 buffers hidden and unloaded buffers, not just those in windows
6943 curdir the current directory
6944 folds manually created folds, opened/closed folds and local
6945 fold options
6946 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006947 and contain at least one lowercase letter. Only
6948 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 help the help window
6950 localoptions options and mappings local to a window or buffer (not
6951 global values for local options)
6952 options all options and mappings (also global values for local
6953 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006954 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 resize size of the Vim window: 'lines' and 'columns'
6956 sesdir the directory in which the session file is located
6957 will become the current directory (useful with
6958 projects accessed over a network from different
6959 systems)
6960 slash backslashes in file names replaced with forward
6961 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006962 tabpages all tab pages; without this only the current tab page
6963 is restored, so that you can make a session for each
6964 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006965 terminal include terminal windows where the command can be
6966 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 unix with Unix end-of-line format (single <NL>), even when
6968 on Windows or DOS
6969 winpos position of the whole Vim window
6970 winsize window sizes
6971
6972 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006973 When neither "curdir" nor "sesdir" is included, file names are stored
6974 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006975 If you leave out "options" many things won't work well after restoring
6976 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 "slash" and "unix" are useful on Windows when sharing session files
6978 with Unix. The Unix version of Vim cannot source dos format scripts,
6979 but the Windows version of Vim can source unix format scripts.
6980
6981 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006982'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 global
6984 Name of the shell to use for ! and :! commands. When changing the
6985 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6986 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006987 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 See |option-backslash| about including spaces and backslashes.
6989 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006990
Bram Moolenaara2baa732022-02-04 16:09:54 +00006991 In |restricted-mode| shell commands will not be possible. This mode
6992 is used if the value of $SHELL ends in "false" or "nologin".
6993
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006994 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006995 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6997< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006998 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007000 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007002 Example with escaped space (Vim will do this when initializing the
7003 option from $SHELL): >
7004 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007005< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007006 backslashes are consumed by `:set`.
7007
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 Under MS-Windows, when the executable ends in ".com" it must be
7009 included. Thus setting the shell to "command.com" or "4dos.com"
7010 works, but "command" and "4dos" do not work for all commands (e.g.,
7011 filtering).
7012 For unknown reasons, when using "4dos.com" the current directory is
7013 changed to "C:\". To avoid this set 'shell' like this: >
7014 :set shell=command.com\ /c\ 4dos
7015< This option cannot be set from a |modeline| or in the |sandbox|, for
7016 security reasons.
7017
7018 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007019'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007020 Win32, when 'shell' contains "powershell":
7021 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007022 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007025 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7026 For MS-Windows, the default is set according to the value of 'shell',
7027 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007028 On Unix it can have more than one flag. Each white space separated
7029 part is passed as an argument to the shell command.
7030 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007031 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 This option cannot be set from a |modeline| or in the |sandbox|, for
7033 security reasons.
7034
7035 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007036'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7037 "2>&1| tee", or
7038 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 {not available when compiled without the |+quickfix|
7041 feature}
7042 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007043 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 including spaces and backslashes.
7045 The name of the temporary file can be represented by "%s" if necessary
7046 (the file name is appended automatically if no %s appears in the value
7047 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007048 For the Amiga the default is ">". For MS-Windows using powershell the
7049 default is "2>&1 | Out-File -Encoding default", otherwise the default
7050 is ">%s 2>&1". The output is directly saved in a file and not echoed
7051 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007052 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 in a file and echoed to the screen. If the 'shell' option is "csh" or
7054 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007055 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007056 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7057 means that stderr is also included. Before using the 'shell' option a
7058 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007059 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7060 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 The initialization of this option is done after reading the ".vimrc"
7062 and the other initializations, so that when the 'shell' option is set
7063 there, the 'shellpipe' option changes automatically, unless it was
7064 explicitly set before.
7065 When 'shellpipe' is set to an empty string, no redirection of the
7066 ":make" output will be done. This is useful if you use a 'makeprg'
7067 that writes to 'makeef' by itself. If you want no piping, but do
7068 want to include the 'makeef', set 'shellpipe' to a single space.
7069 Don't forget to precede the space with a backslash: ":set sp=\ ".
7070 In the future pipes may be used for filtering and this option will
7071 become obsolete (at least for Unix).
7072 This option cannot be set from a |modeline| or in the |sandbox|, for
7073 security reasons.
7074
7075 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007076'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 Quoting character(s), put around the command passed to the shell, for
7079 the "!" and ":!" commands. The redirection is kept outside of the
7080 quoting. See 'shellxquote' to include the redirection. It's
7081 probably not useful to set both options.
7082 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007083 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007084 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085 This option cannot be set from a |modeline| or in the |sandbox|, for
7086 security reasons.
7087
7088 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007089'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7090 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 String to be used to put the output of a filter command in a temporary
7093 file. See also |:!|. See |option-backslash| about including spaces
7094 and backslashes.
7095 The name of the temporary file can be represented by "%s" if necessary
7096 (the file name is appended automatically if no %s appears in the value
7097 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007098 The default is ">". For Unix, if the 'shell' option is "csh" or
7099 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007100 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007101 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7102 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007103 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7104 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007105 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7106 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 The initialization of this option is done after reading the ".vimrc"
7108 and the other initializations, so that when the 'shell' option is set
7109 there, the 'shellredir' option changes automatically unless it was
7110 explicitly set before.
7111 In the future pipes may be used for filtering and this option will
7112 become obsolete (at least for Unix).
7113 This option cannot be set from a |modeline| or in the |sandbox|, for
7114 security reasons.
7115
7116 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7117'shellslash' 'ssl' boolean (default off)
7118 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007119 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007121 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007122 powershell.exe. Backward slashes can still be typed, but they are
7123 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 Note that setting or resetting this option has no effect for some
7125 existing file names, thus this option needs to be set before opening
7126 any file for best results. This might change in the future.
7127 'shellslash' only works when a backslash can be used as a path
7128 separator. To test if this is so use: >
7129 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007130< Also see 'completeslash'.
7131
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007132 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7133'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7134 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007135 When on, use temp files for shell commands. When off use a pipe.
7136 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007137 Currently a pipe is only supported on Unix and MS-Windows 2K and
7138 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007139 :if has("filterpipe")
7140< The advantage of using a pipe is that nobody can read the temp file
7141 and the 'shell' command does not need to support redirection.
7142 The advantage of using a temp file is that the file type and encoding
7143 can be detected.
7144 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7145 |FilterWritePost| autocommands event are not triggered when
7146 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007147 The `system()` function does not respect this option and always uses
7148 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007149 NOTE: This option is set to the Vim default value when 'compatible'
7150 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007151
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 *'shelltype'* *'st'*
7153'shelltype' 'st' number (default 0)
7154 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007155 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 On the Amiga this option influences the way how the commands work
7157 which use a shell.
7158 0 and 1: always use the shell
7159 2 and 3: use the shell only to filter lines
7160 4 and 5: use shell only for ':sh' command
7161 When not using the shell, the command is executed directly.
7162
7163 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7164 1 and 3: use "shell cmd" to start external commands
7165
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007166 *'shellxescape'* *'sxe'*
7167'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007168 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007169 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007170 When 'shellxquote' is set to "(" then the characters listed in this
7171 option will be escaped with a '^' character. This makes it possible
7172 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007173 This option cannot be set from a |modeline| or in the |sandbox|, for
7174 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007175
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 *'shellxquote'* *'sxq'*
7177'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007178 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007179 for Win32, when 'shell' is
7180 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007181 for Win32, when 'shell' contains "sh"
7182 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 for Unix, when using system(): "\"")
7184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 Quoting character(s), put around the command passed to the shell, for
7186 the "!" and ":!" commands. Includes the redirection. See
7187 'shellquote' to exclude the redirection. It's probably not useful
7188 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007189 When the value is '(' then ')' is appended. When the value is '"('
7190 then ')"' is appended.
7191 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007192 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007193 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7194 pwsh.exe which automatically strips off the first and last quote on a
7195 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7196 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007197 'shell', to reduce the need to set this option by the user. See
7198 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 This option cannot be set from a |modeline| or in the |sandbox|, for
7200 security reasons.
7201
7202 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7203'shiftround' 'sr' boolean (default off)
7204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 Round indent to multiple of 'shiftwidth'. Applies to > and <
7206 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7207 a multiple of 'shiftwidth' (this is Vi compatible).
7208 NOTE: This option is reset when 'compatible' is set.
7209
7210 *'shiftwidth'* *'sw'*
7211'shiftwidth' 'sw' number (default 8)
7212 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007213 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007215 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007216 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217
7218 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007219'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7220 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007221 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 This option helps to avoid all the |hit-enter| prompts caused by file
7223 messages, for example with CTRL-G, and to avoid some other messages.
7224 It is a list of flags:
7225 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007226 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7227 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7228 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7229 m use "[+]" instead of "[Modified]" *shm-m*
7230 n use "[New]" instead of "[New File]" *shm-n*
7231 r use "[RO]" instead of "[readonly]" *shm-r*
7232 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007234 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7235 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007236 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007237 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007239 o overwrite message for writing a file with subsequent *shm-o*
7240 message for reading a file (useful for ":wn" or when
7241 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007242 O message for reading a file overwrites any previous *shm-O*
7243 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007244 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7245 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007246 the search count do not show "W" before the count message
7247 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007248 t truncate file message at the start if it is too long *shm-t*
7249 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007250 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007251 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007252 long to fit on the command line; "..." will appear in the
7253 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007254 W don't give "written" or "[w]" when writing a file *shm-W*
7255 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007256 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007257 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007258 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007259 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007260 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7261 match", "Pattern not found", "Back at original", etc.
7262 C don't give messages while scanning for ins-completion *shm-C*
7263 items, for instance "scanning tags"
7264 q use "recording" instead of "recording @a" *shm-q*
7265 F don't give the file info when editing a file, like *shm-F*
7266 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007267 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007268 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007269 "[1/5]". When the "S" flag is not present (e.g. search count
7270 is shown), the "search hit BOTTOM, continuing at TOP" and
7271 "search hit TOP, continuing at BOTTOM" messages are only
7272 indicated by a "W" (Mnemonic: Wrapped) letter before the
7273 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274
7275 This gives you the opportunity to avoid that a change between buffers
7276 requires you to hit <Enter>, but still gives as useful a message as
7277 possible for the space available. To get the whole message that you
7278 would have got with 'shm' empty, use ":file!"
7279 Useful values:
7280 shm= No abbreviation of message.
7281 shm=a Abbreviation, but no loss of information.
7282 shm=at Abbreviation, and truncate message when necessary.
7283
7284 NOTE: This option is set to the Vi default value when 'compatible' is
7285 set and to the Vim default value when 'compatible' is reset.
7286
7287 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7288'shortname' 'sn' boolean (default off)
7289 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 Filenames are assumed to be 8 characters plus one extension of 3
7291 characters. Multiple dots in file names are not allowed. When this
7292 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007293 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007295 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296
7297 *'showbreak'* *'sbr'* *E595*
7298'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007299 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007300 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 feature}
7302 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007303 values are "> " or "+++ ": >
7304 :set showbreak=>\
7305< Note the backslash to escape the trailing space. It's easier like
7306 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007307 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007308< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 comma (in a future version the comma might be used to separate the
7310 part that is shown at the end and at the start of a line).
7311 The characters are highlighted according to the '@' flag in
7312 'highlight'.
7313 Note that tabs after the showbreak will be displayed differently.
7314 If you want the 'showbreak' to appear in between line numbers, add the
7315 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007316 A window-local value overrules a global value. If the global value is
7317 set and you want no value in the current window use NONE: >
7318 :setlocal showbreak=NONE
7319<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007321'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7322 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007324 Show (partial) command in the last line of the screen. Set this
7325 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 In Visual mode the size of the selected area is shown:
7327 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007328 If the number of bytes is different it is also displayed: "2-6"
7329 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007331 - When selecting a block, the size in screen characters:
7332 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007333 This information can be displayed in an alternative location using the
7334 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 NOTE: This option is set to the Vi default value when 'compatible' is
7336 set and to the Vim default value when 'compatible' is reset.
7337
Luuk van Baalba936f62022-12-15 13:15:39 +00007338 *'showcmdloc'* *'sloc'*
7339'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007340 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007341 This option can be used to display the (partially) entered command in
7342 another location. Possible values are:
7343 last Last line of the screen (default).
7344 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007345 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007346 Setting this option to "statusline" or "tabline" means that these will
7347 be redrawn whenever the command changes, which can be on every key
7348 pressed.
7349 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7350 place the text. Without a custom 'statusline' or 'tabline' it will be
7351 displayed in a convenient location.
7352
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7354'showfulltag' 'sft' boolean (default off)
7355 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 When completing a word in insert mode (see |ins-completion|) from the
7357 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007358 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 matched a C function, you can see a template for what arguments are
7360 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007361 Note that this doesn't work well together with having "longest" in
7362 'completeopt', because the completion from the search pattern may not
7363 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364
7365 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7366'showmatch' 'sm' boolean (default off)
7367 global
7368 When a bracket is inserted, briefly jump to the matching one. The
7369 jump is only done if the match can be seen on the screen. The time to
7370 show the match can be set with 'matchtime'.
7371 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007372 seen or not).
7373 This option is reset when 'paste' is set and restored when 'paste' is
7374 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 When the 'm' flag is not included in 'cpoptions', typing a character
7376 will immediately move the cursor back to where it belongs.
7377 See the "sm" field in 'guicursor' for setting the cursor shape and
7378 blinking when showing the match.
7379 The 'matchpairs' option can be used to specify the characters to show
7380 matches for. 'rightleft' and 'revins' are used to look for opposite
7381 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007382 Also see the matchparen plugin for highlighting the match when moving
7383 around |pi_paren.txt|.
7384 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385
7386 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7387'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7388 global
7389 If in Insert, Replace or Visual mode put a message on the last line.
7390 Use the 'M' flag in 'highlight' to set the type of highlighting for
7391 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007392 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 doesn't mean XIM is really active, especially when 'imactivatekey' is
7394 not set.
7395 NOTE: This option is set to the Vi default value when 'compatible' is
7396 set and to the Vim default value when 'compatible' is reset.
7397
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007398 *'showtabline'* *'stal'*
7399'showtabline' 'stal' number (default 1)
7400 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007401 The value of this option specifies when the line with tab page labels
7402 will be displayed:
7403 0: never
7404 1: only if there are at least two tab pages
7405 2: always
7406 This is both for the GUI and non-GUI implementation of the tab pages
7407 line.
7408 See |tab-page| for more information about tab pages.
7409
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 *'sidescroll'* *'ss'*
7411'sidescroll' 'ss' number (default 0)
7412 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 The minimal number of columns to scroll horizontally. Used only when
7414 the 'wrap' option is off and the cursor is moved off of the screen.
7415 When it is zero the cursor will be put in the middle of the screen.
7416 When using a slow terminal set it to a large number or 0. When using
7417 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7418 commands.
7419
7420 *'sidescrolloff'* *'siso'*
7421'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007422 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007424 right of the cursor if 'nowrap' is set. Setting this option to a
7425 value greater than 0 while having |'sidescroll'| also at a non-zero
7426 value makes some context visible in the line you are scrolling in
7427 horizontally (except at beginning of the line). Setting this option
7428 to a large value (like 999) has the effect of keeping the cursor
7429 horizontally centered in the window, as long as one does not come too
7430 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007431 After using the local value, go back the global value with one of
7432 these two: >
7433 setlocal sidescrolloff<
7434 setlocal sidescrolloff=-1
7435< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436
7437 Example: Try this together with 'sidescroll' and 'listchars' as
7438 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007439 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440
7441 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7442 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007443<
7444 *'signcolumn'* *'scl'*
7445'signcolumn' 'scl' string (default "auto")
7446 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007447 {not available when compiled without the |+signs|
7448 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007449 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007450 "auto" only when there is a sign to display
7451 "no" never
7452 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007453 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007454 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7457'smartcase' 'scs' boolean (default off)
7458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459 Override the 'ignorecase' option if the search pattern contains upper
7460 case characters. Only used when the search pattern is typed and
7461 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007462 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7464 recalling the search pattern from history and hitting <Enter>.
7465 NOTE: This option is reset when 'compatible' is set.
7466
7467 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7468'smartindent' 'si' boolean (default off)
7469 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 Do smart autoindenting when starting a new line. Works for C-like
7471 programs, but can also be used for other languages. 'cindent' does
7472 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007473 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007474 setting 'si' has no effect. 'indentexpr' is a more advanced
7475 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 Normally 'autoindent' should also be on when using 'smartindent'.
7477 An indent is automatically inserted:
7478 - After a line ending in '{'.
7479 - After a line starting with a keyword from 'cinwords'.
7480 - Before a line starting with '}' (only with the "O" command).
7481 When typing '}' as the first character in a new line, that line is
7482 given the same indent as the matching '{'.
7483 When typing '#' as the first character in a new line, the indent for
7484 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007485 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7487 When using the ">>" command, lines starting with '#' are not shifted
7488 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007489 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007490 This option is reset when 'paste' is set and restored when 'paste' is
7491 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492
7493 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7494'smarttab' 'sta' boolean (default off)
7495 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007497 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7498 <BS> will delete a 'shiftwidth' worth of space at the start of the
7499 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007500 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007501 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7502 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007503 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007505 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007506 This option is reset when 'paste' is set and restored when 'paste' is
7507 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 NOTE: This option is reset when 'compatible' is set.
7509
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007510 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7511'smoothscroll' 'sms' boolean (default off)
7512 local to window
7513 Scrolling works with screen lines. When 'wrap' is set and the first
7514 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007515 above the window. "<<<" is displayed at the start of the first line,
7516 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007517 You may also want to add "lastline" to the 'display' option to show as
7518 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007519 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007520
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 *'softtabstop'* *'sts'*
7522'softtabstop' 'sts' number (default 0)
7523 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 Number of spaces that a <Tab> counts for while performing editing
7525 operations, like inserting a <Tab> or using <BS>. It "feels" like
7526 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7527 used. This is useful to keep the 'ts' setting at its standard value
7528 of 8, while being able to edit like it is set to 'sts'. However,
7529 commands like "x" still work on the actual characters.
7530 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007531 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007532 'softtabstop' is set to 0 when the 'paste' option is set and restored
7533 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7535 spaces is minimized by using <Tab>s.
7536 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7537 set.
7538 NOTE: This option is set to 0 when 'compatible' is set.
7539
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007540 If Vim is compiled with the |+vartabs| feature then the value of
7541 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7542 anything other than an empty string.
7543
Bram Moolenaar217ad922005-03-20 22:37:15 +00007544 *'spell'* *'nospell'*
7545'spell' boolean (default off)
7546 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007547 {not available when compiled without the |+syntax|
7548 feature}
7549 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007550 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007551
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007552 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007553'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007554 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007555 {not available when compiled without the |+syntax|
7556 feature}
7557 Pattern to locate the end of a sentence. The following word will be
7558 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007559 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007560 When this check is not wanted make this option empty.
7561 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007562 Be careful with special characters, see |option-backslash| about
7563 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007564 To set this option automatically depending on the language, see
7565 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007566
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007567 *'spellfile'* *'spf'*
7568'spellfile' 'spf' string (default empty)
7569 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007570 {not available when compiled without the |+syntax|
7571 feature}
7572 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007573 commands. It must end in ".{encoding}.add". You need to include the
7574 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007575 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007576 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007577 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007578 |zg| and |zw| commands can be used to access each. This allows using
7579 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007580 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007581 you: Using the first directory in 'runtimepath' that is writable. If
7582 there is no "spell" directory yet it will be created. For the file
7583 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007584 ignoring the region.
7585 The resulting ".spl" file will be used for spell checking, it does not
7586 have to appear in 'spelllang'.
7587 Normally one file is used for all regions, but you can add the region
7588 name if you want to. However, it will then only be used when
7589 'spellfile' is set to it, for entries in 'spelllang' only files
7590 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007591 This option cannot be set from a |modeline| or in the |sandbox|, for
7592 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007593
Bram Moolenaar217ad922005-03-20 22:37:15 +00007594 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007595'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007596 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007597 {not available when compiled without the |+syntax|
7598 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007599 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007600 on spellchecking will be done for these languages. Example: >
7601 set spelllang=en_us,nl,medical
7602< This means US English, Dutch and medical words are recognized. Words
7603 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007604 The word list name must consist of alphanumeric characters, a dash or
7605 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007606 recommended to separate the two letter language name from a
7607 specification. Thus "en-rare" is used for rare English words.
7608 A region name must come last and have the form "_xx", where "xx" is
7609 the two-letter, lower case region name. You can use more than one
7610 region by listing them: "en_us,en_ca" supports both US and Canadian
7611 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007612 Britain. (Note: currently en_au and en_nz dictionaries are older than
7613 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007614 If the name "cjk" is included East Asian characters are excluded from
7615 spell checking. This is useful when editing text that also has Asian
7616 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007617 Note that the "medical" dictionary does not exist, it is just an
7618 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007619 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007620 As a special case the name of a .spl file can be given as-is. The
7621 first "_xx" in the name is removed and used as the region name
7622 (_xx is an underscore, two letters and followed by a non-letter).
7623 This is mainly for testing purposes. You must make sure the correct
7624 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007625 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007626 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7627 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007628 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007629
Bram Moolenaar98692072006-02-04 00:57:42 +00007630 If the |spellfile.vim| plugin is active and you use a language name
7631 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7632 will ask you if you want to download the file.
7633
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007634 After this option has been set successfully, Vim will source the files
7635 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007636 up to the first character that is not an ASCII letter or number and
7637 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007638
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007639 *'spelloptions'* *'spo'*
7640'spelloptions' 'spo' string (default "")
7641 local to buffer
7642 {not available when compiled without the |+syntax|
7643 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007644 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007645 camel When a word is CamelCased, assume "Cased" is a
7646 separate word: every upper-case character in a word
7647 that comes after a lower case character indicates the
7648 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007649
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007650 *'spellsuggest'* *'sps'*
7651'spellsuggest' 'sps' string (default "best")
7652 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007653 {not available when compiled without the |+syntax|
7654 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007655 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007656 the |spellsuggest()| function. This is a comma-separated list of
7657 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007658
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007659 best Internal method that works best for English. Finds
7660 changes like "fast" and uses a bit of sound-a-like
7661 scoring to improve the ordering.
7662
7663 double Internal method that uses two methods and mixes the
7664 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007665 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007666 word. That only works when the language specifies
7667 sound folding. Can be slow and doesn't always give
7668 better results.
7669
7670 fast Internal method that only checks for simple changes:
7671 character inserts/deletes/swaps. Works well for
7672 simple typing mistakes.
7673
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007674 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007675 Not used for |spellsuggest()|. The number of
7676 suggestions is never more than the value of 'lines'
7677 minus two.
7678
Bram Moolenaar585ee072022-01-29 11:22:17 +00007679 timeout:{millisec} Limit the time searching for suggestions to
7680 {millisec} milli seconds. Applies to the following
7681 methods. When omitted the limit is 5000. When
7682 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007683 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007684
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007685 file:{filename} Read file {filename}, which must have two columns,
7686 separated by a slash. The first column contains the
7687 bad word, the second column the suggested good word.
7688 Example:
7689 theribal/terrible ~
7690 Use this for common mistakes that do not appear at the
7691 top of the suggestion list with the internal methods.
7692 Lines without a slash are ignored, use this for
7693 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007694 The word in the second column must be correct,
7695 otherwise it will not be used. Add the word to an
7696 ".add" file if it is currently flagged as a spelling
7697 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007698 The file is used for all languages.
7699
7700 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007701 trouble with spaces. Best is to call a function
7702 without arguments, see |expr-option-function|.
7703 |v:val| holds the badly spelled word. The expression
7704 must evaluate to a List of Lists, each with a
7705 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007706 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007707 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007708 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007709 internal methods use. A lower score is better.
7710 This may invoke |spellsuggest()| if you temporarily
7711 set 'spellsuggest' to exclude the "expr:" part.
7712 Errors are silently ignored, unless you set the
7713 'verbose' option to a non-zero value.
7714
7715 Only one of "best", "double" or "fast" may be used. The others may
7716 appear several times in any order. Example: >
7717 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7718<
7719 This option cannot be set from a |modeline| or in the |sandbox|, for
7720 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007721
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7723'splitbelow' 'sb' boolean (default off)
7724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 When on, splitting a window will put the new window below the current
7726 one. |:split|
7727
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007728 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007729'splitkeep' 'spk' string (default "cursor")
7730 global
7731 The value of this option determines the scroll behavior when opening,
7732 closing or resizing horizontal splits.
7733
7734 Possible values are:
7735 cursor Keep the same relative cursor position.
7736 screen Keep the text on the same screen line.
7737 topline Keep the topline the same.
7738
7739 For the "screen" and "topline" values, the cursor position will be
7740 changed when necessary. In this case, the jumplist will be populated
7741 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007742 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007743
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7745'splitright' 'spr' boolean (default off)
7746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 When on, splitting a window will put the new window right of the
7748 current one. |:vsplit|
7749
7750 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7751'startofline' 'sol' boolean (default on)
7752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007754 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007755 (if possible). This applies to the commands:
7756 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7757 - "d", "<<" and ">>" with a linewise operator
7758 - "%" with a count
7759 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7760 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 In case of buffer changing commands the cursor is placed at the column
7762 where it was the last time the buffer was edited.
7763 NOTE: This option is set when 'compatible' is set.
7764
Bram Moolenaar00654022011-02-25 14:42:19 +01007765 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007767 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 {not available when compiled without the |+statusline|
7769 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007770 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771 Also see |status-line|.
7772
7773 The option consists of printf style '%' items interspersed with
7774 normal text. Each status line item is of the form:
7775 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007776 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007777 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007778
Bram Moolenaar238a5642006-02-21 22:12:05 +00007779 When the option starts with "%!" then it is used as an expression,
7780 evaluated and the result is used as the option value. Example: >
7781 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007782< The *g:statusline_winid* variable will be set to the |window-ID| of the
7783 window that the status line belongs to.
7784 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007785 Note that the "%!" expression is evaluated in the context of the
7786 current window and buffer, while %{} items are evaluated in the
7787 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007788
7789 When there is error while evaluating the option then it will be made
7790 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007791 When the result contains unprintable characters the result is
7792 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007793
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794 Note that the only effect of 'ruler' when this option is set (and
7795 'laststatus' is 2) is controlling the output of |CTRL-G|.
7796
7797 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007798 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007800 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801 minwid Minimum width of the item, padding as set by '-' & '0'.
7802 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007803 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007804 on the left for text items. Numeric items will be
7805 shifted down to maxwid-2 digits followed by '>'number
7806 where number is the amount of missing digits, much like
7807 an exponential notation.
7808 item A one letter code as described below.
7809
7810 Following is a description of the possible statusline items. The
7811 second character in "item" is the type:
7812 N for number
7813 S for string
7814 F for flags as described below
7815 - not applicable
7816
7817 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007818 f S Path to the file in the buffer, as typed or relative to current
7819 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 F S Full path to the file in the buffer.
7821 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007822 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007824 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007826 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007828 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007830 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007832 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7834 being used: "<keymap>"
7835 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007836 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 B N As above, in hexadecimal.
7838 o N Byte number in file of byte under cursor, first byte is 1.
7839 Mnemonic: Offset from start of file (with one added)
7840 {not available when compiled without |+byte_offset| feature}
7841 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007842 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 l N Line number.
7844 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007845 c N Column number (byte index).
7846 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007847 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 p N Percentage through file in lines as in |CTRL-G|.
7849 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007850 percentage described for 'ruler'. Always 3 in length, unless
7851 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007852 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007853 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007855 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007856 Note that there is no '%' before the closing '}'. The
7857 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007858 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007859 {% - This is almost same as { except the result of the expression is
7860 re-evaluated as a statusline format string. Thus if the
7861 return value of expr contains % items they will get expanded.
7862 The expression can contain the } character, the end of
7863 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007864 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007865 func! Stl_filename() abort
7866 return "%t"
7867 endfunc
7868< `stl=%{Stl_filename()}` results in `"%t"`
7869 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007870 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 ( - Start of item group. Can be used for setting the width and
7872 alignment of a section. Must be followed by %) somewhere.
7873 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007874 T N For 'tabline': start of tab page N label. Use %T after the last
7875 label. This information is used for mouse clicks.
7876 X N For 'tabline': start of close tab N label. Use %X after the
7877 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7878 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 < - Where to truncate line if too long. Default is at the start.
7880 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007881 = - Separation point between alignment sections. Each section will
7882 be separated by an equal number of spaces. With one %= what
7883 comes after it will be right-aligned. With two %= there is a
7884 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007886 # - Set highlight group. The name must follow and then a # again.
7887 Thus use %#HLname# for highlight group HLname. The same
7888 highlighting is used, also for the statusline of non-current
7889 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007891 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007892 The difference between User{N} and StatusLine will be applied to
7893 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 The number N must be between 1 and 9. See |hl-User1..9|
7895
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007896 When displaying a flag, Vim removes the leading comma, if any, when
7897 that flag comes right after plaintext. This will make a nice display
7898 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899
Bram Moolenaar582fd852005-03-28 20:58:01 +00007900 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 not set) and a minwid is not set for the group, the whole group will
7902 become empty. This will make a group like the following disappear
7903 completely from the statusline when none of the flags are set. >
7904 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007905< Beware that an expression is evaluated each and every time the status
7906 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007907 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007908 While evaluating %{} the current buffer and current window will be set
7909 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007910 currently being drawn. The expression will evaluate in this context.
7911 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7912 real current buffer and "g:actual_curwin" to the |window-ID| of the
7913 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007914
Bram Moolenaar30b65812012-07-12 22:01:11 +02007915 The 'statusline' option will be evaluated in the |sandbox| if set from
7916 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007917 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007918
7919 It is not allowed to change text or jump to another window while
7920 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921
7922 If the statusline is not updated when you want it (e.g., after setting
7923 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007924 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007926 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 Otherwise the result is taken as flag text and applied to the rules
7928 described above.
7929
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007930 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007932 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933
7934 Examples:
7935 Emulate standard status line with 'ruler' set >
7936 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7937< Similar, but add ASCII value of char under the cursor (like "ga") >
7938 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7939< Display byte count and byte value, modified flag in red. >
7940 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7941 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7942< Display a ,GZ flag if a compressed file is loaded >
7943 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7944< In the |:autocmd|'s: >
7945 :let b:gzflag = 1
7946< And: >
7947 :unlet b:gzflag
7948< And define this function: >
7949 :function VarExists(var, val)
7950 : if exists(a:var) | return a:val | else | return '' | endif
7951 :endfunction
7952<
7953 *'suffixes'* *'su'*
7954'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 Files with these suffixes get a lower priority when multiple files
7957 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007958 suffixes. Spaces after the comma are ignored. A dot is also seen as
7959 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 separator, precede it with a backslash (see |option-backslash| about
7961 including spaces and backslashes).
7962 See 'wildignore' for completely ignoring files.
7963 The use of |:set+=| and |:set-=| is preferred when adding or removing
7964 suffixes from the list. This avoids problems when a future version
7965 uses another default.
7966
7967 *'suffixesadd'* *'sua'*
7968'suffixesadd' 'sua' string (default "")
7969 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007970 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 file for the "gf", "[I", etc. commands. Example: >
7972 :set suffixesadd=.java
7973<
7974 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7975'swapfile' 'swf' boolean (default on)
7976 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007977 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 swapfile is not wanted for a specific buffer. For example, with
7979 confidential information that even root must not be able to access.
7980 Careful: All text will be in memory:
7981 - Don't use this for big files.
7982 - Recovery will be impossible!
7983 A swapfile will only be present when |'updatecount'| is non-zero and
7984 'swapfile' is set.
7985 When 'swapfile' is reset, the swap file for the current buffer is
7986 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7987 non-zero, a swap file is immediately created.
7988 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007989 If you want to open a new buffer without creating a swap file for it,
7990 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007991 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007992
7993 This option is used together with 'bufhidden' and 'buftype' to
7994 specify special kinds of buffers. See |special-buffers|.
7995
7996 *'swapsync'* *'sws'*
7997'swapsync' 'sws' string (default "fsync")
7998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008000 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 When this option is empty parts of the swap file may be in memory and
8002 not written to disk. When the system crashes you may lose more work.
8003 On Unix the system does a sync now and then without Vim asking for it,
8004 so the disadvantage of setting this option off is small. On some
8005 systems the swap file will not be written at all. For a unix system
8006 setting it to "sync" will use the sync() call instead of the default
8007 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008008 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009
8010 *'switchbuf'* *'swb'*
8011'switchbuf' 'swb' string (default "")
8012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008014 This option is checked, when
8015 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008016 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008017 - jumping to a tag using the |:stag| command.
8018 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8019 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8020 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008021 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008022 useopen If included, jump to the first open window in the
8023 current tab page that contains the specified buffer
8024 (if there is one). Otherwise: Do not examine other
8025 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008026 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008027 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008029 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008030 Otherwise: do not split, use current window (when used
8031 in the quickfix window: the previously used window or
8032 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008033 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008034 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008035 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008036 uselast If included, jump to the previously used window when
8037 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008038 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8039 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008041 *'synmaxcol'* *'smc'*
8042'synmaxcol' 'smc' number (default 3000)
8043 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008044 {not available when compiled without the |+syntax|
8045 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008046 Maximum column in which to search for syntax items. In long lines the
8047 text after this column is not highlighted and following lines may not
8048 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008049 This helps to avoid very slow redrawing for an XML file that is one
8050 long line.
8051 Set to zero to remove the limit.
8052
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053 *'syntax'* *'syn'*
8054'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008055 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 {not available when compiled without the |+syntax|
8057 feature}
8058 When this option is set, the syntax with this name is loaded, unless
8059 syntax highlighting has been switched off with ":syntax off".
8060 Otherwise this option does not always reflect the current syntax (the
8061 b:current_syntax variable does).
8062 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008063 not automatically recognized. Example, in an IDL file:
8064 /* vim: set syntax=idl : */ ~
8065 When a dot appears in the value then this separates two filetype
8066 names. Example:
8067 /* vim: set syntax=c.doxygen : */ ~
8068 This will use the "c" syntax first, then the "doxygen" syntax.
8069 Note that the second one must be prepared to be loaded as an addition,
8070 otherwise it will be skipped. More than one dot may appear.
8071 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 :set syntax=OFF
8073< To switch syntax highlighting on according to the current value of the
8074 'filetype' option: >
8075 :set syntax=ON
8076< What actually happens when setting the 'syntax' option is that the
8077 Syntax autocommand event is triggered with the value as argument.
8078 This option is not copied to another buffer, independent of the 's' or
8079 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008080 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008082 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008083'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008084 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008085 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008086 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008087 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008088
8089 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008090 option and only when there is no GUI tab line. When 'e' is in
8091 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008092 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008093
8094 The value is evaluated like with 'statusline'. You can use
8095 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008096 the text to be displayed. Use "%1T" for the first label, "%2T" for
8097 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008098
Bram Moolenaare12bab32019-01-08 22:02:56 +01008099 When changing something that is used in 'tabline' that does not
8100 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008101 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008102
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008103 Keep in mind that only one of the tab pages is the current one, others
8104 are invisible and you can't jump to their windows.
8105
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008106 *'tabpagemax'* *'tpm'*
8107'tabpagemax' 'tpm' number (default 10)
8108 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008109 Maximum number of tab pages to be opened by the |-p| command line
8110 argument or the ":tab all" command. |tabpage|
8111
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008112 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113'tabstop' 'ts' number (default 8)
8114 local to buffer
8115 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008116 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117
8118 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008119 appear wrong in many places, e.g., when printing it.
8120 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008122 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8124 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008125 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008127 This is the recommended way, the file will look the same with other
8128 tools and when listing it in a terminal.
8129 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8130 'expandtab'. This way you will always insert spaces. The
8131 formatting will never be messed up when 'tabstop' is changed (leave
8132 it at 8 just in case). The file will be a bit larger.
8133 You do need to check if no Tabs exist in the file. You can get rid
8134 of them by first setting 'expandtab' and using `%retab!`, making
8135 sure the value of 'tabstop' is set correctly.
8136 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 'expandtab'. This way you will always insert spaces. The
8138 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008139 You do need to check if no Tabs exist in the file, just like in the
8140 item just above.
8141 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008142 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008143 works when using Vim to edit the file, other tools assume a tabstop
8144 is worth 8 spaces.
8145 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 'noexpandtab'. This should then work (for initial indents only)
8147 for any tabstop setting that people use. It might be nice to have
8148 tabs after the first non-blank inserted as spaces if you do this
8149 though. Otherwise aligned comments will be wrong when 'tabstop' is
8150 changed.
8151
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008152 If Vim is compiled with the |+vartabs| feature then the value of
8153 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8154 than an empty string.
8155
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8157'tagbsearch' 'tbs' boolean (default on)
8158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008160 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161 searching makes searching for a tag a LOT faster, but a linear search
8162 will find more tags if the tags file wasn't properly sorted.
8163 Vim normally assumes that your tags files are sorted, or indicate that
8164 they are not sorted. Only when this is not the case does the
8165 'tagbsearch' option need to be switched off.
8166
8167 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008168 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 certain files, or retry all files with a linear search. When
8170 'tagbsearch' is off, only a linear search is done.
8171
8172 Linear searching is done anyway, for one file, when Vim finds a line
8173 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008174 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175< [The whitespace before and after the '0' must be a single <Tab>]
8176
8177 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008178 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 instead of a normal tag name, a retry is done with a linear search.
8180 Tags in unsorted tags files, and matches with different case will only
8181 be found in the retry.
8182
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008183 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008184 linear search can be avoided when case is ignored. Use a value of '2'
8185 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8186 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008187 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8188 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8189 used for this as well. Note that case must be folded to uppercase for
8190 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008191
8192 By default, tag searches are case-sensitive. Case is ignored when
8193 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8194 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008195 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8196 'tagcase' is "smart", and the pattern contains only lowercase
8197 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198
8199 When 'tagbsearch' is off, tags searching is slower when a full match
8200 exists, but faster when no full match exists. Tags in unsorted tags
8201 files may only be found with 'tagbsearch' off.
8202 When the tags file is not sorted, or sorted in a wrong way (not on
8203 ASCII byte value), 'tagbsearch' should be off, or the line given above
8204 must be included in the tags file.
8205 This option doesn't affect commands that find all matching tags (e.g.,
8206 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008208 *'tagcase'* *'tc'*
8209'tagcase' 'tc' string (default "followic")
8210 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008211 This option specifies how case is handled when searching the tags
8212 file:
8213 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008214 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008215 ignore Ignore case
8216 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008217 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008218 NOTE: This option is set to the Vi default value when 'compatible' is
8219 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008220
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008221 *'tagfunc'* *'tfu'*
8222'tagfunc' 'tfu' string (default: empty)
8223 local to buffer
8224 {not available when compiled without the |+eval|
8225 feature}
8226 This option specifies a function to be used to perform tag searches.
8227 The function gets the tag pattern and should return a List of matching
8228 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008229 function and an example. The value can be the name of a function, a
8230 |lambda| or a |Funcref|. See |option-value-function| for more
8231 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008232 This option cannot be set from a |modeline| or in the |sandbox|, for
8233 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008234
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 *'taglength'* *'tl'*
8236'taglength' 'tl' number (default 0)
8237 global
8238 If non-zero, tags are significant up to this number of characters.
8239
8240 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8241'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8242 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008243 If on and using a tags file in another directory, file names in that
8244 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245 NOTE: This option is set to the Vi default value when 'compatible' is
8246 set and to the Vim default value when 'compatible' is reset.
8247
8248 *'tags'* *'tag'* *E433*
8249'tags' 'tag' string (default "./tags,tags", when compiled with
8250 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8251 global or local to buffer |global-local|
8252 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008253 include a space or comma in a file name, precede it with backslashes
8254 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255 When a file name starts with "./", the '.' is replaced with the path
8256 of the current file. But only when the 'd' flag is not included in
8257 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8258 |tags-option|.
8259 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008260 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8261 find all files named "tags" below "/lib". The filename itself cannot
8262 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008263 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008264 The |tagfiles()| function can be used to get a list of the file names
8265 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8267 files are also supported. They are automatically recognized. The
8268 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8269 differences are ignored (MS-Windows). |emacs-tags|
8270 The use of |:set+=| and |:set-=| is preferred when adding or removing
8271 file names from the list. This avoids problems when a future version
8272 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273
8274 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8275'tagstack' 'tgst' boolean (default on)
8276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277 When on, the |tagstack| is used normally. When off, a ":tag" or
8278 ":tselect" command with an argument will not push the tag onto the
8279 tagstack. A following ":tag" without an argument, a ":pop" command or
8280 any other command that uses the tagstack will use the unmodified
8281 tagstack, but does change the pointer to the active entry.
8282 Resetting this option is useful when using a ":tag" command in a
8283 mapping which should not change the tagstack.
8284
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008285 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008286'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008287 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008288 {only available when compiled with the |+tcl/dyn|
8289 feature}
8290 Specifies the name of the Tcl shared library. The default is
8291 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008292 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008293 This option cannot be set from a |modeline| or in the |sandbox|, for
8294 security reasons.
8295
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 *'term'* *E529* *E530* *E531*
8297'term' string (default is $TERM, if that fails:
8298 in the GUI: "builtin_gui"
8299 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008300 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 on Unix: "ansi"
8303 on VMS: "ansi"
8304 on Win 32: "win32")
8305 global
8306 Name of the terminal. Used for choosing the terminal control
8307 characters. Environment variables are expanded |:set_env|.
8308 For example: >
8309 :set term=$TERM
8310< See |termcap|.
8311
8312 *'termbidi'* *'tbidi'*
8313 *'notermbidi'* *'notbidi'*
8314'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 {only available when compiled with the |+arabic|
8317 feature}
8318 The terminal is in charge of Bi-directionality of text (as specified
8319 by Unicode). The terminal is also expected to do the required shaping
8320 that some languages (such as Arabic) require.
8321 Setting this option implies that 'rightleft' will not be set when
8322 'arabic' is set and the value of 'arabicshape' will be ignored.
8323 Note that setting 'termbidi' has the immediate effect that
8324 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8325 This option is reset when the GUI is started.
8326 For further details see |arabic.txt|.
8327
8328 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008329'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 Encoding used for the terminal. This specifies what character
8332 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008333 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008334 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008335 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008336 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8338 Any attempts to set a different value will be rejected, and an error
8339 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008340 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 because the Win32 system always passes Unicode characters.
8342 When empty, the same encoding is used as for the 'encoding' option.
8343 This is the normal value.
8344 Not all combinations for 'termencoding' and 'encoding' are valid. See
8345 |encoding-table|.
8346 The value for this option must be supported by internal conversions or
8347 iconv(). When this is not possible no conversion will be done and you
8348 will probably experience problems with non-ASCII characters.
8349 Example: You are working with the locale set to euc-jp (Japanese) and
8350 want to edit a UTF-8 file: >
8351 :let &termencoding = &encoding
8352 :set encoding=utf-8
8353< You need to do this when your system has no locale support for UTF-8.
8354
Bram Moolenaar938ae282023-02-20 20:44:55 +00008355 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008356'termguicolors' 'tgc' boolean (default off)
8357 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008358 {not available when compiled without the
8359 |+termguicolors| feature}
8360 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008361 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008362
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008363 Requires a ISO-8613-3 compatible terminal. If setting this option
8364 does not work (produces a colorless UI) reading |xterm-true-color|
8365 might help.
8366
8367 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8368 is required. Use this check to find out: >
8369 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008370< This requires Vim to be built with the |+vtp| feature.
8371
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008372 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008373
8374 When using Vim with Windows Terminal, the background of Windows
8375 Terminal is normally filled with the Vim background color. Setting
8376 'termguicolors' and the guibg of the Normal highlight group to NONE
8377 will make the background transparent: >
8378 :hi Normal guibg=NONE
8379<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008380 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008381
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008382 *'termwinkey'* *'twk'*
8383'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008384 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008385 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008386 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008387 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008388 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008389< The string must be one key stroke but can be multiple bytes.
8390 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008391 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008392 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008393
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008394 *'termwinscroll'* *'twsl'*
8395'termwinscroll' 'twsl' number (default 10000)
8396 local to buffer
8397 {not available when compiled without the
8398 |+terminal| feature}
8399 Number of scrollback lines to keep. When going over this limit the
8400 first 10% of the scrollback lines are deleted. This is just to reduce
8401 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008402 Also used as a limit for text sent to the terminal in one write,
8403 multiplied by the number of columns times 3 (average number of bytes
8404 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008405
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008406 *'termwinsize'* *'tws'*
8407'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008408 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008409 Size used when opening the |terminal| window. Format:
8410 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008411 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008412 - When set with a "x" (e.g., "24x80") the terminal size is not
8413 adjusted to the window size. If the window is smaller only the
8414 top-left part is displayed.
8415 - When set with a "*" (e.g., "10*50") the terminal size follows the
8416 window size, but will not be smaller than the specified rows and/or
8417 columns.
8418 - When rows is zero then use the height of the window.
8419 - When columns is zero then use the width of the window.
8420 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008421 - Can be overruled in the |term_start()| options with "term_rows" and
8422 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008423
8424 Examples:
8425 "30x0" uses 30 rows and the current window width.
8426 "20*0" uses at least 20 rows and the current window width.
8427 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008428 Note that the command running in the terminal window may still change
8429 the size of the terminal. In that case the Vim window will be
8430 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008431
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008432 *'termwintype'* *'twt'*
8433'termwintype' 'twt' string (default "")
8434 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008435 {only available when compiled with the |terminal|
8436 feature on MS-Windows}
8437 Specify the virtual console (pty) used when opening the terminal
8438 window.
8439
8440 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008441 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008442 "winpty" use winpty, fail if not supported
8443 "conpty" use |ConPTY|, fail if not supported
8444
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008445 |ConPTY| support depends on the platform. Windows 10 October 2018
8446 Update is the first version that supports ConPTY, however it is still
8447 considered unstable. ConPTY might become stable in the next release
8448 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008449 supported then you cannot open a terminal window.
8450
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451 *'terse'* *'noterse'*
8452'terse' boolean (default off)
8453 global
8454 When set: Add 's' flag to 'shortmess' option (this makes the message
8455 for a search that hits the start or end of the file not being
8456 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8457 shortens a lot of messages}
8458
8459 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8460'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8461 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008462 This option is obsolete. Use 'fileformats'.
8463 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8464 set to the default value for the current system. When 'textauto' is
8465 reset, 'fileformats' is made empty.
8466 NOTE: This option is set to the Vi default value when 'compatible' is
8467 set and to the Vim default value when 'compatible' is reset.
8468
8469 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008470'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 others: default off)
8472 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 This option is obsolete. Use 'fileformat'.
8474 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8475 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8476 "unix".
8477
8478 *'textwidth'* *'tw'*
8479'textwidth' 'tw' number (default 0)
8480 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 Maximum width of text that is being inserted. A longer line will be
8482 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008483 this.
8484 'textwidth' is set to 0 when the 'paste' option is set and restored
8485 when 'paste' is reset.
8486 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008488 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 NOTE: This option is set to 0 when 'compatible' is set.
8490
8491 *'thesaurus'* *'tsr'*
8492'thesaurus' 'tsr' string (default "")
8493 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008495 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8496 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008497
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008498 This option is not used if 'thesaurusfunc' is set, either for the
8499 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008500
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008501 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008503 name. See |option-backslash| about using backslashes. The use of
8504 |:set+=| and |:set-=| is preferred when adding or removing directories
8505 from the list. This avoids problems when a future version uses
8506 another default. Backticks cannot be used in this option for security
8507 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008509 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008510'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008511 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008512 {not available when compiled without the |+eval|
8513 feature}
8514 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008515 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008516 The value can be the name of a function, a |lambda| or a |Funcref|.
8517 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008518
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008519 This option cannot be set from a |modeline| or in the |sandbox|, for
8520 security reasons.
8521
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8523'tildeop' 'top' boolean (default off)
8524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525 When on: The tilde command "~" behaves like an operator.
8526 NOTE: This option is reset when 'compatible' is set.
8527
8528 *'timeout'* *'to'* *'notimeout'* *'noto'*
8529'timeout' 'to' boolean (default on)
8530 global
laburnumT3f7855a2023-12-05 18:37:03 +01008531
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008533'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 These two options together determine the behavior when part of a
8536 mapped key sequence or keyboard code has been received:
8537
8538 'timeout' 'ttimeout' action ~
8539 off off do not time out
8540 on on or off time out on :mappings and key codes
8541 off on time out on key codes
8542
8543 If both options are off, Vim will wait until either the complete
8544 mapping or key sequence has been received, or it is clear that there
8545 is no mapping or key sequence for the received characters. For
8546 example: if you have mapped "vl" and Vim has received 'v', the next
8547 character is needed to see if the 'v' is followed by an 'l'.
8548 When one of the options is on, Vim will wait for about 1 second for
8549 the next character to arrive. After that the already received
8550 characters are interpreted as single characters. The waiting time can
8551 be changed with the 'timeoutlen' option.
8552 On slow terminals or very busy systems timing out may cause
8553 malfunctioning cursor keys. If both options are off, Vim waits
8554 forever after an entered <Esc> if there are key codes that start
8555 with <Esc>. You will have to type <Esc> twice. If you do not have
8556 problems with key codes, but would like to have :mapped key
8557 sequences not timing out in 1 second, set the 'ttimeout' option and
8558 reset the 'timeout' option.
8559
8560 NOTE: 'ttimeout' is reset when 'compatible' is set.
8561
8562 *'timeoutlen'* *'tm'*
8563'timeoutlen' 'tm' number (default 1000)
8564 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008565
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008567'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 The time in milliseconds that is waited for a key code or mapped key
8570 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8571 when part of a command has been typed.
8572 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8573 different timeout value for key codes is desired set 'ttimeoutlen' to
8574 a non-negative number.
8575
8576 ttimeoutlen mapping delay key code delay ~
8577 < 0 'timeoutlen' 'timeoutlen'
8578 >= 0 'timeoutlen' 'ttimeoutlen'
8579
8580 The timeout only happens when the 'timeout' and 'ttimeout' options
8581 tell so. A useful setting would be >
8582 :set timeout timeoutlen=3000 ttimeoutlen=100
8583< (time out on mapping after three seconds, time out on key codes after
8584 a tenth of a second).
8585
8586 *'title'* *'notitle'*
8587'title' boolean (default off, on when title can be restored)
8588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 When on, the title of the window will be set to the value of
8590 'titlestring' (if it is not empty), or to:
8591 filename [+=-] (path) - VIM
8592 Where:
8593 filename the name of the file being edited
8594 - indicates the file cannot be modified, 'ma' off
8595 + indicates the file was modified
8596 = indicates the file is read-only
8597 =+ indicates the file is read-only and modified
8598 (path) is the path of the file being edited
8599 - VIM the server name |v:servername| or "VIM"
8600 Only works if the terminal supports setting window titles
8601 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008602 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8604 *X11*
8605 When Vim was compiled with HAVE_X11 defined, the original title will
8606 be restored if possible. The output of ":version" will include "+X11"
8607 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8608 works for the icon name |'icon'|.
8609 But: When Vim was started with the |-X| argument, restoring the title
8610 will not work (except in the GUI).
8611 If the title cannot be restored, it is set to the value of 'titleold'.
8612 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008613 When using an xterm from a remote machine you can use this command: >
8614
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008616 ssh -X machine_name xterm &
8617<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 then the WINDOWID environment variable should be inherited and the
8619 title of the window should change back to what it should be after
8620 exiting Vim.
8621
8622 *'titlelen'*
8623'titlelen' number (default 85)
8624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008626 title. When the title is longer, only the end of the path name is
8627 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 Using a percentage makes this adapt to the width of the window. But
8629 it won't work perfectly, because the actual number of characters
8630 available also depends on the font used and other things in the title
8631 bar. When 'titlelen' is zero the full path is used. Otherwise,
8632 values from 1 to 30000 percent can be used.
8633 'titlelen' is also used for the 'titlestring' option.
8634
8635 *'titleold'*
8636'titleold' string (default "Thanks for flying Vim")
8637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 This option will be used for the window title when exiting Vim if the
8639 original title cannot be restored. Only happens if 'title' is on or
8640 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008641 This option cannot be set from a |modeline| or in the |sandbox|, for
8642 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 *'titlestring'*
8644'titlestring' string (default "")
8645 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 When this option is not empty, it will be used for the title of the
8647 window. This happens only when the 'title' option is on.
8648 Only works if the terminal supports setting window titles (currently
8649 Amiga console, Win32 console, all GUI versions and terminals with a
8650 non-empty 't_ts' option).
8651 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008652 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008653
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 When this option contains printf-style '%' items, they will be
8655 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008656 This option cannot be set in a modeline when 'modelineexpr' is off.
8657
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008659 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008660 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8661< The value of 'titlelen' is used to align items in the middle or right
8662 of the available space.
8663 Some people prefer to have the file name first: >
8664 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8665< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008666 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 separating space only when needed.
8668 NOTE: Use of special characters in 'titlestring' may cause the display
8669 to be garbled (e.g., when it contains a CR or NL character).
8670 {not available when compiled without the |+statusline| feature}
8671
8672 *'toolbar'* *'tb'*
8673'toolbar' 'tb' string (default "icons,tooltips")
8674 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008675 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008676 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 possible values are:
8678 icons Toolbar buttons are shown with icons.
8679 text Toolbar buttons shown with text.
8680 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008681 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 tooltips Tooltips are active for toolbar buttons.
8683 Tooltips refer to the popup help text which appears after the mouse
8684 cursor is placed over a toolbar button for a brief moment.
8685
8686 If you want the toolbar to be shown with icons as well as text, do the
8687 following: >
8688 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008689< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690 will show icons if both are requested.
8691
8692 If none of the strings specified in 'toolbar' are valid or if
8693 'toolbar' is empty, this option is ignored. If you want to disable
8694 the toolbar, you need to set the 'guioptions' option. For example: >
8695 :set guioptions-=T
8696< Also see |gui-toolbar|.
8697
8698 *'toolbariconsize'* *'tbis'*
8699'toolbariconsize' 'tbis' string (default "small")
8700 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008701 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008702 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008703 tiny Use tiny icons.
8704 small Use small icons (default).
8705 medium Use medium-sized icons.
8706 large Use large icons.
8707 huge Use even larger icons.
8708 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008710 the current theme. Common dimensions are giant=48x48, huge=32x32,
8711 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712
8713 If 'toolbariconsize' is empty, the global default size as determined
8714 by user preferences or the current theme is used.
8715
8716 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8717'ttybuiltin' 'tbi' boolean (default on)
8718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 When on, the builtin termcaps are searched before the external ones.
8720 When off the builtin termcaps are searched after the external ones.
8721 When this option is changed, you should set the 'term' option next for
8722 the change to take effect, for example: >
8723 :set notbi term=$TERM
8724< See also |termcap|.
8725 Rationale: The default for this option is "on", because the builtin
8726 termcap entries are generally better (many systems contain faulty
8727 xterm entries...).
8728
8729 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008730'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 Indicates a fast terminal connection. More characters will be sent to
8733 the screen for redrawing, instead of using insert/delete line
8734 commands. Improves smoothness of redrawing when there are multiple
8735 windows and the terminal does not support a scrolling region.
8736 Also enables the extra writing of characters at the end of each screen
8737 line for lines that wrap. This helps when using copy/paste with the
8738 mouse in an xterm and other terminals.
8739
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008740 The default used to be set only for some terminal names, but these
8741 days nearly all terminals are fast, therefore the default is now "on".
8742 If you have a slow connection you may want to set this option off,
8743 e.g. depending on the host name: >
8744 if hostname() =~ 'faraway'
8745 set nottyfast
8746 endif
8747<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 *'ttymouse'* *'ttym'*
8749'ttymouse' 'ttym' string (default depends on 'term')
8750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 {only in Unix and VMS, doesn't work in the GUI; not
8752 available when compiled without |+mouse|}
8753 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008754 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 *xterm-mouse*
8756 xterm xterm-like mouse handling. The mouse generates
8757 "<Esc>[Mscr", where "scr" is three bytes:
8758 "s" = button state
8759 "c" = column plus 33
8760 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008761 This only works up to 223 columns! See "dec",
8762 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 xterm2 Works like "xterm", but with the xterm reporting the
8764 mouse position while the mouse is dragged. This works
8765 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008766 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767 work. See below for how Vim detects this
8768 automatically.
8769 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008770 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008772 for the row and column. No other mouse events are
8773 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 *dec-mouse*
8775 dec DEC terminal mouse handling. The mouse generates a
8776 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008777 This is also available for an Xterm, if it was
8778 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 *jsbterm-mouse*
8780 jsbterm JSB term mouse handling.
8781 *pterm-mouse*
8782 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008783 *urxvt-mouse*
8784 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008785 The mouse works only if the terminal supports this
8786 encoding style, but it does not have 223 columns limit
8787 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008788 *sgr-mouse*
8789 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008790 mouse reporting. The mouse works even in columns
8791 beyond 223. This option is backward compatible with
8792 "xterm2" because it can also decode "xterm2" style
8793 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794
8795 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008796 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8797 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8799 recognized, if enabled at compile time. DEC terminal mouse codes
8800 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008801 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8802 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008804 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8805 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8806 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008807 If the terminfo/termcap entry "XM" exists and the first number is
8808 "1006" then 'ttymouse' will be set to "sgr". This works for many
8809 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008810 Additionally, if vim is compiled with the |+termresponse| feature and
8811 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008812 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008814 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8815 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8816 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008817 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8818 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 :set t_RV=
8820<
8821 *'ttyscroll'* *'tsl'*
8822'ttyscroll' 'tsl' number (default 999)
8823 global
8824 Maximum number of lines to scroll the screen. If there are more lines
8825 to scroll the window is redrawn. For terminals where scrolling is
8826 very slow and redrawing is not slow this can be set to a small number,
8827 e.g., 3, to speed up displaying.
8828
8829 *'ttytype'* *'tty'*
8830'ttytype' 'tty' string (default from $TERM)
8831 global
8832 Alias for 'term', see above.
8833
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008834 *'undodir'* *'udir'*
8835'undodir' 'udir' string (default ".")
8836 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008837 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008838 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008839 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008840 "." means using the directory of the file. The undo file name for
8841 "file.txt" is ".file.txt.un~".
8842 For other directories the file name is the full path of the edited
8843 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008844 When writing: The first directory that exists is used. "." always
8845 works, no directories after "." will be used for writing.
8846 When reading all entries are tried to find an undo file. The first
8847 undo file that exists is used. When it cannot be read an error is
8848 given, no further entry is used.
8849 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008850 This option cannot be set from a |modeline| or in the |sandbox|, for
8851 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008852
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008853 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008854'undofile' 'udf' boolean (default off)
8855 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008856 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008857 When on, Vim automatically saves undo history to an undo file when
8858 writing a buffer to a file, and restores undo history from the same
8859 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008860 The directory where the undo file is stored is specified by 'undodir'.
8861 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008862 The undo file is not read when 'undoreload' causes the buffer from
8863 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008864 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008865 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008866
Bram Moolenaar071d4272004-06-13 20:20:40 +00008867 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008868'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008869 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008871 is kept in memory, higher numbers will cause more memory to be used.
8872 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8874 itself: >
8875 set ul=0
8876< But you can also get Vi compatibility by including the 'u' flag in
8877 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008878 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008879 Set to -1 for no undo at all. You might want to do this only for the
8880 current buffer: >
8881 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008883
8884 The local value is set to -123456 when the global value is to be used.
8885
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008886 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008887
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008888 *'undoreload'* *'ur'*
8889'undoreload' 'ur' number (default 10000)
8890 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008891 Save the whole buffer for undo when reloading it. This applies to the
8892 ":e!" command and reloading for when the buffer changed outside of
8893 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008894 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008895 of lines is smaller than the value of this option.
8896 Set this option to zero to disable undo for a reload.
8897
8898 When saving undo for a reload, any undo file is not read.
8899
8900 Note that this causes the whole buffer to be stored in memory. Set
8901 this option to a lower value if you run out of memory.
8902
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 *'updatecount'* *'uc'*
8904'updatecount' 'uc' number (default: 200)
8905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 After typing this many characters the swap file will be written to
8907 disk. When zero, no swap file will be created at all (see chapter on
8908 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8909 Vim with the "-n" option, see |startup|. When editing in readonly
8910 mode this option will be initialized to 10000.
8911 The swapfile can be disabled per buffer with |'swapfile'|.
8912 When 'updatecount' is set from zero to non-zero, swap files are
8913 created for all buffers that have 'swapfile' set. When 'updatecount'
8914 is set to zero, existing swap files are not deleted.
8915 Also see |'swapsync'|.
8916 This option has no meaning in buffers where |'buftype'| is "nofile"
8917 or "nowrite".
8918
8919 *'updatetime'* *'ut'*
8920'updatetime' 'ut' number (default 4000)
8921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922 If this many milliseconds nothing is typed the swap file will be
8923 written to disk (see |crash-recovery|). Also used for the
8924 |CursorHold| autocommand event.
8925
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008926 *'varsofttabstop'* *'vsts'*
8927'varsofttabstop' 'vsts' string (default "")
8928 local to buffer
8929 {only available when compiled with the |+vartabs|
8930 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008931 A list of the number of spaces that a <Tab> counts for while editing,
8932 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8933 width <Tab>s are being inserted, while in fact a mixture of spaces
8934 and <Tab>s is used. Tab widths are separated with commas, with the
8935 final value applying to all subsequent tabs.
8936
8937 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008938 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008939 to use the following: >
8940 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008941< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8942 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008943
8944 Note that the value of |'softtabstop'| will be ignored while
8945 'varsofttabstop' is set.
8946
8947 *'vartabstop'* *'vts'*
8948'vartabstop' 'vts' string (default "")
8949 local to buffer
8950 {only available when compiled with the |+vartabs|
8951 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008952 A list of the number of spaces that a <Tab> in the file counts for,
8953 separated by commas. Each value corresponds to one tab, with the
8954 final value applying to all subsequent tabs. For example: >
8955 :set vartabstop=4,20,10,8
8956< This will make the first tab 4 spaces wide, the second 20 spaces,
8957 the third 10 spaces, and all following tabs 8 spaces.
8958
8959 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8960 is set.
8961
Bram Moolenaar071d4272004-06-13 20:20:40 +00008962 *'verbose'* *'vbs'*
8963'verbose' 'vbs' number (default 0)
8964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 When bigger than zero, Vim will give messages about what it is doing.
8966 Currently, these messages are given:
8967 >= 1 When the viminfo file is read or written.
8968 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008969 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008970 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008971 >= 8 Files for which a group of autocommands is executed.
8972 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008973 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008974 >= 12 Every executed function.
8975 >= 13 When an exception is thrown, caught, finished, or discarded.
8976 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008977 >= 15 Every executed Ex command from a script (truncated at 200
8978 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008979 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980
8981 This option can also be set with the "-V" argument. See |-V|.
8982 This option is also set by the |:verbose| command.
8983
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008984 When the 'verbosefile' option is set then the verbose messages are not
8985 displayed.
8986
8987 *'verbosefile'* *'vfile'*
8988'verbosefile' 'vfile' string (default empty)
8989 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008990 When not empty all messages are written in a file with this name.
8991 When the file exists messages are appended.
8992 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008993 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008994 Setting 'verbosefile' to a new value is like making it empty first.
8995 The difference with |:redir| is that verbose messages are not
8996 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11008997 This option cannot be set from a |modeline| or in the |sandbox|, for
8998 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008999
Bram Moolenaar071d4272004-06-13 20:20:40 +00009000 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009001'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009002 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009003 for Unix: "$HOME/.vim/view" or
9004 "$XDG_CONFIG_HOME/vim/view"
h_east59858792023-10-25 22:47:05 +09009005 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009006 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009008 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009009 feature}
9010 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009011 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009012 This option cannot be set from a |modeline| or in the |sandbox|, for
9013 security reasons.
9014
9015 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009016'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009018 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009020 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009021 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 word save and restore ~
9023 cursor cursor position in file and in window
9024 folds manually created folds, opened/closed folds and local
9025 fold options
9026 options options and mappings local to a window or buffer (not
9027 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009028 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029 slash backslashes in file names replaced with forward
9030 slashes
9031 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009032 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009033 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009034
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009035 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009037 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009038
9039 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009040'viminfo' 'vi' string (Vi default: "", Vim default for
9041 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009042 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9043 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009044 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009045 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009046 feature}
9047 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009048 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9049 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009050 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009051 consisting of a single character identifying the particular parameter,
9052 followed by a number or string which specifies the value of that
9053 parameter. If a particular character is left out, then the default
9054 value is used for that parameter. The following is a list of the
9055 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009057 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 ! When included, save and restore global variables that start
9059 with an uppercase letter, and don't contain a lowercase
9060 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009061 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009062 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009063 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 " Maximum number of lines saved for each register. Old name of
9065 the '<' item, with the disadvantage that you need to put a
9066 backslash before the ", otherwise it will be recognized as the
9067 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009068 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069 % When included, save and restore the buffer list. If Vim is
9070 started with a file name argument, the buffer list is not
9071 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009072 buffer list is restored from the viminfo file. Quickfix
9073 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9074 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009075 When followed by a number, the number specifies the maximum
9076 number of buffers that are stored. Without a number all
9077 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009078 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079 ' Maximum number of previously edited files for which the marks
9080 are remembered. This parameter must always be included when
9081 'viminfo' is non-empty.
9082 Including this item also means that the |jumplist| and the
9083 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009084 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009085 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009086 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087 patterns are also saved. When not included, the value of
9088 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009089 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009090 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009091 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009092 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009093 < Maximum number of lines saved for each register. If zero then
9094 registers are not saved. When not included, all lines are
9095 saved. '"' is the old name for this item.
9096 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009097 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009098 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009099 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009100 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009101 c When included, convert the text in the viminfo file from the
9102 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009103 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009104 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 f Whether file marks need to be stored. If zero, file marks ('0
9106 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009107 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009109 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009110 h Disable the effect of 'hlsearch' when loading the viminfo
9111 file. When not included, it depends on whether ":nohlsearch"
9112 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009113 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009115 the 'n'. Must be at the end of the option! If the
9116 'viminfofile' option is set, that file name overrides the one
9117 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009118 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009119 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120 r Removable media. The argument is a string (up to the next
9121 ','). This parameter can be given several times. Each
9122 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009123 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9125 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9126 ignored. Maximum length of each 'r' argument is 50
9127 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009128 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009129 s Maximum size of an item in Kbyte. If zero then registers are
9130 not saved. Currently only applies to registers. The default
9131 "s10" will exclude registers with more than 10 Kbyte of text.
9132 Also see the '<' item above: line count limit.
9133
9134 Example: >
9135 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9136<
9137 '50 Marks will be remembered for the last 50 files you
9138 edited.
9139 <1000 Contents of registers (up to 1000 lines each) will be
9140 remembered.
9141 s100 Registers with more than 100 Kbyte text are skipped.
9142 :0 Command-line history will not be saved.
9143 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9144 no / Since '/' is not specified, the default will be used,
9145 that is, save all of the search history, and also the
9146 previous search and substitute patterns.
9147 no % The buffer list will not be saved nor read back.
9148 no h 'hlsearch' highlighting will be restored.
9149
9150 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9151 load the contents of the file, this is not done automatically.
9152
9153 This option cannot be set from a |modeline| or in the |sandbox|, for
9154 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009155 NOTE: This option is set to the Vim default value when 'compatible'
9156 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009158 *'viminfofile'* *'vif'*
9159'viminfofile' 'vif' string (default: "")
9160 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009161 {not available when compiled without the |+viminfo|
9162 feature}
9163 When non-empty, overrides the file name used for viminfo.
9164 When equal to "NONE" no viminfo file will be read or written.
9165 This option can be set with the |-i| command line flag. The |--clean|
9166 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009167 This option cannot be set from a |modeline| or in the |sandbox|, for
9168 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009169
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170 *'virtualedit'* *'ve'*
9171'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009172 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009173 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009174 block Allow virtual editing in Visual block mode.
9175 insert Allow virtual editing in Insert mode.
9176 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009177 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009178 none When used as the local value, do not allow virtual
9179 editing even when the global value is set. When used
9180 as the global value, "none" is the same as "".
9181 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009182
Bram Moolenaar071d4272004-06-13 20:20:40 +00009183 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009184 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009185 of the line. Useful for selecting a rectangle in Visual mode and
9186 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009187 "onemore" is not the same, it will only allow moving the cursor just
9188 after the last character of the line. This makes some commands more
9189 consistent. Previously the cursor was always past the end of the line
9190 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009191 break some plugins or Vim scripts. For example because |l| can move
9192 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009193 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009194 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009195 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009196 It doesn't make sense to combine "all" with "onemore", but you will
9197 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009198 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009199 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009200
9201 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9202'visualbell' 'vb' boolean (default off)
9203 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009204 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009205 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009206 use: >
9207 :set vb t_vb=
9208< If you want a short flash, you can use this on many terminals: >
9209 :set vb t_vb=[?5h$<100>[?5l
9210< Here $<100> specifies the time, you can use a smaller or bigger value
9211 to get a shorter or longer flash.
9212
9213 Note: Vim will limit the bell to once per half a second. This avoids
9214 having to wait for the flashing to finish when there are lots of
9215 bells, e.g. on key repeat. This also happens without 'visualbell'
9216 set.
9217
Bram Moolenaar071d4272004-06-13 20:20:40 +00009218 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9219 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9220 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009221
9222 Note: When the GUI starts, 't_vb' is reset to its default value. You
9223 might want to set it again in your |gvimrc|.
9224
Bram Moolenaar071d4272004-06-13 20:20:40 +00009225 Does not work on the Amiga, you always get a screen flash.
9226 Also see 'errorbells'.
9227
9228 *'warn'* *'nowarn'*
9229'warn' boolean (default on)
9230 global
9231 Give a warning message when a shell command is used while the buffer
9232 has been changed.
9233
9234 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9235'weirdinvert' 'wiv' boolean (default off)
9236 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009237 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009238 It is provided for backwards compatibility with version 4.x.
9239 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9240 vice versa. Has no effect when the GUI is running.
9241
9242 *'whichwrap'* *'ww'*
9243'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009245 Allow specified keys that move the cursor left/right to move to the
9246 previous/next line when the cursor is on the first/last character in
9247 the line. Concatenate characters to allow this for these keys:
9248 char key mode ~
9249 b <BS> Normal and Visual
9250 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009251 h "h" Normal and Visual (not recommended)
9252 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009253 < <Left> Normal and Visual
9254 > <Right> Normal and Visual
9255 ~ "~" Normal
9256 [ <Left> Insert and Replace
9257 ] <Right> Insert and Replace
9258 For example: >
9259 :set ww=<,>,[,]
9260< allows wrap only when cursor keys are used.
9261 When the movement keys are used in combination with a delete or change
9262 operator, the <EOL> also counts for a character. This makes "3h"
9263 different from "3dh" when the cursor crosses the end of a line. This
9264 is also true for "x" and "X", because they do the same as "dl" and
9265 "dh". If you use this, you may also want to use the mapping
9266 ":map <BS> X" to make backspace delete the character in front of the
9267 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009268 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009269 line (not an empty line) then it will not move to the next line. This
9270 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009271 NOTE: This option is set to the Vi default value when 'compatible' is
9272 set and to the Vim default value when 'compatible' is reset.
9273
9274 *'wildchar'* *'wc'*
9275'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009277 Character you have to type to start wildcard expansion in the
9278 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009279 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 The character is not recognized when used inside a macro. See
9281 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009282 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009283 <Esc> can be used, but hitting it twice in a row will still exit
9284 command-line as a failsafe measure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009285 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009286 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009287< NOTE: This option is set to the Vi default value when 'compatible' is
9288 set and to the Vim default value when 'compatible' is reset.
9289
9290 *'wildcharm'* *'wcm'*
9291'wildcharm' 'wcm' number (default: none (0))
9292 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009293 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009294 recognized when used inside a macro. You can find "spare" command-line
9295 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009296 you'll never actually type 'wildcharm', just use it in mappings that
9297 automatically invoke completion mode, e.g.: >
9298 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009299 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009300< Then after typing :ss you can use CTRL-P & CTRL-N.
9301
9302 *'wildignore'* *'wig'*
9303'wildignore' 'wig' string (default "")
9304 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009305 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009306 patterns is ignored when expanding |wildcards|, completing file or
9307 directory names, and influences the result of |expand()|, |glob()| and
9308 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009309 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9310 Also see 'suffixes'.
9311 Example: >
9312 :set wildignore=*.o,*.obj
9313< The use of |:set+=| and |:set-=| is preferred when adding or removing
9314 a pattern from the list. This avoids problems when a future version
9315 uses another default.
9316
h_east596a9f22023-11-21 21:24:23 +09009317 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009318'wildignorecase' 'wic' boolean (default off)
9319 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009320 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009321 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009322 Does not apply when the shell is used to expand wildcards, which
9323 happens when there are special characters.
9324
Bram Moolenaar071d4272004-06-13 20:20:40 +00009325 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009326'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009328 When 'wildmenu' is on, command-line completion operates in an enhanced
9329 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009330 the possible matches are shown.
9331 When 'wildoptions' contains "pum", then the completion matches are
9332 shown in a popup menu. Otherwise they are displayed just above the
9333 command line, with the first match highlighted (overwriting the status
9334 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009335 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009336 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9337 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9338 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009339 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009340 If there are more matches than can fit in the line, a ">" is shown on
9341 the right and/or a "<" is shown on the left. The status line scrolls
9342 as needed.
9343 The "wildmenu" mode is abandoned when a key is hit that is not used
9344 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009345 While the "wildmenu" is active, the following keys have special
9346 meanings:
9347 CTRL-P - go to the previous entry
9348 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009349 <CR> - in menu completion, when the cursor is just after a
9350 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009351 CTRL-E - end completion, go back to what was there before
9352 selecting a match.
9353 CTRL-Y - accept the currently selected match and stop
9354 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009355
9356 When not using the popup menu for command line completion, the
9357 following keys have special meanings:
9358 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009359 <Up> - in filename/menu name completion: move up into
9360 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009361 <Down> - in filename/menu name completion: move into a
9362 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009363
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009364 When using the popup menu for command line completion, the following
9365 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009366 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009367 <PageUp> - select a match several entries back
9368 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009369 <Left> - in filename/menu name completion: move up into
9370 parent directory or parent menu.
9371 <Right> - in filename/menu name completion: move into a
9372 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009373
Bram Moolenaar071d4272004-06-13 20:20:40 +00009374 This makes the menus accessible from the console |console-menus|.
9375
9376 If you prefer the <Left> and <Right> keys to move the cursor instead
9377 of selecting a different match, use this: >
9378 :cnoremap <Left> <Space><BS><Left>
9379 :cnoremap <Right> <Space><BS><Right>
9380<
9381 The "WildMenu" highlighting is used for displaying the current match
9382 |hl-WildMenu|.
9383
9384 *'wildmode'* *'wim'*
9385'wildmode' 'wim' string (Vim default: "full")
9386 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009387 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009388 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009389 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009390 first part specifies the behavior for the first use of 'wildchar',
9391 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009392
9393 Each part consists of a colon separated list consisting of the
9394 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009395 "" Complete only the first match.
9396 "full" Complete the next full match. After the last match,
9397 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009398 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009399 "longest" Complete till longest common string. If this doesn't
9400 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009401 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009402 "lastused" When completing buffer names and more than one buffer
9403 matches, sort buffers by time last used (other than
9404 the current buffer).
9405 When there is only a single match, it is fully completed in all cases.
9406
9407 Examples of useful colon-separated values:
9408 "longest:full" Like "longest", but also start 'wildmenu' if it is
9409 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009410 "list:full" When more than one match, list all matches and
9411 complete first match.
9412 "list:longest" When more than one match, list all matches and
9413 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009414 "list:lastused" When more than one buffer matches, list all matches
9415 and sort buffers by time last used (other than the
9416 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009417
9418 Examples: >
9419 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009420< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009421 :set wildmode=longest,full
9422< Complete longest common string, then each full match >
9423 :set wildmode=list:full
9424< List all matches and complete each full match >
9425 :set wildmode=list,full
9426< List all matches without completing, then each full match >
9427 :set wildmode=longest,list
9428< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009429 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009430
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009431 *'wildoptions'* *'wop'*
9432'wildoptions' 'wop' string (default "")
9433 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009434 A list of words that change how |cmdline-completion| is done.
9435 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009436 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009437 this value is specified, wildcard expansion will not
9438 be used for completion. The matches will be sorted by
9439 the "best match" rather than alphabetically sorted.
9440 This will find more matches than the wildcard
9441 expansion. Currently fuzzy matching based completion
9442 is not supported for file and directory names and
9443 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009444 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009445 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009446 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009447 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009448 is displayed per line. Often used tag kinds are:
9449 d #define
9450 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009451
Bram Moolenaar071d4272004-06-13 20:20:40 +00009452 *'winaltkeys'* *'wak'*
9453'winaltkeys' 'wak' string (default "menu")
9454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009455 {only used in Win32, Motif, GTK and Photon GUI}
9456 Some GUI versions allow the access to menu entries by using the ALT
9457 key in combination with a character that appears underlined in the
9458 menu. This conflicts with the use of the ALT key for mappings and
9459 entering special characters. This option tells what to do:
9460 no Don't use ALT keys for menus. ALT key combinations can be
9461 mapped, but there is no automatic handling. This can then be
9462 done with the |:simalt| command.
9463 yes ALT key handling is done by the windowing system. ALT key
9464 combinations cannot be mapped.
9465 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009466 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009467 keys can be mapped.
9468 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9469 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009470 This option is not used for <F10>; on Win32 and with GTK <F10> will
9471 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009472
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009473 *'wincolor'* *'wcr'*
9474'wincolor' 'wcr' string (default empty)
9475 local to window
9476 Highlight group name to use for this window instead of the Normal
9477 color |hl-Normal|.
9478
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009479 *'window'* *'wi'*
9480'window' 'wi' number (default screen height - 1)
9481 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009482 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9483 window and the value is smaller than 'lines' minus one. The screen
9484 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009485 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9486 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009487 When resizing the Vim window, and the value is smaller than 1 or more
9488 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009489 Note: Do not confuse this with the height of the Vim window, use
9490 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009491
Colin Kennedy21570352024-03-03 16:16:47 +01009492 *'winfixbuf'*
9493'winfixbuf' 'wfb' boolean (default off)
9494 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009495 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009496 For example, attempting to change the buffer with |:edit| will fail.
9497 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009498 also skip any window with 'winfixbuf' enabled. However if an Ex
9499 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009500
laburnumT3f7855a2023-12-05 18:37:03 +01009501 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9502'winfixheight' 'wfh' boolean (default off)
9503 local to window |local-noglobal|
9504 Keep the window height when windows are opened or closed and
9505 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9506 |preview-window| and |quickfix-window|.
9507 The height may be changed anyway when running out of room.
9508
9509 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9510'winfixwidth' 'wfw' boolean (default off)
9511 local to window |local-noglobal|
9512 Keep the window width when windows are opened or closed and
9513 'equalalways' is set. Also for |CTRL-W_=|.
9514 The width may be changed anyway when running out of room.
9515
Bram Moolenaar071d4272004-06-13 20:20:40 +00009516 *'winheight'* *'wh'* *E591*
9517'winheight' 'wh' number (default 1)
9518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009519 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009520 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009521 focus goes to a window that is smaller, its size is increased, at the
9522 cost of the height of other windows.
9523 Set 'winheight' to a small number for normal editing.
9524 Set it to 999 to make the current window fill most of the screen.
9525 Other windows will be only 'winminheight' high. This has the drawback
9526 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9527 to create only two windows, set the option after startup is done,
9528 using the |VimEnter| event: >
9529 au VimEnter * set winheight=999
9530< Minimum value is 1.
9531 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009532 height of the current window.
9533 'winheight' applies to the current window. Use 'winminheight' to set
9534 the minimal height for other windows.
9535
Bram Moolenaar071d4272004-06-13 20:20:40 +00009536 *'winminheight'* *'wmh'*
9537'winminheight' 'wmh' number (default 1)
9538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009539 The minimal height of a window, when it's not the current window.
9540 This is a hard minimum, windows will never become smaller.
9541 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9542 status bar) if necessary. They will return to at least one line when
9543 they become active (since the cursor has to have somewhere to go.)
9544 Use 'winheight' to set the minimal height of the current window.
9545 This option is only checked when making a window smaller. Don't use a
9546 large number, it will cause errors when opening more than a few
9547 windows. A value of 0 to 3 is reasonable.
9548
9549 *'winminwidth'* *'wmw'*
9550'winminwidth' 'wmw' number (default 1)
9551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009552 The minimal width of a window, when it's not the current window.
9553 This is a hard minimum, windows will never become smaller.
9554 When set to zero, windows may be "squashed" to zero columns (i.e. just
9555 a vertical separator) if necessary. They will return to at least one
9556 line when they become active (since the cursor has to have somewhere
9557 to go.)
9558 Use 'winwidth' to set the minimal width of the current window.
9559 This option is only checked when making a window smaller. Don't use a
9560 large number, it will cause errors when opening more than a few
9561 windows. A value of 0 to 12 is reasonable.
9562
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009563 *'winptydll'*
9564'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9565 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009566 {only available when compiled with the |terminal|
9567 feature on MS-Windows}
9568 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009569 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009570 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009571 a fallback.
9572 Environment variables are expanded |:set_env|.
9573 This option cannot be set from a |modeline| or in the |sandbox|, for
9574 security reasons.
9575
Bram Moolenaar071d4272004-06-13 20:20:40 +00009576 *'winwidth'* *'wiw'* *E592*
9577'winwidth' 'wiw' number (default 20)
9578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009579 Minimal number of columns for the current window. This is not a hard
9580 minimum, Vim will use fewer columns if there is not enough room. If
9581 the current window is smaller, its size is increased, at the cost of
9582 the width of other windows. Set it to 999 to make the current window
9583 always fill the screen. Set it to a small number for normal editing.
9584 The width is not adjusted after one of the commands to change the
9585 width of the current window.
9586 'winwidth' applies to the current window. Use 'winminwidth' to set
9587 the minimal width for other windows.
9588
9589 *'wrap'* *'nowrap'*
9590'wrap' boolean (default on)
9591 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009592 This option changes how text is displayed. It doesn't change the text
9593 in the buffer, see 'textwidth' for that.
9594 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009595 displaying continues on the next line. When off lines will not wrap
9596 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009597 moved to a part that is not shown, the screen will scroll
9598 horizontally.
9599 The line will be broken in the middle of a word if necessary. See
9600 'linebreak' to get the break at a word boundary.
9601 To make scrolling horizontally a bit more useful, try this: >
9602 :set sidescroll=5
9603 :set listchars+=precedes:<,extends:>
9604< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009605 This option can't be set from a |modeline| when the 'diff' option is
9606 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009607
9608 *'wrapmargin'* *'wm'*
9609'wrapmargin' 'wm' number (default 0)
9610 local to buffer
9611 Number of characters from the right window border where wrapping
9612 starts. When typing text beyond this limit, an <EOL> will be inserted
9613 and inserting continues on the next line.
9614 Options that add a margin, such as 'number' and 'foldcolumn', cause
9615 the text width to be further reduced. This is Vi compatible.
9616 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009617 This option is set to 0 when 'paste' is set and restored when 'paste'
9618 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009619 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009620
9621 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9622'wrapscan' 'ws' boolean (default on) *E384* *E385*
9623 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009624 Searches wrap around the end of the file. Also applies to |]s| and
9625 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009626
9627 *'write'* *'nowrite'*
9628'write' boolean (default on)
9629 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009630 Allows writing files. When not set, writing a file is not allowed.
9631 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009632 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009633 argument. Filtering text is still possible, even though this requires
9634 writing a temporary file.
9635
9636 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9637'writeany' 'wa' boolean (default off)
9638 global
9639 Allows writing to any file with no need for "!" override.
9640
9641 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9642'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9643 otherwise)
9644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009645 Make a backup before overwriting a file. The backup is removed after
9646 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009647 also on.
9648 WARNING: Switching this option off means that when Vim fails to write
9649 your buffer correctly and then, for whatever reason, Vim exits, you
9650 lose both the original file and what you were writing. Only reset
9651 this option if your file system is almost full and it makes the write
9652 fail (and make sure not to exit Vim until the write was successful).
9653 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009654 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009655 Depending on 'backupcopy' the backup is a new file or the original
9656 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009657 NOTE: This option is set to the default value when 'compatible' is
9658 set.
9659
9660 *'writedelay'* *'wd'*
9661'writedelay' 'wd' number (default 0)
9662 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009663 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009664 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009665 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009666
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009667 *'xtermcodes'* *'noxtermcodes'*
9668'xtermcodes' boolean (default on)
9669 global
9670 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009671 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009672 key codes and number of colors from the terminal. This takes care of
9673 various configuration options of the terminal that cannot be obtained
9674 from the termlib/terminfo entry, see |xterm-codes|.
9675 A side effect may be that t_Co changes and Vim will redraw the
9676 display.
9677
9678
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009679 vim:tw=78:ts=8:noet:ft=help:norl: