blob: e38aa81a808c4ba57df2409d7ada1e9934094a23 [file] [log] [blame]
Colin Kennedy21570352024-03-03 16:16:47 +01001*options.txt* For Vim version 9.1. Last change: 2024 Mar 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
336 'winfixheight' specific to existing window
337 'winfixwidth' specific to existing window
338
Christian Brabandt596ad662023-08-16 00:11:09 +0200339Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200340
341The following local buffer options won't be copied over when new buffers are
342created, thus they behave slightly differently:
343
344 Option Reason ~
345 'filetype' explicitly set by autocommands
346 'syntax' explicitly set by autocommands
347 'bufhidden' denote |special-buffers|
348 'buftype' denote |special-buffers|
349 'readonly' will be detected automatically
350 'modified' will be detected automatically
351
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100353:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 current buffer or window. Not all options have a
355 local value. If the option does not have a local
356 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200357 With the "all" argument: display local values for all
358 local options.
359 Without argument: Display local values for all local
360 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000362 local value. For a global/local boolean option, when
363 the global value is being used, "--" is displayed
364 before the option name.
365 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367
Matt Ellis374e26a2024-02-24 17:02:43 +0100368:se[t] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800369 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100370 For string |global-local| options, the local value is
371 removed, so that the global value will be used.
372 For all other options, the global value is copied to
373 the local value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000374
Matt Ellis374e26a2024-02-24 17:02:43 +0100375:setl[ocal] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800376 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100377 For number and boolean |global-local| options, the
378 local value is removed, so that the global value will
379 be used.
380 For all other options, including string |global-local|
381 options, the global value is copied to the local
382 value.
383
384Note that the behaviour for |global-local| options is slightly different
385between string and number-based options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386
387 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100388:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389 option without changing the local value.
390 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200391 With the "all" argument: display global values for all
392 local options.
393 Without argument: display global values for all local
394 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395
396For buffer-local and window-local options:
397 Command global value local value ~
398 :set option=value set set
399 :setlocal option=value - set
400:setglobal option=value set -
401 :set option? - display
402 :setlocal option? - display
403:setglobal option? display -
404
405
406Global options with a local value *global-local*
407
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000408Options are global when you mostly use one value for all buffers and windows.
409For some global options it's useful to sometimes have a different local value.
410You can set the local value with ":setlocal". That buffer or window will then
411use the local value, while other buffers and windows continue using the global
412value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413
414For example, you have two windows, both on C source code. They use the global
415'makeprg' option. If you do this in one of the two windows: >
416 :set makeprg=gmake
417then the other window will switch to the same value. There is no need to set
418the 'makeprg' option in the other C source window too.
419However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000420another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000421files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422 :setlocal makeprg=perlmake
423You can switch back to using the global value by making the local value empty: >
424 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100425This only works for a string option. For a number or boolean option you need
426to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100428Note that for non-boolean and non-number options using "<" copies the global
429value to the local value, it doesn't switch back to using the global value
430(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000431 :set path<
432This will make the local value of 'path' empty, so that the global value is
433used. Thus it does the same as: >
434 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000435Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436":setlocal" on a global option might work differently then.
437
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000438 *option-value-function*
439Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000440'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000441a function name or a function reference or a lambda function. When using a
442lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000443>
444 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000445 set opfunc=function('MyOpFunc')
446 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000447 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000448
449Set to a script-local function: >
450 set opfunc=s:MyLocalFunc
451 set opfunc=<SID>MyLocalFunc
452In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
453the script: >
454 set opfunc=MyLocalFunc
455
456Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000457 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000458 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000459
460Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000461 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000462
463Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000464 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000465 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000466
467In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300468closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000469context of where it was defined.
470
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000471
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472Setting the filetype
473
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200474:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475 Set the 'filetype' option to {filetype}, but only if
476 not done yet in a sequence of (nested) autocommands.
477 This is short for: >
478 :if !did_filetype()
479 : setlocal filetype={filetype}
480 :endif
481< This command is used in a filetype.vim file to avoid
482 setting the 'filetype' option twice, causing different
483 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200484
485 When the optional FALLBACK argument is present, a
486 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100487 'filetype'. This is to be used for filetype
488 detections that are just a guess. |did_filetype()|
489 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200490
Bram Moolenaard58e9292011-02-09 17:07:58 +0100491 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
493:opt[ions] Open a window for viewing and setting all options.
494 Options are grouped by function.
495 Offers short help for each option. Hit <CR> on the
496 short help to open a help window with more help for
497 the option.
498 Modify the value of the option and hit <CR> on the
499 "set" line to set the new value. For window and
500 buffer specific options, the last accessed window is
501 used to set the option value in, unless this is a help
502 window, in which case the window below help window is
503 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100504 {not available when compiled without the |+eval|
505 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000506
507 *$HOME*
508Using "~" is like using "$HOME", but it is only recognized at the start of an
509option and after a space or comma.
510
511On Unix systems "~user" can be used too. It is replaced by the home directory
512of user "user". Example: >
513 :set path=~mool/include,/usr/include,.
514
515On Unix systems the form "${HOME}" can be used too. The name between {} can
516contain non-id characters then. Note that if you want to use this for the
517"gf" command, you need to add the '{' and '}' characters to 'isfname'.
518
519NOTE: expanding environment variables and "~/" is only done with the ":set"
520command, not when assigning a value to an option with ":let".
521
Bram Moolenaarc572da52017-08-27 16:52:01 +0200522 *$HOME-windows*
523On MS-Windows, if $HOME is not defined as an environment variable, then
524at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200525If $HOMEDRIVE is not set then $USERPROFILE is used.
526
527This expanded value is not exported to the environment, this matters when
528running an external command: >
529 :echo system('set | findstr ^HOME=')
530and >
531 :echo luaeval('os.getenv("HOME")')
532should echo nothing (an empty string) despite exists('$HOME') being true.
533When setting $HOME to a non-empty string it will be exported to the
534subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200535
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
537Note the maximum length of an expanded option is limited. How much depends on
538the system, mostly it is something like 256 or 1024 characters.
539
540 *:fix* *:fixdel*
541:fix[del] Set the value of 't_kD':
542 't_kb' is 't_kD' becomes ~
543 CTRL-? CTRL-H
544 not CTRL-? CTRL-?
545
Bram Moolenaar82be4842021-01-11 19:40:15 +0100546 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
548 If your delete key terminal code is wrong, but the
549 code for backspace is alright, you can put this in
550 your .vimrc: >
551 :fixdel
552< This works no matter what the actual code for
553 backspace is.
554
555 If the backspace key terminal code is wrong you can
556 use this: >
557 :if &term == "termname"
558 : set t_kb=^V<BS>
559 : fixdel
560 :endif
561< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000562 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563 with your terminal name.
564
565 If your <Delete> key sends a strange key sequence (not
566 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
567 :if &term == "termname"
568 : set t_kD=^V<Delete>
569 :endif
570< Where "^V" is CTRL-V and "<Delete>" is the delete key
571 (don't type eight characters!). Replace "termname"
572 with your terminal name.
573
574 *Linux-backspace*
575 Note about Linux: By default the backspace key
576 produces CTRL-?, which is wrong. You can fix it by
577 putting this line in your rc.local: >
578 echo "keycode 14 = BackSpace" | loadkeys
579<
580 *NetBSD-backspace*
581 Note about NetBSD: If your backspace doesn't produce
582 the right code, try this: >
583 xmodmap -e "keycode 22 = BackSpace"
584< If this works, add this in your .Xmodmap file: >
585 keysym 22 = BackSpace
586< You need to restart for this to take effect.
587
588==============================================================================
5892. Automatically setting options *auto-setting*
590
591Besides changing options with the ":set" command, there are three alternatives
592to set options automatically for one or more files:
593
5941. When starting Vim initializations are read from various places. See
595 |initialization|. Most of them are performed for all editing sessions,
596 and some of them depend on the directory where Vim is started.
597 You can create an initialization file with |:mkvimrc|, |:mkview| and
598 |:mksession|.
5992. If you start editing a new file, the automatic commands are executed.
600 This can be used to set options for files matching a particular pattern and
601 many other things. See |autocommand|.
6023. If you start editing a new file, and the 'modeline' option is on, a
603 number of lines at the beginning and end of the file are checked for
604 modelines. This is explained here.
605
606 *modeline* *vim:* *vi:* *ex:* *E520*
607There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100608 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100610[text{white}] empty or any text followed by at least one blank
611 character (<Space> or <Tab>); "ex:" always requires at
612 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200613{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200614[white] optional white space
615{options} a list of option settings, separated with white space
616 or ':', where each part between ':' is the argument
617 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618
Bram Moolenaar14b69452013-06-29 23:05:20 +0200619Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000620 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200621 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622
623The second form (this is compatible with some versions of Vi):
624
Bram Moolenaarade0d392020-01-21 22:33:58 +0100625 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
Bram Moolenaarade0d392020-01-21 22:33:58 +0100627[text{white}] empty or any text followed by at least one blank
628 character (<Space> or <Tab>); "ex:" always requires at
629 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200630{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
631[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200632se[t] the string "set " or "se " (note the space); When
633 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200634{options} a list of options, separated with white space, which
635 is the argument for a ":set" command
636: a colon
637[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638
Bram Moolenaar14b69452013-06-29 23:05:20 +0200639Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000640 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200641 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200643The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
644chance that a normal word like "lex:" is caught. There is one exception:
645"vi:" and "vim:" can also be at the start of the line (for compatibility with
646version 3.0). Using "ex:" at the start of the line will be ignored (this
647could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648
Hu Jialun9dcd3492021-08-28 20:42:50 +0200649If the modeline is disabled within a modeline, subsequent modelines will be
650ignored. This is to allow turning off modeline on a per-file basis. This is
651useful when a line looks like a modeline but isn't. For example, it would be
652good to start a YAML file containing strings like "vim:" with
653 # vim: nomodeline ~
654so as to avoid modeline misdetection. Following options on the same line
655after modeline deactivation, if any, are still evaluated (but you would
656normally not have any).
657
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658 *modeline-local*
659The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000660buffer and window that contain the file. Although it's possible to set global
661options from a modeline, this is unusual. If you have two windows open and
662the files in it set the same global option to a different value, the result
663depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000665When editing a file that was already loaded, only the window-local options
666from the modeline are used. Thus if you manually changed a buffer-local
667option after opening the file, it won't be changed if you edit the same buffer
668in another window. But window-local options will be set.
669
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 *modeline-version*
671If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200672number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 vim{vers}: version {vers} or later
674 vim<{vers}: version before {vers}
675 vim={vers}: version {vers}
676 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100677{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
678For example, to use a modeline only for Vim 7.0:
679 /* vim700: set foldmethod=marker */ ~
680To use a modeline for Vim after version 7.2:
681 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682There can be no blanks between "vim" and the ":".
683
684
685The number of lines that are checked can be set with the 'modelines' option.
686If 'modeline' is off or 'modelines' is 0 no lines are checked.
687
688Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000689like:
690 /* vi:ts=4: */ ~
691will give an error message for the trailing "*/". This line is OK:
692 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693
694If an error is detected the rest of the line is skipped.
695
696If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000697backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100698 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
699This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
700before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200701 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000703might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200704can be set. For some options a flag is set, so that when the value is used
705the |sandbox| is effective. Some options can only be set from the modeline
706when 'modelineexpr' is set (the default is off).
707
708Still, there is always a small risk that a modeline causes trouble. E.g.,
709when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
710So disable modelines before editing untrusted text. The mail ftplugin does
711this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712
713Hint: If you would like to do something else than setting an option, you could
714define an autocommand that checks the file for a specific string. For
715example: >
716 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
717And define a function SetVar() that does something with the line containing
718"VAR".
719
720==============================================================================
7213. Options summary *option-summary*
722
723In the list below all the options are mentioned with their full name and with
724an abbreviation if there is one. Both forms may be used.
725
726In this document when a boolean option is "set" that means that ":set option"
727is entered. When an option is "reset", ":set nooption" is used.
728
729For some options there are two default values: The "Vim default", which is
730used when 'compatible' is not set, and the "Vi default", which is used when
731'compatible' is set.
732
733Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000734are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735different value in each window. For example the 'list' option can be set in
736one window and reset in another for the same text, giving both types of view
737at the same time. There are a few options that are specific to a certain
738file. These can have a different value for each file or buffer. For example
739the 'textwidth' option can be 78 for a normal text file and 0 for a C
740program.
741
742 global one option for all buffers and windows
743 local to window each window has its own copy of this option
744 local to buffer each buffer has its own copy of this option
745
746When creating a new window the option values from the currently active window
747are used as a default value for the window-specific options. For the
748buffer-specific options this depends on the 's' and 'S' flags in the
749'cpoptions' option. If 's' is included (which is the default) the values for
750buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000751first entered. If 'S' is present the options are copied each time the buffer
752is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753present, the options are copied from the currently active buffer when the
754buffer is created.
755
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000756Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000758Not all options are supported in all versions. This depends on the supported
759features and sometimes on the system. A remark about this is in curly braces
760below. When an option is not supported it may still be set without getting an
761error, this is called a hidden option. You can't get the value of a hidden
762option though, it is not stored.
763
764To test if option "foo" can be used with ":set" use something like this: >
765 if exists('&foo')
766This also returns true for a hidden option. To test if option "foo" is really
767supported use something like this: >
768 if exists('+foo')
769<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770 *E355*
771A jump table for the options with a short description can be found at |Q_op|.
772
773 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100774'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 {only available when compiled with the |+rightleft|
777 feature}
778 The ASCII code for the first letter of the Hebrew alphabet. The
779 routine that maps the keyboard in Hebrew mode, both in Insert mode
780 (when hkmap is set) and on the command-line (when hitting CTRL-_)
781 outputs the Hebrew characters in the range [aleph..aleph+26].
782 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
783 See |rileft.txt|.
784
785 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
786'allowrevins' 'ari' boolean (default off)
787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 {only available when compiled with the |+rightleft|
789 feature}
790 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
791 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
792 into reverse Insert mode, and don't know how to get out. See
793 'revins'.
794 NOTE: This option is reset when 'compatible' is set.
795
796 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
797'altkeymap' 'akm' boolean (default off)
798 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799 {only available when compiled with the |+farsi|
800 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100801 This option was for using Farsi, which has been removed. See
802 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803
804 *'ambiwidth'* *'ambw'*
805'ambiwidth' 'ambw' string (default: "single")
806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
808 Tells Vim what to do with characters with East Asian Width Class
809 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
810 letters, Cyrillic letters).
811
812 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000813 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 expected by most users.
815 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200816 *E834* *E835*
817 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100818 contains a character that would be double width. These errors may
819 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200820
821 The values are overruled for characters specified with
822 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823
824 There are a number of CJK fonts for which the width of glyphs for
825 those characters are solely based on how many octets they take in
826 legacy/traditional CJK encodings. In those encodings, Euro,
827 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000828 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000830 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 Vim is running inside a terminal (emulators) that uses a CJK font
832 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
833 this option should be set to "double" to match the width perceived
834 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100835 to be set to "double" under CJK MS-Windows when the system locale is
836 set to one of CJK locales. See Unicode Standard Annex #11
837 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100839 Vim may set this option automatically at startup time when Vim is
840 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200841 escape sequence to request cursor position report. The response can
842 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100843
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
845'antialias' 'anti' boolean (default: off)
846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200848 on macOS}
849 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
851 which can be easier to read at certain sizes on certain displays.
852 Setting this option can sometimes cause problems if 'guifont' is set
853 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100854 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
857'arabic' 'arab' boolean (default off)
858 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 {only available when compiled with the |+arabic|
860 feature}
861 This option can be set to start editing Arabic text.
862 Setting this option will:
863 - Set the 'rightleft' option, unless 'termbidi' is set.
864 - Set the 'arabicshape' option, unless 'termbidi' is set.
865 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
866 between typing English and Arabic key mapping.
867 - Set the 'delcombine' option
868 Note that 'encoding' must be "utf-8" for working with Arabic text.
869
870 Resetting this option will:
871 - Reset the 'rightleft' option.
872 - Disable the use of 'keymap' (without changing its value).
873 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200874 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100875 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 Also see |arabic.txt|.
877
878 *'arabicshape'* *'arshape'*
879 *'noarabicshape'* *'noarshape'*
880'arabicshape' 'arshape' boolean (default on)
881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 {only available when compiled with the |+arabic|
883 feature}
884 When on and 'termbidi' is off, the required visual character
885 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200886 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 one which encompasses:
888 a) the changing/morphing of characters based on their location
889 within a word (initial, medial, final and stand-alone).
890 b) the enabling of the ability to compose characters
891 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100892 When disabled the display shows each character's true stand-alone
893 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894 Arabic is a complex language which requires other settings, for
895 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100896 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897
laburnumT3f7855a2023-12-05 18:37:03 +0100898 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
899'autochdir' 'acd' boolean (default off)
900 global
901 {only available when compiled with it, use
902 exists("+autochdir") to check}
903 When on, Vim will change the current working directory whenever you
904 open a file, switch buffers, delete a buffer or open/close a window.
905 It will change to the directory containing the file which was opened
906 or selected. When a buffer has no name it also has no directory, thus
907 the current directory won't change when navigating to it.
908 Note: When this option is on some plugins may not work.
909
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
911'autoindent' 'ai' boolean (default off)
912 local to buffer
913 Copy indent from current line when starting a new line (typing <CR>
914 in Insert mode or when using the "o" or "O" command). If you do not
915 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000916 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
917 to another line has the same effect, unless the 'I' flag is included
918 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000919 When autoindent is on, formatting (with the "gq" command or when you
920 reach 'textwidth' in Insert mode) uses the indentation of the first
921 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 When 'smartindent' or 'cindent' is on the indent is changed in
923 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200924 The 'autoindent' option is reset when the 'paste' option is set and
925 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
927 *'autoread'* *'ar'* *'noautoread'* *'noar'*
928'autoread' 'ar' boolean (default off)
929 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 When a file has been detected to have been changed outside of Vim and
931 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200932 When the file has been deleted this is not done, so you have the text
933 from before it was deleted. When it appears again then it is read.
934 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 If this option has a local value, use this command to switch back to
936 using the global value: >
937 :set autoread<
938<
laburnumT3f7855a2023-12-05 18:37:03 +0100939
940 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
941'autoshelldir' 'asd' boolean (default off)
942 global
943 When on, Vim will change the current working directory whenever you
944 change the directory of the shell running in a terminal window. You
945 need proper setting-up, so whenever the shell's pwd changes an OSC 7
946 escape sequence will be emitted. For example, on Linux, you can
947 source /etc/profile.d/vte.sh in your shell profile if you use bash or
948 zsh. For bash this should work (put it in a bash init file): >
949 if [[ -n "$VIM_TERMINAL" ]]; then
950 PROMPT_COMMAND='_vim_sync_PWD'
951 function _vim_sync_PWD() {
952 printf '\033]7;file://%s\033\\' "$PWD"
953 }
954 fi
955<
956 Or, in a zsh init file: >
957 if [[ -n "$VIM_TERMINAL" ]]; then
958 autoload -Uz add-zsh-hook
959 add-zsh-hook -Uz chpwd _vim_sync_PWD
960 function _vim_sync_PWD() {
961 printf '\033]7;file://%s\033\\' "$PWD"
962 }
963 fi
964<
965 In a fish init file: >
966 if test -n "$VIM_TERMINAL"
967 function _vim_sync_PWD --on-variable=PWD
968 printf '\033]7;file://%s\033\\' "$PWD"
969 end
970 end
971<
972 You can find an alternative method at |terminal-autoshelldir|.
973 When the parsing of the OSC sequence fails you get *E1179* .
974
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
976'autowrite' 'aw' boolean (default off)
977 global
978 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000979 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000980 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
981 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000982 to another file.
983 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000984 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985 Note that for some commands the 'autowrite' option is not used, see
986 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200987 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200988 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100989 USE WITH CARE: If you make temporary changes to a buffer that you
990 don't want to be saved this option may cause it to be saved anyway.
991 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992
993 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
994'autowriteall' 'awa' boolean (default off)
995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
997 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
998 Setting this option also implies that Vim behaves like 'autowrite' has
999 been set.
1000
1001 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001002'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 When set to "dark", Vim will try to use colors that look good on a
1005 dark background. When set to "light", Vim will try to use colors that
1006 look good on a light background. Any other value is illegal.
1007 Vim tries to set the default value according to the terminal used.
1008 This will not always be correct.
1009 Setting this option does not change the background color, it tells Vim
1010 what the background color looks like. For changing the background
1011 color, see |:hi-normal|.
1012
Gregory Anders83ad2722024-01-03 19:48:51 +01001013 When 'background' is changed Vim will adjust the default color groups
1014 for the new value. But the colors used for syntax highlighting will
1015 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001016 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001017 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 the color scheme adjusts to the value of 'background' this will work.
1019 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001020 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021
1022 When setting 'background' to the default value with: >
1023 :set background&
1024< Vim will guess the value. In the GUI this should work correctly,
1025 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001026 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001027 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001029 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001030 color from the terminal. If the returned RGB value is dark/light and
1031 'background' is not dark/light, 'background' will be set and the
1032 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001033 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001034 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001035
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036 When starting the GUI, the default value for 'background' will be
1037 "light". When the value is not set in the .gvimrc, and Vim detects
1038 that the background is actually quite dark, 'background' is set to
1039 "dark". But this happens only AFTER the .gvimrc file has been read
1040 (because the window needs to be opened to find the actual background
1041 color). To get around this, force the GUI window to be opened by
1042 putting a ":gui" command in the .gvimrc file, before where the value
1043 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001044
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001045 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001046 For other systems "dark" is used when 'term' is "linux",
1047 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1048 background. Otherwise the default is "light".
1049
Bram Moolenaarc572da52017-08-27 16:52:01 +02001050 The |:terminal| command and the |term_start()| function use the
1051 'background' value to decide whether the terminal window will start
1052 with a white or black background.
1053
Bram Moolenaar071d4272004-06-13 20:20:40 +00001054 Normally this option would be set in the .vimrc file. Possibly
1055 depending on the terminal name. Example: >
1056 :if &term == "pcterm"
1057 : set background=dark
1058 :endif
1059< When this option is set, the default settings for the highlight groups
1060 will change. To use other settings, place ":highlight" commands AFTER
1061 the setting of the 'background' option.
1062 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1063 to select the colors for syntax highlighting. After changing this
1064 option, you must load syntax.vim again to see the result. This can be
1065 done with ":syntax on".
1066
1067 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001068'backspace' 'bs' string (default "", set to "indent,eol,start"
1069 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1072 mode. This is a list of items, separated by commas. Each item allows
1073 a way to backspace over something:
1074 value effect ~
1075 indent allow backspacing over autoindent
1076 eol allow backspacing over line breaks (join lines)
1077 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1078 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001079 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1080 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081
Bram Moolenaar46eea442022-03-30 10:51:39 +01001082 When the value is empty, Vi compatible backspacing is used, none of
1083 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
1085 For backwards compatibility with version 5.4 and earlier:
1086 value effect ~
1087 0 same as ":set backspace=" (Vi compatible)
1088 1 same as ":set backspace=indent,eol"
1089 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001090 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091
1092 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1093 NOTE: This option is set to "" when 'compatible' is set.
1094
1095 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1096'backup' 'bk' boolean (default off)
1097 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098 Make a backup before overwriting a file. Leave it around after the
1099 file has been successfully written. If you do not want to keep the
1100 backup file, but you do want a backup while the file is being
1101 written, reset this option and set the 'writebackup' option (this is
1102 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001103 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104 |backup-table| for more explanations.
1105 When the 'backupskip' pattern matches, a backup is not made anyway.
1106 When 'patchmode' is set, the backup may be renamed to become the
1107 oldest version of a file.
1108 NOTE: This option is reset when 'compatible' is set.
1109
1110 *'backupcopy'* *'bkc'*
1111'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001112 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001114 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115
1116 The main values are:
1117 "yes" make a copy of the file and overwrite the original one
1118 "no" rename the file and write a new one
1119 "auto" one of the previous, what works best
1120
1121 Extra values that can be combined with the ones above are:
1122 "breaksymlink" always break symlinks when writing
1123 "breakhardlink" always break hardlinks when writing
1124
1125 Making a copy and overwriting the original file:
1126 - Takes extra time to copy the file.
1127 + When the file has special attributes, is a (hard/symbolic) link or
1128 has a resource fork, all this is preserved.
1129 - When the file is a link the backup will have the name of the link,
1130 not of the real file.
1131
1132 Renaming the file and writing a new one:
1133 + It's fast.
1134 - Sometimes not all attributes of the file can be copied to the new
1135 file.
1136 - When the file is a link the new file will not be a link.
1137
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001138 The "auto" value is the middle way: When Vim sees that renaming the
1139 file is possible without side effects (the attributes can be passed on
1140 and the file is not a link) that is used. When problems are expected,
1141 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
1143 The "breaksymlink" and "breakhardlink" values can be used in
1144 combination with any of "yes", "no" and "auto". When included, they
1145 force Vim to always break either symbolic or hard links by doing
1146 exactly what the "no" option does, renaming the original file to
1147 become the backup and writing a new file in its place. This can be
1148 useful for example in source trees where all the files are symbolic or
1149 hard links and any changes should stay in the local source tree, not
1150 be propagated back to the original source.
1151 *crontab*
1152 One situation where "no" and "auto" will cause problems: A program
1153 that opens a file, invokes Vim to edit that file, and then tests if
1154 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001155 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 example.
1157
1158 When a copy is made, the original file is truncated and then filled
1159 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001160 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001161 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 group of the backup is set to the group of the original file. If this
1163 fails, the protection bits for the group are made the same as for
1164 others.
1165
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001166 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 the same attributes of the original file, and the newly written file
1168 is owned by the current user. When the file was a (hard/symbolic)
1169 link, the new file will not! That's why the "auto" value doesn't
1170 rename when the file is a link. The owner and group of the newly
1171 written file will be set to the same ones as the original file, but
1172 the system may refuse to do this. In that case the "auto" value will
1173 again not rename the file.
1174
Bram Moolenaar036986f2017-03-16 17:41:02 +01001175 NOTE: This option is set to the Vi default value when 'compatible' is
1176 set and to the Vim default value when 'compatible' is reset.
1177
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 *'backupdir'* *'bdir'*
1179'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001180 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 for Unix: ".,~/tmp,~/")
1182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 List of directories for the backup file, separated with commas.
1184 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001185 where this is possible. The directory must exist, Vim will not
1186 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001187 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 impossible!). Writing may fail because of this.
1189 - A directory "." means to put the backup file in the same directory
1190 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001191 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1192 the backup file relative to where the edited file is. The leading
1193 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194 ("." inside a directory name has no special meaning).
1195 - Spaces after the comma are ignored, other spaces are considered part
1196 of the directory name. To have a space at the start of a directory
1197 name, precede it with a backslash.
1198 - To include a comma in a directory name precede it with a backslash.
1199 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001200 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001201 the backup file name will be built from the complete path to the
1202 file with all path separators changed to percent '%' signs. This
1203 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001204 On Win32, it is also possible to end with "\\". However, When a
1205 separating comma is following, you must use "//", since "\\" will
1206 include the comma in the file name. Therefore it is recommended to
1207 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 - Environment variables are expanded |:set_env|.
1209 - Careful with '\' characters, type one before a space, type two to
1210 get one in the option (see |option-backslash|), for example: >
1211 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1212< - For backwards compatibility with Vim version 3.0 a '>' at the start
1213 of the option is removed.
1214 See also 'backup' and 'writebackup' options.
1215 If you want to hide your backup files on Unix, consider this value: >
1216 :set backupdir=./.backup,~/.backup,.,/tmp
1217< You must create a ".backup" directory in each directory and in your
1218 home directory for this to work properly.
1219 The use of |:set+=| and |:set-=| is preferred when adding or removing
1220 directories from the list. This avoids problems when a future version
1221 uses another default.
1222 This option cannot be set from a |modeline| or in the |sandbox|, for
1223 security reasons.
1224
1225 *'backupext'* *'bex'* *E589*
1226'backupext' 'bex' string (default "~", for VMS: "_")
1227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 String which is appended to a file name to make the name of the
1229 backup file. The default is quite unusual, because this avoids
1230 accidentally overwriting existing files with a backup file. You might
1231 prefer using ".bak", but make sure that you don't have files with
1232 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001233 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001235 If you like to keep a lot of backups, you could use a BufWritePre
1236 autocommand to change 'backupext' just before writing the file to
1237 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001238 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001239< Use 'backupdir' to put the backup in a different directory.
1240
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001242'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1243 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1244 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 A list of file patterns. When one of the patterns matches with the
1247 name of the file which is written, no backup file is created. Both
1248 the specified file name and the full path name of the file are used.
1249 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1250 Watch out for special characters, see |option-backslash|.
1251 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001252 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001253
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001254 WARNING: Not having a backup file means that when Vim fails to write
1255 your buffer correctly and then, for whatever reason, Vim exits, you
1256 lose both the original file and what you were writing. Only disable
1257 backups if you don't care about losing the file.
1258
Bram Moolenaar02467872007-05-06 13:22:01 +00001259 Note that environment variables are not expanded. If you want to use
1260 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001261 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001262
1263< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001264 backup would be made by renaming the original file crontab won't see
1265 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266
1267 *'balloondelay'* *'bdlay'*
1268'balloondelay' 'bdlay' number (default: 600)
1269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 {only available when compiled with the |+balloon_eval|
1271 feature}
1272 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1273
1274 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1275'ballooneval' 'beval' boolean (default off)
1276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001278 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001279 Switch on the |balloon-eval| functionality for the GUI.
1280
1281 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1282 *'nobevalterm'*
1283'balloonevalterm' 'bevalterm' boolean (default off)
1284 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001285 {only available when compiled with the
1286 |+balloon_eval_term| feature}
1287 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001289 *'balloonexpr'* *'bexpr'*
1290'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001291 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001292 {only available when compiled with the |+balloon_eval|
1293 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001294 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001295 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1296 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001297
1298 v:beval_bufnr number of the buffer in which balloon is going to show
1299 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001300 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001301 v:beval_lnum line number
1302 v:beval_col column number (byte index)
1303 v:beval_text word under or after the mouse pointer
1304
Bram Moolenaar54775062019-07-31 21:07:14 +02001305 Instead of showing a balloon, which is limited to plain text, consider
1306 using a popup window, see |popup_beval_example|. A popup window can
1307 use highlighting and show a border.
1308
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001309 The evaluation of the expression must not have side effects!
1310 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001311 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001312 return 'Cursor is at line ' .. v:beval_lnum ..
1313 \ ', column ' .. v:beval_col ..
1314 \ ' of file ' .. bufname(v:beval_bufnr) ..
1315 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001316 endfunction
1317 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001318 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001319<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001320 Also see |balloon_show()|, it can be used if the content of the balloon
1321 is to be fetched asynchronously. In that case evaluating
1322 'balloonexpr' should result in an empty string. If you get a balloon
1323 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001324
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001325 NOTE: The balloon is displayed only if the cursor is on a text
1326 character. If the result of evaluating 'balloonexpr' is not empty,
1327 Vim does not try to send a message to an external debugger (Netbeans
1328 or Sun Workshop).
1329
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001330 If the expression starts with s: or |<SID>|, then it is replaced with
1331 the script ID (|local-function|). Example: >
1332 set bexpr=s:MyBalloonExpr()
1333 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001334< Otherwise, the expression is evaluated in the context of the script
1335 where the option was set, thus script-local items are available.
1336
Bram Moolenaar30b65812012-07-12 22:01:11 +02001337 The expression will be evaluated in the |sandbox| when set from a
1338 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001339 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001340
1341 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001342 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001343
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001344 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001345 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001346< When they are supported "\n" characters will start a new line. If the
1347 expression evaluates to a |List| this is equal to using each List item
1348 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001349 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001350
Bram Moolenaar165bc692015-07-21 17:53:25 +02001351 *'belloff'* *'bo'*
1352'belloff' 'bo' string (default "")
1353 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001354 Specifies for which events the bell will not be rung. It is a comma
1355 separated list of items. For each item that is present, the bell
1356 will be silenced. This is most useful to specify specific events in
1357 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001358 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001359
1360 item meaning when present ~
1361 all All events.
1362 backspace When hitting <BS> or <Del> and deleting results in an
1363 error.
1364 cursor Fail to move around using the cursor keys or
1365 <PageUp>/<PageDown> in |Insert-mode|.
1366 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1367 |i_CTRL-X_CTRL-T|.
1368 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1369 |i_CTRL-E|.
1370 ctrlg Unknown Char after <C-G> in Insert mode.
1371 error Other Error occurred (e.g. try to join last line)
1372 (mostly used in |Normal-mode| or |Cmdline-mode|).
1373 esc hitting <Esc> in |Normal-mode|.
1374 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001375 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001376 insertmode Pressing <Esc> in 'insertmode'.
1377 lang Calling the beep module for Lua/Mzscheme/TCL.
1378 mess No output available for |g<|.
1379 showmatch Error occurred for 'showmatch' function.
1380 operator Empty region error |cpo-E|.
1381 register Unknown register after <C-R> in |Insert-mode|.
1382 shell Bell from shell output |:!|.
1383 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001384 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001385 wildmode More matches in |cmdline-completion| available
1386 (depends on the 'wildmode' setting).
1387
Bram Moolenaar036986f2017-03-16 17:41:02 +01001388 This is most useful to fine tune when in Insert mode the bell should
1389 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001390 indicate that an error occurred. It can be silenced by adding the
1391 "error" keyword.
1392
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1394'binary' 'bin' boolean (default off)
1395 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 This option should be set before editing a binary file. You can also
1397 use the |-b| Vim argument. When this option is switched on a few
1398 options will be changed (also when it already was on):
1399 'textwidth' will be set to 0
1400 'wrapmargin' will be set to 0
1401 'modeline' will be off
1402 'expandtab' will be off
1403 Also, 'fileformat' and 'fileformats' options will not be used, the
1404 file is read and written like 'fileformat' was "unix" (a single <NL>
1405 separates lines).
1406 The 'fileencoding' and 'fileencodings' options will not be used, the
1407 file is read without conversion.
1408 NOTE: When you start editing a(nother) file while the 'bin' option is
1409 on, settings from autocommands may change the settings again (e.g.,
1410 'textwidth'), causing trouble when editing. You might want to set
1411 'bin' again when the file has been loaded.
1412 The previous values of these options are remembered and restored when
1413 'bin' is switched from on to off. Each buffer has its own set of
1414 saved option values.
1415 To edit a file with 'binary' set you can use the |++bin| argument.
1416 This avoids you have to do ":set bin", which would have effect for all
1417 files you edit.
1418 When writing a file the <EOL> for the last line is only written if
1419 there was one in the original file (normally Vim appends an <EOL> to
1420 the last line if there is none; this would make the file longer). See
1421 the 'endofline' option.
1422
1423 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1424'bioskey' 'biosk' boolean (default on)
1425 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001426 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001427 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428
1429 *'bomb'* *'nobomb'*
1430'bomb' boolean (default off)
1431 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432 When writing a file and the following conditions are met, a BOM (Byte
1433 Order Mark) is prepended to the file:
1434 - this option is on
1435 - the 'binary' option is off
1436 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1437 endian variants.
1438 Some applications use the BOM to recognize the encoding of the file.
1439 Often used for UCS-2 files on MS-Windows. For other applications it
1440 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001441 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1443 check for the presence of the BOM is done and 'bomb' set accordingly.
1444 Unless 'binary' is set, it is removed from the first line, so that you
1445 don't see it when editing. When you don't change the options, the BOM
1446 will be restored when writing the file.
1447
1448 *'breakat'* *'brk'*
1449'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1450 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001451 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452 feature}
1453 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001454 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1455 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001457 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001458'breakindent' 'bri' boolean (default off)
1459 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001460 {not available when compiled without the |+linebreak|
1461 feature}
1462 Every wrapped line will continue visually indented (same amount of
1463 space as the beginning of that line), thus preserving horizontal blocks
1464 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001465 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001466
1467 *'breakindentopt'* *'briopt'*
1468'breakindentopt' 'briopt' string (default empty)
1469 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001470 {not available when compiled without the |+linebreak|
1471 feature}
1472 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001473 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001474 min:{n} Minimum text width that will be kept after
1475 applying 'breakindent', even if the resulting
1476 text should normally be narrower. This prevents
1477 text indented almost to the right window border
1478 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001479 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001480 shift:{n} After applying 'breakindent', the wrapped line's
1481 beginning will be shifted by the given number of
1482 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001483 indentation (negative) or emphasizing the line
1484 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001485 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001486 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001487 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001488 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001489 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001490 numbered or bulleted list (using the
1491 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001492 list:-1 Uses the length of a match with 'formatlistpat'
1493 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001494 (default: 0)
1495 column:{n} Indent at column {n}. Will overrule the other
1496 sub-options. Note: an additional indent may be
1497 added for the 'showbreak' setting.
1498 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001499
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001501'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001503 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001505 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001506 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 buffer Use the directory of the related buffer.
1508 current Use the current directory.
1509 {path} Use the specified directory
1510
1511 *'bufhidden'* *'bh'*
1512'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001513 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514 This option specifies what happens when a buffer is no longer
1515 displayed in a window:
1516 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001517 hide hide the buffer (don't unload it), even if 'hidden' is
1518 not set
1519 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001520 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001521 delete delete the buffer from the buffer list, even if
1522 'hidden' is set; the |:hide| command will also delete
1523 the buffer, making it behave like |:bdelete|
1524 wipe wipe the buffer from the buffer list, even if
1525 'hidden' is set; the |:hide| command will also wipe
1526 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001528 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001529 are lost without a warning. Also, these values may break autocommands
1530 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 This option is used together with 'buftype' and 'swapfile' to specify
1532 special kinds of buffers. See |special-buffers|.
1533
1534 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1535'buflisted' 'bl' boolean (default: on)
1536 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 When this option is set, the buffer shows up in the buffer list. If
1538 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1539 This option is reset by Vim for buffers that are only used to remember
1540 a file name or marks. Vim sets it when starting to edit a buffer.
1541 But not when moving to a buffer with ":buffer".
1542
1543 *'buftype'* *'bt'* *E382*
1544'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001545 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 The value of this option specifies the type of a buffer:
1547 <empty> normal buffer
1548 nofile buffer which is not related to a file and will not be
1549 written
1550 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001551 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001552 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001554 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 help help buffer (you are not supposed to set this
1556 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001557 terminal buffer for a |terminal| (you are not supposed to set
1558 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001559 prompt buffer where only the last line can be edited, meant
1560 to be used by a plugin, see |prompt-buffer|
1561 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001562 popup buffer used in a popup window, see |popup|.
1563 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564
1565 This option is used together with 'bufhidden' and 'swapfile' to
1566 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001567 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568
1569 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001570 One such effect is that Vim will not check the timestamp of the file,
1571 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572
Bram Moolenaar280f1262006-01-30 00:14:18 +00001573 A "quickfix" buffer is only used for the error list and the location
1574 list. This value is set by the |:cwindow| and |:lwindow| commands and
1575 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576
1577 "nofile" and "nowrite" buffers are similar:
1578 both: The buffer is not to be written to disk, ":w" doesn't
1579 work (":w filename" does work though).
1580 both: The buffer is never considered to be |'modified'|.
1581 There is no warning when the changes will be lost, for
1582 example when you quit Vim.
1583 both: A swap file is only created when using too much memory
1584 (when 'swapfile' has been reset there is never a swap
1585 file).
1586 nofile only: The buffer name is fixed, it is not handled like a
1587 file name. It is not modified in response to a |:cd|
1588 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001589 both: When using ":e bufname" and already editing "bufname"
1590 the buffer is made empty and autocommands are
1591 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001592 *E676*
1593 "acwrite" implies that the buffer name is not related to a file, like
1594 "nofile", but it will be written. Thus, in contrast to "nofile" and
1595 "nowrite", ":w" does work and a modified buffer can't be abandoned
1596 without saving. For writing there must be matching |BufWriteCmd|,
1597 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598
1599 *'casemap'* *'cmp'*
1600'casemap' 'cmp' string (default: "internal,keepascii")
1601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 Specifies details about changing the case of letters. It may contain
1603 these words, separated by a comma:
1604 internal Use internal case mapping functions, the current
1605 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001606 matters when 'encoding' is a Unicode encoding,
1607 "latin1" or "iso-8859-15". When "internal" is
1608 omitted, the towupper() and towlower() system library
1609 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1611 case mapping, the current locale is not effective.
1612 This probably only matters for Turkish.
1613
Bram Moolenaar938ae282023-02-20 20:44:55 +00001614 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001615'cdhome' 'cdh' boolean (default: off)
1616 global
1617 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1618 current working directory to the |$HOME| directory like in Unix.
1619 When off, those commands just print the current directory name.
1620 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001621 This option cannot be set from a |modeline| or in the |sandbox|, for
1622 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001623 NOTE: This option is reset when 'compatible' is set.
1624
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 *'cdpath'* *'cd'* *E344* *E346*
1626'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001629 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1630 searched for has a relative path, not an absolute part starting with
1631 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 The 'cdpath' option's value has the same form and semantics as
1633 |'path'|. Also see |file-searching|.
1634 The default value is taken from $CDPATH, with a "," prepended to look
1635 in the current directory first.
1636 If the default value taken from $CDPATH is not what you want, include
1637 a modified version of the following command in your vimrc file to
1638 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001639 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640< This option cannot be set from a |modeline| or in the |sandbox|, for
1641 security reasons.
1642 (parts of 'cdpath' can be passed to the shell to expand file names).
1643
1644 *'cedit'*
1645'cedit' string (Vi default: "", Vim default: CTRL-F)
1646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 The key used in Command-line Mode to open the command-line window.
1648 The default is CTRL-F when 'compatible' is off.
1649 Only non-printable keys are allowed.
1650 The key can be specified as a single character, but it is difficult to
1651 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001652 :exe "set cedit=\<C-Y>"
1653 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654< |Nvi| also has this option, but it only uses the first character.
1655 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001656 NOTE: This option is set to the Vim default value when 'compatible'
1657 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658
1659 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1660'charconvert' 'ccv' string (default "")
1661 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001662 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 An expression that is used for character encoding conversion. It is
1664 evaluated when a file that is to be read or has been written has a
1665 different encoding from what is desired.
1666 'charconvert' is not used when the internal iconv() function is
1667 supported and is able to do the conversion. Using iconv() is
1668 preferred, because it is much faster.
1669 'charconvert' is not used when reading stdin |--|, because there is no
1670 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001671 The expression must return zero, false or an empty string for success,
1672 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 The possible encoding names encountered are in 'encoding'.
1674 Additionally, names given in 'fileencodings' and 'fileencoding' are
1675 used.
1676 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1677 is done internally by Vim, 'charconvert' is not used for this.
1678 'charconvert' is also used to convert the viminfo file, if the 'c'
1679 flag is present in 'viminfo'. Also used for Unicode conversion.
1680 Example: >
1681 set charconvert=CharConvert()
1682 fun CharConvert()
1683 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001684 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1685 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 return v:shell_error
1687 endfun
1688< The related Vim variables are:
1689 v:charconvert_from name of the current encoding
1690 v:charconvert_to name of the desired encoding
1691 v:fname_in name of the input file
1692 v:fname_out name of the output file
1693 Note that v:fname_in and v:fname_out will never be the same.
1694 Note that v:charconvert_from and v:charconvert_to may be different
1695 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001696
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001697 The advantage of using a function call without arguments is that it is
1698 faster, see |expr-option-function|.
1699
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 Encryption is not done by Vim when using 'charconvert'. If you want
1701 to encrypt the file after conversion, 'charconvert' should take care
1702 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001703
1704 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1705 replaced with the script ID (|local-function|). Example: >
1706 set charconvert=s:MyConvert()
1707 set charconvert=<SID>SomeConvert()
1708< Otherwise the expression is evaluated in the context of the script
1709 where the option was set, thus script-local items are available.
1710
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 This option cannot be set from a |modeline| or in the |sandbox|, for
1712 security reasons.
1713
1714 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1715'cindent' 'cin' boolean (default off)
1716 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001717 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 that trigger reindenting in insert mode and 'cinoptions' to set your
1719 preferred indent style.
1720 If 'indentexpr' is not empty, it overrules 'cindent'.
1721 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1722 the "=" operator indents using this algorithm rather than calling an
1723 external program.
1724 See |C-indenting|.
1725 When you don't like the way 'cindent' works, try the 'smartindent'
1726 option or 'indentexpr'.
1727 This option is not used when 'paste' is set.
1728 NOTE: This option is reset when 'compatible' is set.
1729
1730 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001731'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 A list of keys that, when typed in Insert mode, cause reindenting of
1734 the current line. Only used if 'cindent' is on and 'indentexpr' is
1735 empty.
1736 For the format of this option see |cinkeys-format|.
1737 See |C-indenting|.
1738
1739 *'cinoptions'* *'cino'*
1740'cinoptions' 'cino' string (default "")
1741 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1743 program. See |cinoptions-values| for the values of this option, and
1744 |C-indenting| for info on C indenting in general.
1745
laburnumT3f7855a2023-12-05 18:37:03 +01001746 *'cinscopedecls'* *'cinsd'*
1747'cinscopedecls' 'cinsd' string (default "public,protected,private")
1748 local to buffer
1749 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1750 Useful e.g. for working with the Qt framework that defines additional
1751 scope declarations "signals", "public slots" and "private slots": >
1752 set cinscopedecls+=signals,public\ slots,private\ slots
1753<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 *'cinwords'* *'cinw'*
1755'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1756 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 These keywords start an extra indent in the next line when
1758 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1759 an appropriate place (inside {}).
1760 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1761 matter, include the keyword both the uppercase and lowercase:
1762 "if,If,IF".
1763
laburnumT3f7855a2023-12-05 18:37:03 +01001764 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1766 for X-windows, "" otherwise)
1767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 {only in GUI versions or when the |+xterm_clipboard|
1769 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001770 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001771 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001772 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001773 prepend, e.g.: >
1774 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001775< When using the GUI see |'go-A'|.
1776 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001778 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 unnamed When included, Vim will use the clipboard register '*'
1780 for all yank, delete, change and put operations which
1781 would normally go to the unnamed register. When a
1782 register is explicitly specified, it will always be
1783 used regardless of whether "unnamed" is in 'clipboard'
1784 or not. The clipboard register can always be
1785 explicitly accessed using the "* notation. Also see
1786 |gui-clipboard|.
1787
Bram Moolenaar30b65812012-07-12 22:01:11 +02001788 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001789 unnamedplus A variant of the "unnamed" flag which uses the
1790 clipboard register '+' (|quoteplus|) instead of
1791 register '*' for all yank, delete, change and put
1792 operations which would normally go to the unnamed
1793 register. When "unnamed" is also included to the
1794 option, yank operations (but not delete, change or
1795 put) will additionally copy the text into register
1796 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001797 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001798 Availability can be checked with: >
1799 if has('unnamedplus')
1800<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001801 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 autoselect Works like the 'a' flag in 'guioptions': If present,
1803 then whenever Visual mode is started, or the Visual
1804 area extended, Vim tries to become the owner of the
1805 windowing system's global selection or put the
1806 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001807 register "*. See |'go-a'| and |quotestar| for details.
1808 When the GUI is active, the 'a' flag in 'guioptions'
1809 is used, when the GUI is not active, this "autoselect"
1810 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 Also applies to the modeless selection.
1812
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001813 *clipboard-autoselectplus*
1814 autoselectplus Like "autoselect" but using the + register instead of
1815 the * register. Compare to the 'P' flag in
1816 'guioptions'.
1817
1818 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 autoselectml Like "autoselect", but for the modeless selection
1820 only. Compare to the 'A' flag in 'guioptions'.
1821
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001822 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001823 html When the clipboard contains HTML, use this when
1824 pasting. When putting text on the clipboard, mark it
1825 as HTML. This works to copy rendered HTML from
1826 Firefox, paste it as raw HTML in Vim, select the HTML
1827 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001828 You probably want to add this only temporarily,
1829 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001830 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001831
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001832 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 exclude:{pattern}
1834 Defines a pattern that is matched against the name of
1835 the terminal 'term'. If there is a match, no
1836 connection will be made to the X server. This is
1837 useful in this situation:
1838 - Running Vim in a console.
1839 - $DISPLAY is set to start applications on another
1840 display.
1841 - You do not want to connect to the X server in the
1842 console, but do want this in a terminal emulator.
1843 To never connect to the X server use: >
1844 exclude:.*
1845< This has the same effect as using the |-X| argument.
1846 Note that when there is no connection to the X server
1847 the window title won't be restored and the clipboard
1848 cannot be accessed.
1849 The value of 'magic' is ignored, {pattern} is
1850 interpreted as if 'magic' was on.
1851 The rest of the option value will be used for
1852 {pattern}, this must be the last entry.
1853
1854 *'cmdheight'* *'ch'*
1855'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001856 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001857 Number of screen lines to use for the command-line. A larger value
1858 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001859 The value of this option is stored with the tab page, so that each tab
1860 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861
1862 *'cmdwinheight'* *'cwh'*
1863'cmdwinheight' 'cwh' number (default 7)
1864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 Number of screen lines to use for the command-line window. |cmdwin|
1866
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001867 *'colorcolumn'* *'cc'*
1868'colorcolumn' 'cc' string (default "")
1869 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001870 {not available when compiled without the |+syntax|
1871 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001872 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001873 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1874 text. Will make screen redrawing slower.
1875 The screen column can be an absolute number, or a number preceded with
1876 '+' or '-', which is added to or subtracted from 'textwidth'. >
1877
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001878 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001879 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1880 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1881<
1882 When 'textwidth' is zero then the items with '-' and '+' are not used.
1883 A maximum of 256 columns are highlighted.
1884
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 *'columns'* *'co'* *E594*
1886'columns' 'co' number (default 80 or terminal width)
1887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001889 initialization and does not have to be set by hand. Also see
1890 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 When Vim is running in the GUI or in a resizable window, setting this
1892 option will cause the window size to be changed. When you only want
1893 to use the size for the GUI, put the command in your |gvimrc| file.
1894 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001895 number of columns of the display, the display may be messed up. For
1896 the GUI it is always possible and Vim limits the number of columns to
1897 what fits on the screen. You can use this command to get the widest
1898 window possible: >
1899 :set columns=9999
1900< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901
1902 *'comments'* *'com'* *E524* *E525*
1903'comments' 'com' string (default
1904 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1905 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001906 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907 |format-comments|. See |option-backslash| about using backslashes to
1908 insert a space.
1909
1910 *'commentstring'* *'cms'* *E537*
1911'commentstring' 'cms' string (default "/*%s*/")
1912 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 {not available when compiled without the |+folding|
1914 feature}
1915 A template for a comment. The "%s" in the value is replaced with the
1916 comment text. Currently only used to add markers for folding, see
1917 |fold-marker|.
1918
1919 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001920'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001921 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 This option has the effect of making Vim either more Vi-compatible, or
1924 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001925
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001927 other options are also changed as a side effect.
1928 NOTE: Setting or resetting this option can have a lot of unexpected
1929 effects: Mappings are interpreted in another way, undo behaves
1930 differently, etc. If you set this option in your vimrc file, you
1931 should probably put it at the very start.
1932
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 By default this option is on and the Vi defaults are used for the
1934 options. This default was chosen for those people who want to use Vim
1935 just like Vi, and don't even (want to) know about the 'compatible'
1936 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001937 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001938 this option is switched off, and all options that have not been
1939 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001940 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001941 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001942 happen for the system-wide vimrc or gvimrc file, nor for a file given
1943 with the |-u| argument). Also see |compatible-default| and
1944 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001945 You can also set this option with the "-C" argument, and reset it with
1946 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001947 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948
Bram Moolenaar214641f2017-03-05 17:04:09 +01001949 When this option is set, numerous other options are set to make Vim as
1950 Vi-compatible as possible. When this option is unset, various options
1951 are set to make Vim more useful. The table below lists all the
1952 options affected.
1953 The {?} column indicates when the options are affected:
1954 + Means that the option is set to the value given in {set value} when
1955 'compatible' is set.
1956 & Means that the option is set to the value given in {set value} when
1957 'compatible' is set AND is set to its Vim default value when
1958 'compatible' is unset.
1959 - Means the option is NOT changed when setting 'compatible' but IS
1960 set to its Vim default when 'compatible' is unset.
1961 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962
Bram Moolenaar036986f2017-03-16 17:41:02 +01001963 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001964
1965 'allowrevins' + off no CTRL-_ command
1966 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001967 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001968 'arabicshape' + on correct character shapes
1969 'backspace' + "" normal backspace
1970 'backup' + off no backup file
1971 'backupcopy' & Unix: "yes" backup file is a copy
1972 else: "auto" copy or rename backup file
1973 'balloonexpr' + "" text to show in evaluation balloon
1974 'breakindent' + off don't indent when wrapping lines
1975 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001976 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001977 'cindent' + off no C code indentation
1978 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1979 'copyindent' + off don't copy indent structure
1980 'cpoptions' & (all flags) Vi-compatible flags
1981 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001982 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001983 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001984 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001985 'cscopeverbose' + off see |cscopeverbose|
1986 'delcombine' + off unicode: delete whole char combination
1987 'digraph' + off no digraphs
1988 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001989 this also disables |modifyOtherKeys|
1990 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001991 'expandtab' + off tabs not expanded to spaces
1992 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001993 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001994 'formatexpr' + "" use 'formatprg' for auto-formatting
1995 'formatoptions' & "vt" Vi compatible formatting
1996 'gdefault' + off no default 'g' flag for ":s"
1997 'history' & 0 no commandline history
1998 'hkmap' + off no Hebrew keyboard mapping
1999 'hkmapp' + off no phonetic Hebrew keyboard mapping
2000 'hlsearch' + off no highlighting of search matches
2001 'incsearch' + off no incremental searching
2002 'indentexpr' + "" no indenting by expression
2003 'insertmode' + off do not start in Insert mode
2004 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002006 'joinspaces' + on insert 2 spaces after period
2007 'modeline' & off no modelines
2008 'more' & off no pauses in listings
2009 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2010 'numberwidth' & 8 min number of columns for line number
2011 'preserveindent'+ off don't preserve current indent structure
2012 when changing it
2013 'revins' + off no reverse insert
2014 'ruler' + off no ruler
2015 'scrolljump' + 1 no jump scroll
2016 'scrolloff' + 0 no scroll offset
2017 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2018 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002019 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002020 'showcmd' & off command characters not shown
2021 'showmode' & off current mode not shown
2022 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2023 'smartcase' + off no automatic ignore case switch
2024 'smartindent' + off no smart indentation
2025 'smarttab' + off no smart tab size
2026 'softtabstop' + 0 tabs are always 'tabstop' positions
2027 'startofline' + on goto startofline with some commands
2028 'tagcase' & "followic" 'ignorecase' when searching tags file
2029 'tagrelative' & off tag file names are not relative
2030 'termguicolors' + off don't use highlight-(guifg|guibg)
2031 'textauto' & off no automatic textmode detection
2032 'textwidth' + 0 no automatic line wrap
2033 'tildeop' + off tilde is not an operator
2034 'ttimeout' + off no terminal timeout
2035 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002036 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002037 'virtualedit' + "" cursor can only be placed on characters
2038 'whichwrap' & "" left-right movements don't wrap
2039 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002041 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042
2043 *'complete'* *'cpt'* *E535*
2044'complete' 'cpt' string (default: ".,w,b,u,t,i")
2045 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 This option specifies how keyword completion |ins-completion| works
2047 when CTRL-P or CTRL-N are used. It is also used for whole-line
2048 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002049 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002050 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 w scan buffers from other windows
2052 b scan other loaded buffers that are in the buffer list
2053 u scan the unloaded buffers that are in the buffer list
2054 U scan the buffers that are not in the buffer list
2055 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002056 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 k{dict} scan the file {dict}. Several "k" flags can be given,
2058 patterns are valid too. For example: >
2059 :set cpt=k/usr/dict/*,k~/spanish
2060< s scan the files given with the 'thesaurus' option
2061 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2062 are valid too.
2063 i scan current and included files
2064 d scan current and included files for defined name or macro
2065 |i_CTRL-X_CTRL-D|
2066 ] tag completion
2067 t same as "]"
2068
2069 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2070 not executed, this may lead to unexpected completions from some files
2071 (gzipped files for example). Unloaded buffers are not scanned for
2072 whole-line completion.
2073
2074 The default is ".,w,b,u,t,i", which means to scan:
2075 1. the current buffer
2076 2. buffers in other windows
2077 3. other loaded buffers
2078 4. unloaded buffers
2079 5. tags
2080 6. included files
2081
2082 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002083 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2084 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002086 *'completefunc'* *'cfu'*
2087'completefunc' 'cfu' string (default: empty)
2088 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002089 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002090 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002091 This option specifies a function to be used for Insert mode completion
2092 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002093 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002094 invoked and what it should return. The value can be the name of a
2095 function, a |lambda| or a |Funcref|. See |option-value-function| for
2096 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002097 This option cannot be set from a |modeline| or in the |sandbox|, for
2098 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002099
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002100 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002101'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002102 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002103 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002104 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002105
2106 menu Use a popup menu to show the possible completions. The
2107 menu is only shown when there is more than one match and
2108 sufficient colors are available. |ins-completion-menu|
2109
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002110 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002111 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002112 match, e.g., what file it comes from.
2113
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002114 longest Only insert the longest common text of the matches. If
2115 the menu is displayed you can use CTRL-L to add more
2116 characters. Whether case is ignored depends on the kind
2117 of completion. For buffer text the 'ignorecase' option is
2118 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002119
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002120 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002121 completion in the preview window. Only works in
2122 combination with "menu" or "menuone".
2123
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002124 popup Show extra information about the currently selected
2125 completion in a popup window. Only works in combination
2126 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002127 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002128 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002129
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002130 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002131 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002132 |CompleteChanged| autocommand to fetch the info and call
2133 |popup_show()| once the popup has been filled.
2134 See the example at |complete-popuphidden|.
2135 {only works when compiled with the |+textprop| feature}
2136
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002137 noinsert Do not insert any text for a match until the user selects
2138 a match from the menu. Only works in combination with
2139 "menu" or "menuone". No effect if "longest" is present.
2140
2141 noselect Do not select a match in the menu, force the user to
2142 select one from the menu. Only works in combination with
2143 "menu" or "menuone".
2144
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002145 *'completepopup'* *'cpp'*
2146'completepopup' 'cpp' string (default empty)
2147 global
2148 {not available when compiled without the |+textprop|
2149 or |+quickfix| feature}
2150 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002151 properties of the info popup when it is created. If an info popup
2152 window already exists it is closed, so that the option value is
2153 applied when it is created again.
2154 You can also use |popup_findinfo()| and then set properties for an
2155 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002156
laburnumT3f7855a2023-12-05 18:37:03 +01002157 *'completeslash'* *'csl'*
2158'completeslash' 'csl' string (default: "")
2159 local to buffer
2160 {only for MS-Windows}
2161 When this option is set it overrules 'shellslash' for completion:
2162 - When this option is set to "slash", a forward slash is used for path
2163 completion in insert mode. This is useful when editing HTML tag, or
2164 Makefile with 'noshellslash' on MS-Windows.
2165 - When this option is set to "backslash", backslash is used. This is
2166 useful when editing a batch file with 'shellslash' set on MS-Windows.
2167 - When this option is empty, same character is used as for
2168 'shellslash'.
2169 For Insert mode completion the buffer-local value is used. For
2170 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002171
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002172 *'concealcursor'* *'cocu'*
2173'concealcursor' 'cocu' string (default: "")
2174 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002175 {not available when compiled without the |+conceal|
2176 feature}
2177 Sets the modes in which text in the cursor line can also be concealed.
2178 When the current mode is listed then concealing happens just like in
2179 other lines.
2180 n Normal mode
2181 v Visual mode
2182 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002183 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002184
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002185 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002186 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002187 are moving around text is concealed, but when starting to insert text
2188 or selecting a Visual area the concealed text is displayed, so that
2189 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002190 Keep in mind that the cursor position is not always where it's
2191 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002192
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002193 *'conceallevel'* *'cole'*
2194'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002195 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002196 {not available when compiled without the |+conceal|
2197 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002198 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2199 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002200
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002201 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002202 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002203 1 Each block of concealed text is replaced with one
2204 character. If the syntax item does not have a custom
2205 replacement character defined (see |:syn-cchar|) the
2206 character defined in 'listchars' is used (default is a
2207 space).
2208 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002209 2 Concealed text is completely hidden unless it has a
2210 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002211 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002212 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002213
Bram Moolenaara7781e02010-07-19 20:13:22 +02002214 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002215 edit and copy the text. This can be changed with the 'concealcursor'
2216 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002217
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2219'confirm' 'cf' boolean (default off)
2220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 When 'confirm' is on, certain operations that would normally
2222 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2223 instead raise a |dialog| asking if you wish to save the current
2224 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2225 If 'confirm' is off you can still activate confirmation for one
2226 command only (this is most useful in mappings) with the |:confirm|
2227 command.
2228 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2229
2230 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2231'conskey' 'consk' boolean (default off)
2232 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002233 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234
2235 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2236'copyindent' 'ci' boolean (default off)
2237 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 Copy the structure of the existing lines indent when autoindenting a
2239 new line. Normally the new indent is reconstructed by a series of
2240 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2241 in which case only spaces are used). Enabling this option makes the
2242 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002243 existing line. 'expandtab' has no effect on these characters, a Tab
2244 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002246 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 Also see 'preserveindent'.
2248
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002249 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250'cpoptions' 'cpo' string (Vim default: "aABceFs",
2251 Vi default: all flags)
2252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002254 this indicates Vi-compatible behavior. This is used for things where
2255 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 'cpoptions' stands for "compatible-options".
2257 Commas can be added for readability.
2258 To avoid problems with flags that are added in the future, use the
2259 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002260
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 NOTE: This option is set to the Vi default value when 'compatible' is
2262 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002263
2264 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2265 is saved, 'cpoptions' is set to the Vim default, and the saved value
2266 is restored at the end of the script. Changes to the value of
2267 'cpoptions' will be applied to the saved value, but keep in mind that
2268 removing a flag that is not present when 'cpoptions' is changed has no
2269 effect. In the |.vimrc| file the value is not restored, thus using
2270 `vim9script` in the |.vimrc| file results in using the Vim default.
2271
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002272 NOTE: This option is set to the POSIX default value at startup when
2273 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002274 variable exists |posix|. This means Vim tries to behave like the
2275 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276
2277 contains behavior ~
2278 *cpo-a*
2279 a When included, a ":read" command with a file name
2280 argument will set the alternate file name for the
2281 current window.
2282 *cpo-A*
2283 A When included, a ":write" command with a file name
2284 argument will set the alternate file name for the
2285 current window.
2286 *cpo-b*
2287 b "\|" in a ":map" command is recognized as the end of
2288 the map command. The '\' is included in the mapping,
2289 the text after the '|' is interpreted as the next
2290 command. Use a CTRL-V instead of a backslash to
2291 include the '|' in the mapping. Applies to all
2292 mapping, abbreviation, menu and autocmd commands.
2293 See also |map_bar|.
2294 *cpo-B*
2295 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002296 abbreviations, user commands and the "to" part of the
2297 menu commands. Remove this flag to be able to use a
2298 backslash like a CTRL-V. For example, the command
2299 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 'B' included: "\^[" (^[ is a real <Esc>)
2301 'B' excluded: "<Esc>" (5 characters)
2302 ('<' excluded in both cases)
2303 *cpo-c*
2304 c Searching continues at the end of any match at the
2305 cursor position, but not further than the start of the
2306 next line. When not present searching continues
2307 one character from the cursor position. With 'c'
2308 "abababababab" only gets three matches when repeating
2309 "/abab", without 'c' there are five matches.
2310 *cpo-C*
2311 C Do not concatenate sourced lines that start with a
2312 backslash. See |line-continuation|.
2313 *cpo-d*
2314 d Using "./" in the 'tags' option doesn't mean to use
2315 the tags file relative to the current file, but the
2316 tags file in the current directory.
2317 *cpo-D*
2318 D Can't use CTRL-K to enter a digraph after Normal mode
2319 commands with a character argument, like |r|, |f| and
2320 |t|.
2321 *cpo-e*
2322 e When executing a register with ":@r", always add a
2323 <CR> to the last line, also when the register is not
2324 linewise. If this flag is not present, the register
2325 is not linewise and the last line does not end in a
2326 <CR>, then the last line is put on the command-line
2327 and can be edited before hitting <CR>.
2328 *cpo-E*
2329 E It is an error when using "y", "d", "c", "g~", "gu" or
2330 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002331 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 This makes "y0" fail in the first column.
2333 *cpo-f*
2334 f When included, a ":read" command with a file name
2335 argument will set the file name for the current buffer,
2336 if the current buffer doesn't have a file name yet.
2337 *cpo-F*
2338 F When included, a ":write" command with a file name
2339 argument will set the file name for the current
2340 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002341 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342 *cpo-g*
2343 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002344 *cpo-H*
2345 H When using "I" on a line with only blanks, insert
2346 before the last blank. Without this flag insert after
2347 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348 *cpo-i*
2349 i When included, interrupting the reading of a file will
2350 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002351 *cpo-I*
2352 I When moving the cursor up or down just after inserting
2353 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 *cpo-j*
2355 j When joining lines, only add two spaces after a '.',
2356 not after '!' or '?'. Also see 'joinspaces'.
2357 *cpo-J*
2358 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002359 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 white space.
2361 *cpo-k*
2362 k Disable the recognition of raw key codes in
2363 mappings, abbreviations, and the "to" part of menu
2364 commands. For example, if <Key> sends ^[OA (where ^[
2365 is <Esc>), the command ":map X ^[OA" results in X
2366 being mapped to:
2367 'k' included: "^[OA" (3 characters)
2368 'k' excluded: "<Key>" (one key code)
2369 Also see the '<' flag below.
2370 *cpo-K*
2371 K Don't wait for a key code to complete when it is
2372 halfway a mapping. This breaks mapping <F1><F1> when
2373 only part of the second <F1> has been read. It
2374 enables cancelling the mapping by typing <F1><Esc>.
2375 *cpo-l*
2376 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002377 literally, only "\]", "\^", "\-" and "\\" are special.
2378 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2380 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002381 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 *cpo-L*
2383 L When the 'list' option is set, 'wrapmargin',
2384 'textwidth', 'softtabstop' and Virtual Replace mode
2385 (see |gR|) count a <Tab> as two characters, instead of
2386 the normal behavior of a <Tab>.
2387 *cpo-m*
2388 m When included, a showmatch will always wait half a
2389 second. When not included, a showmatch will wait half
2390 a second or until a character is typed. |'showmatch'|
2391 *cpo-M*
2392 M When excluded, "%" matching will take backslashes into
2393 account. Thus in "( \( )" and "\( ( \)" the outer
2394 parenthesis match. When included "%" ignores
2395 backslashes, which is Vi compatible.
2396 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002397 n When included, the column used for 'number' and
2398 'relativenumber' will also be used for text of wrapped
2399 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 *cpo-o*
2401 o Line offset to search command is not remembered for
2402 next search.
2403 *cpo-O*
2404 O Don't complain if a file is being overwritten, even
2405 when it didn't exist when editing it. This is a
2406 protection against a file unexpectedly created by
2407 someone else. Vi didn't complain about this.
2408 *cpo-p*
2409 p Vi compatible Lisp indenting. When not present, a
2410 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002411 *cpo-P*
2412 P When included, a ":write" command that appends to a
2413 file will set the file name for the current buffer, if
2414 the current buffer doesn't have a file name yet and
2415 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002416 *cpo-q*
2417 q When joining multiple lines leave the cursor at the
2418 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 *cpo-r*
2420 r Redo ("." command) uses "/" to repeat a search
2421 command, instead of the actually used search string.
2422 *cpo-R*
2423 R Remove marks from filtered lines. Without this flag
2424 marks are kept like |:keepmarks| was used.
2425 *cpo-s*
2426 s Set buffer options when entering the buffer for the
2427 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002428 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 set when the buffer is created.
2430 *cpo-S*
2431 S Set buffer options always when entering a buffer
2432 (except 'readonly', 'fileformat', 'filetype' and
2433 'syntax'). This is the (most) Vi compatible setting.
2434 The options are set to the values in the current
2435 buffer. When you change an option and go to another
2436 buffer, the value is copied. Effectively makes the
2437 buffer options global to all buffers.
2438
2439 's' 'S' copy buffer options
2440 no no when buffer created
2441 yes no when buffer first entered (default)
2442 X yes each time when buffer entered (vi comp.)
2443 *cpo-t*
2444 t Search pattern for the tag command is remembered for
2445 "n" command. Otherwise Vim only puts the pattern in
2446 the history for search pattern, but doesn't change the
2447 last used search pattern.
2448 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002449 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 *cpo-v*
2451 v Backspaced characters remain visible on the screen in
2452 Insert mode. Without this flag the characters are
2453 erased from the screen right away. With this flag the
2454 screen newly typed text overwrites backspaced
2455 characters.
2456 *cpo-w*
2457 w When using "cw" on a blank character, only change one
2458 character and not all blanks until the start of the
2459 next word.
2460 *cpo-W*
2461 W Don't overwrite a readonly file. When omitted, ":w!"
2462 overwrites a readonly file, if possible.
2463 *cpo-x*
2464 x <Esc> on the command-line executes the command-line.
2465 The default in Vim is to abandon the command-line,
2466 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002467 *cpo-X*
2468 X When using a count with "R" the replaced text is
2469 deleted only once. Also when repeating "R" with "."
2470 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002472 y A yank command can be redone with ".". Think twice if
2473 you really want to use this, it may break some
2474 plugins, since most people expect "." to only repeat a
2475 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002476 *cpo-Z*
2477 Z When using "w!" while the 'readonly' option is set,
2478 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 *cpo-!*
2480 ! When redoing a filter command, use the last used
2481 external command, whatever it was. Otherwise the last
2482 used -filter- command is used.
2483 *cpo-$*
2484 $ When making a change to one line, don't redisplay the
2485 line, but put a '$' at the end of the changed text.
2486 The changed text will be overwritten when you type the
2487 new text. The line is redisplayed if you type any
2488 command that moves the cursor from the insertion
2489 point.
2490 *cpo-%*
2491 % Vi-compatible matching is done for the "%" command.
2492 Does not recognize "#if", "#endif", etc.
2493 Does not recognize "/*" and "*/".
2494 Parens inside single and double quotes are also
2495 counted, causing a string that contains a paren to
2496 disturb the matching. For example, in a line like
2497 "if (strcmp("foo(", s))" the first paren does not
2498 match the last one. When this flag is not included,
2499 parens inside single and double quotes are treated
2500 specially. When matching a paren outside of quotes,
2501 everything inside quotes is ignored. When matching a
2502 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002503 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002504 This flag is also used for other features, such as
2505 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002506 *cpo--*
2507 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002508 it would go above the first line or below the last
2509 line. Without it the cursor moves to the first or
2510 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002511 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002512 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002513 *cpo-+*
2514 + When included, a ":write file" command will reset the
2515 'modified' flag of the buffer, even though the buffer
2516 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002517 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518 * Use ":*" in the same way as ":@". When not included,
2519 ":*" is an alias for ":'<,'>", select the Visual area.
2520 *cpo-<*
2521 < Disable the recognition of special key codes in |<>|
2522 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002523 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 ":map X <Tab>" results in X being mapped to:
2525 '<' included: "<Tab>" (5 characters)
2526 '<' excluded: "^I" (^I is a real <Tab>)
2527 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002528 *cpo->*
2529 > When appending to a register, put a line break before
2530 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002531 *cpo-;*
2532 ; When using |,| or |;| to repeat the last |t| search
2533 and the cursor is right in front of the searched
2534 character, the cursor won't move. When not included,
2535 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002536 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002537
2538 POSIX flags. These are not included in the Vi default value, except
2539 when $VIM_POSIX was set on startup. |posix|
2540
2541 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002542 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002543 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002544 *cpo-&*
2545 & When ":preserve" was used keep the swap file when
2546 exiting normally while this buffer is still loaded.
2547 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002548 *cpo-\*
2549 \ Backslash in a [] range in a search pattern is taken
2550 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002551 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2552 '\' excluded: "/[ \-]" finds <Space> and '-'
2553 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002554 *cpo-/*
2555 / When "%" is used as the replacement string in a |:s|
2556 command, use the previous replacement string. |:s%|
2557 *cpo-{*
2558 { The |{| and |}| commands also stop at a "{" character
2559 at the start of a line.
2560 *cpo-.*
2561 . The ":chdir" and ":cd" commands fail if the current
2562 buffer is modified, unless ! is used. Vim doesn't
2563 need this, since it remembers the full path of an
2564 opened file.
2565 *cpo-bar*
2566 | The value of the $LINES and $COLUMNS environment
2567 variables overrule the terminal size values obtained
2568 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002569
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002570 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002571'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002572 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002573 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002574 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002575 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002576 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002577 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002578 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002579 blowfish Blowfish method. Medium strong encryption but it has
2580 an implementation flaw. Requires Vim 7.3 or later,
2581 files can NOT be read by Vim 7.2 and older. This adds
2582 a "seed" to the file, every time you write the file
2583 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002584 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002585 *blowfish2*
2586 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002587 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002588 and older. This adds a "seed" to the file, every time
2589 you write the file the encrypted bytes will be
2590 different. The whole undo file is encrypted, not just
2591 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002592 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002593 *E1197* *E1198* *E1199* *E1200* *E1201*
2594 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2595 Code. Medium strong till strong encryption.
2596 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002597 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002598 It adds a seed and a message authentication code (MAC)
2599 to the file. This needs at least a Vim 8.2.3022 to
2600 read the encrypted file.
2601 Encryption of swap files is not supported, therefore
2602 no swap file will be used when xchacha20 encryption is
2603 enabled.
2604 Encryption of undo files is not yet supported,
2605 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002606 CAREFUL: Files written with this method might have to
2607 be read back with the same version of Vim if the
2608 binary format changes later.
2609 Obsolete, please do no longer use.
2610 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2611 stores the key derivation parameters together with the
2612 encrypted file. Should work better in case the
2613 parameters in the libsodium library ever change.
2614 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002615 might have to be read back with the same version of
2616 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002617
Christian Brabandtaae58342023-04-23 17:50:22 +01002618 You should use "blowfish2", also to re-encrypt older files. The
2619 "xchacha20" method provides better encryption, but it does not work
2620 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002621
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002622 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002623 to the detected method of the file being read. Thus if you write it
2624 without changing 'cryptmethod' the same method will be used.
2625 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002626 explicitly write it, you don't get a warning unless there are other
2627 modifications. Also see |:X|.
2628
2629 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002630 the value "blowfish2". When setting the local value to an empty
2631 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002632
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002633 When a new encryption method is added in a later version of Vim, and
2634 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002635 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002636
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 *'cscopepathcomp'* *'cspc'*
2638'cscopepathcomp' 'cspc' number (default 0)
2639 global
2640 {not available when compiled without the |+cscope|
2641 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 Determines how many components of the path to show in a list of tags.
2643 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002644 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645
2646 *'cscopeprg'* *'csprg'*
2647'cscopeprg' 'csprg' string (default "cscope")
2648 global
2649 {not available when compiled without the |+cscope|
2650 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 Specifies the command to execute cscope. See |cscopeprg|.
2652 This option cannot be set from a |modeline| or in the |sandbox|, for
2653 security reasons.
2654
2655 *'cscopequickfix'* *'csqf'*
2656'cscopequickfix' 'csqf' string (default "")
2657 global
2658 {not available when compiled without the |+cscope|
2659 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 Specifies whether to use quickfix window to show cscope results.
2661 See |cscopequickfix|.
2662
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002663 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002664'cscoperelative' 'csre' boolean (default off)
2665 global
2666 {not available when compiled without the |+cscope|
2667 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002668 In the absence of a prefix (-P) for cscope. setting this option enables
2669 to use the basename of cscope.out path as the prefix.
2670 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002671 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002672
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2674'cscopetag' 'cst' boolean (default off)
2675 global
2676 {not available when compiled without the |+cscope|
2677 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 Use cscope for tag commands. See |cscope-options|.
2679 NOTE: This option is reset when 'compatible' is set.
2680
2681 *'cscopetagorder'* *'csto'*
2682'cscopetagorder' 'csto' number (default 0)
2683 global
2684 {not available when compiled without the |+cscope|
2685 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 Determines the order in which ":cstag" performs a search. See
2687 |cscopetagorder|.
2688 NOTE: This option is set to 0 when 'compatible' is set.
2689
2690 *'cscopeverbose'* *'csverb'*
2691 *'nocscopeverbose'* *'nocsverb'*
2692'cscopeverbose' 'csverb' boolean (default off)
2693 global
2694 {not available when compiled without the |+cscope|
2695 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 Give messages when adding a cscope database. See |cscopeverbose|.
2697 NOTE: This option is reset when 'compatible' is set.
2698
Bram Moolenaar860cae12010-06-05 23:22:07 +02002699 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2700'cursorbind' 'crb' boolean (default off)
2701 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002702 When this option is set, as the cursor in the current
2703 window moves other cursorbound windows (windows that also have
2704 this option set) move their cursors to the corresponding line and
2705 column. This option is useful for viewing the
2706 differences between two versions of a file (see 'diff'); in diff mode,
2707 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002708 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002709
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002710 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2711'cursorcolumn' 'cuc' boolean (default off)
2712 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002713 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002714 feature}
2715 Highlight the screen column of the cursor with CursorColumn
2716 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2717 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002718 If you only want the highlighting in the current window you can use
2719 these autocommands: >
2720 au WinLeave * set nocursorline nocursorcolumn
2721 au WinEnter * set cursorline cursorcolumn
2722<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002723
2724 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2725'cursorline' 'cul' boolean (default off)
2726 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002727 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002728 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002729 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2730 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002731 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002732 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002733
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002734 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002735'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002736 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002737 {not available when compiled without the |+syntax|
2738 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002739 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002740 Valid values:
2741 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002742 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002743 "screenline" Highlight only the screen line of the cursor with
2744 CursorLine |hl-CursorLine|.
2745 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002746 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002747
2748 Special value:
2749 "both" Alias for the values "line,number".
2750
2751 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002752
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 *'debug'*
2754'debug' string (default "")
2755 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002756 These values can be used:
2757 msg Error messages that would otherwise be omitted will be given
2758 anyway.
2759 throw Error messages that would otherwise be omitted will be given
2760 anyway and also throw an exception and set |v:errmsg|.
2761 beep A message will be given when otherwise only a beep would be
2762 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002763 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002764 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2765 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766
2767 *'define'* *'def'*
2768'define' 'def' string (default "^\s*#\s*define")
2769 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002770 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 pattern, just like for the "/" command. This option is used for the
2772 commands like "[i" and "[d" |include-search|. The 'isident' option is
2773 used to recognize the defined name after the match:
2774 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2775 See |option-backslash| about inserting backslashes to include a space
2776 or backslash.
2777 The default value is for C programs. For C++ this value would be
2778 useful, to include const type declarations: >
2779 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002780< You can also use "\ze" just before the name and continue the pattern
2781 to check what is following. E.g. for Javascript, if a function is
2782 defined with "func_name = function(args)": >
2783 ^\s*\ze\i\+\s*=\s*function(
2784< If the function is defined with "func_name : function() {...": >
2785 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002787 To avoid that use `:let` with a single quote string: >
2788 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002789<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790
2791 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2792'delcombine' 'deco' boolean (default off)
2793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 If editing Unicode and this option is set, backspace and Normal mode
2795 "x" delete each combining character on its own. When it is off (the
2796 default) the character along with its combining characters are
2797 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002798 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799
2800 This is useful for Arabic, Hebrew and many other languages where one
2801 may have combining characters overtop of base characters, and want
2802 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002803 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804
2805 *'dictionary'* *'dict'*
2806'dictionary' 'dict' string (default "")
2807 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 List of file names, separated by commas, that are used to lookup words
2809 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2810 contain a list of words. This can be one word per line, or several
2811 words per line, separated by non-keyword characters (white space is
2812 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002813
2814 When this option is empty or an entry "spell" is present, and spell
2815 checking is enabled, words in the word lists for the currently active
2816 'spelllang' are used. See |spell|.
2817
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002818 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 after a comma are ignored, otherwise spaces are included in the file
2820 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002821 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 Where to find a list of words?
2823 - On FreeBSD, there is the file "/usr/share/dict/words".
2824 - In the Simtel archive, look in the "msdos/linguist" directory.
2825 - In "miscfiles" of the GNU collection.
2826 The use of |:set+=| and |:set-=| is preferred when adding or removing
2827 directories from the list. This avoids problems when a future version
2828 uses another default.
2829 Backticks cannot be used in this option for security reasons.
2830
2831 *'diff'* *'nodiff'*
2832'diff' boolean (default off)
2833 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 {not available when compiled without the |+diff|
2835 feature}
2836 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002837 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838
2839 *'dex'* *'diffexpr'*
2840'diffexpr' 'dex' string (default "")
2841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 {not available when compiled without the |+diff|
2843 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002844 Expression which is evaluated to obtain a diff file (either ed-style
2845 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 This option cannot be set from a |modeline| or in the |sandbox|, for
2847 security reasons.
2848
2849 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002850'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 {not available when compiled without the |+diff|
2853 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002854 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 All are optional. Items must be separated by a comma.
2856
2857 filler Show filler lines, to keep the text
2858 synchronized with a window that has inserted
2859 lines at the same position. Mostly useful
2860 when windows are side-by-side and 'scrollbind'
2861 is set.
2862
2863 context:{n} Use a context of {n} lines between a change
2864 and a fold that contains unchanged lines.
2865 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002866 When using zero the context is actually one,
2867 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002868 for a deleted line. Set it to a very large
2869 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 See |fold-diff|.
2871
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002872 iblank Ignore changes where lines are all blank. Adds
2873 the "-B" flag to the "diff" command if
2874 'diffexpr' is empty. Check the documentation
2875 of the "diff" command for what this does
2876 exactly.
2877 NOTE: the diff windows will get out of sync,
2878 because no differences between blank lines are
2879 taken into account.
2880
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 icase Ignore changes in case of text. "a" and "A"
2882 are considered the same. Adds the "-i" flag
2883 to the "diff" command if 'diffexpr' is empty.
2884
2885 iwhite Ignore changes in amount of white space. Adds
2886 the "-b" flag to the "diff" command if
2887 'diffexpr' is empty. Check the documentation
2888 of the "diff" command for what this does
2889 exactly. It should ignore adding trailing
2890 white space, but not leading white space.
2891
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002892 iwhiteall Ignore all white space changes. Adds
2893 the "-w" flag to the "diff" command if
2894 'diffexpr' is empty. Check the documentation
2895 of the "diff" command for what this does
2896 exactly.
2897
2898 iwhiteeol Ignore white space changes at end of line.
2899 Adds the "-Z" 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
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002904 horizontal Start diff mode with horizontal splits (unless
2905 explicitly specified otherwise).
2906
2907 vertical Start diff mode with vertical splits (unless
2908 explicitly specified otherwise).
2909
Bram Moolenaarc8234772019-11-10 21:00:27 +01002910 closeoff When a window is closed where 'diff' is set
2911 and there is only one window remaining in the
2912 same tab page with 'diff' set, execute
2913 `:diffoff` in that window. This undoes a
2914 `:diffsplit` command.
2915
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002916 hiddenoff Do not use diff mode for a buffer when it
2917 becomes hidden.
2918
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002919 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2920 starting diff mode. Without this 2 is used.
2921
Bram Moolenaar4223d432021-02-10 13:18:17 +01002922 followwrap Follow the 'wrap' option and leave as it is.
2923
Bram Moolenaare828b762018-09-10 17:51:58 +02002924 internal Use the internal diff library. This is
2925 ignored when 'diffexpr' is set. *E960*
2926 When running out of memory when writing a
2927 buffer this item will be ignored for diffs
2928 involving that buffer. Set the 'verbose'
2929 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930
Bram Moolenaare828b762018-09-10 17:51:58 +02002931 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002932 Use the indent heuristic for the internal
2933 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002934
zeertzjqd086b8f2024-02-25 15:42:52 +08002935 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002936 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002937 algorithms are:
2938 myers the default algorithm
2939 minimal spend extra time to generate the
2940 smallest possible diff
2941 patience patience diff algorithm
2942 histogram histogram diff algorithm
2943
2944 Examples: >
2945 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002947 :set diffopt=internal,filler,foldcolumn:3
2948 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949<
2950 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2951'digraph' 'dg' boolean (default off)
2952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 {not available when compiled without the |+digraphs|
2954 feature}
2955 Enable the entering of digraphs in Insert mode with {char1} <BS>
2956 {char2}. See |digraphs|.
2957 NOTE: This option is reset when 'compatible' is set.
2958
2959 *'directory'* *'dir'*
2960'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002961 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 for Unix: ".,~/tmp,/var/tmp,/tmp")
2963 global
2964 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002965 Recommended value: ".,~/vimswap//" - this will put the swap file next
2966 to the edited file if possible, and in your personal swap directory
2967 otherwise. Make sure "~/vimswap//" is only readable for you.
2968
2969 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 - The swap file will be created in the first directory where this is
2971 possible.
2972 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002973 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 - A directory "." means to put the swap file in the same directory as
2975 the edited file. On Unix, a dot is prepended to the file name, so
2976 it doesn't show in a directory listing. On MS-Windows the "hidden"
2977 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002978 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2979 the swap file relative to where the edited file is. The leading "."
2980 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002981 - For Unix and Win32, if a directory ends in two path separators "//",
2982 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002983 with all path separators replaced by percent '%' signs (including
2984 the colon following the drive letter on Win32). This will ensure
2985 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002986 On Win32, it is also possible to end with "\\". However, When a
2987 separating comma is following, you must use "//", since "\\" will
2988 include the comma in the file name. Therefore it is recommended to
2989 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 - Spaces after the comma are ignored, other spaces are considered part
2991 of the directory name. To have a space at the start of a directory
2992 name, precede it with a backslash.
2993 - To include a comma in a directory name precede it with a backslash.
2994 - A directory name may end in an ':' or '/'.
2995 - Environment variables are expanded |:set_env|.
2996 - Careful with '\' characters, type one before a space, type two to
2997 get one in the option (see |option-backslash|), for example: >
2998 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2999< - For backwards compatibility with Vim version 3.0 a '>' at the start
3000 of the option is removed.
3001 Using "." first in the list is recommended. This means that editing
3002 the same file twice will result in a warning. Using "/tmp" on Unix is
3003 discouraged: When the system crashes you lose the swap file.
3004 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003005 choice than "/tmp". But others on the computer may be able to see the
3006 files, and it can contain a lot of files, your swap files get lost in
3007 the crowd. That is why a "tmp" directory in your home directory is
3008 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 The use of |:set+=| and |:set-=| is preferred when adding or removing
3010 directories from the list. This avoids problems when a future version
3011 uses another default.
3012 This option cannot be set from a |modeline| or in the |sandbox|, for
3013 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014
3015 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003016'display' 'dy' string (default "", set to "truncate" in
3017 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003019 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 flags:
3021 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003022 in a window will be displayed. "@@@" is put in the
3023 last columns of the last screen line to indicate the
3024 rest of the line is not displayed.
3025 truncate Like "lastline", but "@@@" is displayed in the first
3026 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 uhex Show unprintable characters hexadecimal as <xx>
3028 instead of using ^C and ~C.
3029
Bram Moolenaard0796902016-09-16 20:02:31 +02003030 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003031 doesn't fit is replaced with "@" lines.
3032
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003033 The "@" character can be changed by setting the "lastline" item in
3034 'fillchars'. The character is highlighted with |hl-NonText|.
3035
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 *'eadirection'* *'ead'*
3037'eadirection' 'ead' string (default "both")
3038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 Tells when the 'equalalways' option applies:
3040 ver vertically, width of windows is not affected
3041 hor horizontally, height of windows is not affected
3042 both width and height of windows is affected
3043
3044 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3045'edcompatible' 'ed' boolean (default off)
3046 global
3047 Makes the 'g' and 'c' flags of the ":substitute" command to be
3048 toggled each time the flag is given. See |complex-change|. See
3049 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003050 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003051 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052
Bram Moolenaar03413f42016-04-12 21:07:15 +02003053 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003054'emoji' 'emo' boolean (default: on)
3055 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003056 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003057 This excludes "text emoji" characters, which are normally displayed as
3058 single width. Unfortunately there is no good specification for this
3059 and it has been determined on trial-and-error basis. Use the
3060 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003061
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003063'encoding' 'enc' string (default for MS-Windows: "utf-8",
3064 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 Sets the character encoding used inside Vim. It applies to text in
3067 the buffers, registers, Strings in expressions, text stored in the
3068 viminfo file, etc. It sets the kind of characters which Vim can work
3069 with. See |encoding-names| for the possible values.
3070
3071 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003072 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003074 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075
Bram Moolenaar865242e2010-07-14 21:12:05 +02003076 This option cannot be set from a |modeline|. It would most likely
3077 corrupt the text.
3078
Bram Moolenaar3df01732017-02-17 22:47:16 +01003079 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3080 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 'encoding', "utf-8" is the natural choice for the environment and
3082 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003083 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 versions, and to avoid changing the encoding of newly created files
3085 without your knowledge (in case 'fileencodings' is empty).
3086
3087 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003088 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 iconv() or as specified with 'charconvert'.
3090
Bram Moolenaar207f0092020-08-30 17:20:20 +02003091 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003092 can use: >
3093 if has("multi_byte_encoding")
3094<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 Normally 'encoding' will be equal to your current locale. This will
3096 be the default if Vim recognizes your environment settings. If
3097 'encoding' is not set to the current locale, 'termencoding' must be
3098 set to convert typed and displayed text. See |encoding-table|.
3099
3100 When you set this option, it fires the |EncodingChanged| autocommand
3101 event so that you can set up fonts if necessary.
3102
3103 When the option is set, the value is converted to lowercase. Thus
3104 you can set it with uppercase values too. Underscores are translated
3105 to '-' signs.
3106 When the encoding is recognized, it is changed to the standard name.
3107 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3108 "iso-8859-2" and "utf8" becomes "utf-8".
3109
3110 Note: "latin1" is also used when the encoding could not be detected.
3111 This only works when editing files in the same encoding! When the
3112 actual character set is not latin1, make sure 'fileencoding' and
3113 'fileencodings' are empty. When conversion is needed, switch to using
3114 utf-8.
3115
3116 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3117 You don't notice this while editing, but it does matter for the
3118 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3119 setting 'encoding' to one of these values instead of utf-8 only has
3120 effect for encoding used for files when 'fileencoding' is empty.
3121
Bram Moolenaar661b1822005-07-28 22:36:45 +00003122 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3123 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003125 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003126'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003128 Indicates that a CTRL-Z character was found at the end of the file
3129 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003131 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003132 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003133 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003134
3135 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3136'endofline' 'eol' boolean (default on)
3137 local to buffer
3138 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003139 is on, or 'fixeol' option is off, no <EOL> will be written for the
3140 last line in the file. This option is automatically set or reset when
3141 starting to edit a new file, depending on whether file has an <EOL>
3142 for the last line in the file. Normally you don't have to set or
3143 reset this option.
3144 When 'binary' is off and 'fixeol' is on the value is not used when
3145 writing the file. When 'binary' is on or 'fixeol' is off it is used
3146 to remember the presence of a <EOL> for the last line in the file, so
3147 that when you write the file the situation from the original file can
3148 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003149 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150
3151 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3152'equalalways' 'ea' boolean (default on)
3153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003155 splitting or closing a window. This also happens the moment the
3156 option is switched on. When off, splitting a window will reduce the
3157 size of the current window and leave the other windows the same. When
3158 closing a window the extra lines are given to the window next to it
3159 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 When mixing vertically and horizontally split windows, a minimal size
3161 is computed and some windows may be larger if there is room. The
3162 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003163 Changing the height and width of a window can be avoided by setting
3164 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003165 If a window size is specified when creating a new window sizes are
3166 currently not equalized (it's complicated, but may be implemented in
3167 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168
3169 *'equalprg'* *'ep'*
3170'equalprg' 'ep' string (default "")
3171 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003173 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003174 or 'indentexpr'. When Vim was compiled without internal formatting,
3175 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003176 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 about including spaces and backslashes.
3178 This option cannot be set from a |modeline| or in the |sandbox|, for
3179 security reasons.
3180
3181 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3182'errorbells' 'eb' boolean (default off)
3183 global
3184 Ring the bell (beep or screen flash) for error messages. This only
3185 makes a difference for error messages, the bell will be used always
3186 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003187 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003188 screen flash or do nothing. See 'belloff' to finetune when to ring the
3189 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190
3191 *'errorfile'* *'ef'*
3192'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3193 others: "errors.err")
3194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 {not available when compiled without the |+quickfix|
3196 feature}
3197 Name of the errorfile for the QuickFix mode (see |:cf|).
3198 When the "-q" command-line argument is used, 'errorfile' is set to the
3199 following argument. See |-q|.
3200 NOT used for the ":make" command. See 'makeef' for that.
3201 Environment variables are expanded |:set_env|.
3202 See |option-backslash| about including spaces and backslashes.
3203 This option cannot be set from a |modeline| or in the |sandbox|, for
3204 security reasons.
3205
3206 *'errorformat'* *'efm'*
3207'errorformat' 'efm' string (default is very long)
3208 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 {not available when compiled without the |+quickfix|
3210 feature}
3211 Scanf-like description of the format for the lines in the error file
3212 (see |errorformat|).
3213
3214 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3215'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 Function keys that start with an <Esc> are recognized in Insert
3218 mode. When this option is off, the cursor and function keys cannot be
3219 used in Insert mode if they start with an <Esc>. The advantage of
3220 this is that the single <Esc> is recognized immediately, instead of
3221 after one second. Instead of resetting this option, you might want to
3222 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3223 when 'esckeys' is off, you can still map anything, but the cursor keys
3224 won't work by default.
3225 NOTE: This option is set to the Vi default value when 'compatible' is
3226 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003227 NOTE: when this option is off then the |modifyOtherKeys| and
3228 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3229 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230
3231 *'eventignore'* *'ei'*
3232'eventignore' 'ei' string (default "")
3233 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003235 When set to "all" or when "all" is one of the items, all autocommand
3236 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003237 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 :set ei=WinEnter,WinLeave
3239<
3240 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3241'expandtab' 'et' boolean (default off)
3242 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003244 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3246 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003247 This option is reset when the 'paste' option is set and restored when
3248 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 NOTE: This option is reset when 'compatible' is set.
3250
3251 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3252'exrc' 'ex' boolean (default off)
3253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003255 directory.
3256
3257 Setting this option is a potential security leak. E.g., consider
3258 unpacking a package or fetching files from github, a .vimrc in there
3259 might be a trojan horse. BETTER NOT SET THIS OPTION!
3260 Instead, define an autocommand in your .vimrc to set options for a
3261 matching directory.
3262
3263 If you do switch this option on you should also consider setting the
3264 'secure' option (see |initialization|).
3265 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 This option cannot be set from a |modeline| or in the |sandbox|, for
3267 security reasons.
3268
3269 *'fileencoding'* *'fenc'* *E213*
3270'fileencoding' 'fenc' string (default: "")
3271 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003273
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003275 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 When 'fileencoding' is empty, the same value as 'encoding' will be
3277 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003278 No error will be given when the value is set, only when it is used,
3279 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003280 Conversion will also be done when 'encoding' and 'fileencoding' are
3281 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3282 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003284 'encoding' is "utf-8" or another Unicode encoding, conversion
3285 is most likely done in a way that the reverse conversion
3286 results in the same text. When 'encoding' is not "utf-8" some
3287 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003288
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 See 'encoding' for the possible values. Additionally, values may be
3290 specified that can be handled by the converter, see
3291 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003292
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 When reading a file 'fileencoding' will be set from 'fileencodings'.
3294 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003295 'fileencoding', use the |++enc| argument. One exception: when
3296 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003297 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003298
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3300 When the option is set, the value is converted to lowercase. Thus
3301 you can set it with uppercase values too. '_' characters are
3302 replaced with '-'. If a name is recognized from the list for
3303 'encoding', it is replaced by the standard name. For example
3304 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003305
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 When this option is set, after starting to edit a file, the 'modified'
3307 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003308
3309 Keep in mind that changing 'fenc' from a modeline happens
3310 AFTER the text has been read, thus it applies to when the file will be
3311 written. If you do set 'fenc' in a modeline, you might want to set
3312 'nomodified' to avoid not being able to ":q".
3313
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 This option can not be changed when 'modifiable' is off.
3315
3316 *'fe'*
3317 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003318 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 old short name was 'fe', which is no longer used.
3320
3321 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003322'fileencodings' 'fencs' string (default: "ucs-bom",
3323 "ucs-bom,utf-8,default,latin1" when
3324 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 This is a list of character encodings considered when starting to edit
3327 an existing file. When a file is read, Vim tries to use the first
3328 mentioned character encoding. If an error is detected, the next one
3329 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003330 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 an empty string, which means the value of 'encoding' is used.
3332 WARNING: Conversion can cause loss of information! When
3333 'encoding' is "utf-8" (or one of the other Unicode variants)
3334 conversion is most likely done in a way that the reverse
3335 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003336 "utf-8" some non-ASCII characters may be lost! You can use
3337 the |++bad| argument to specify what is done with characters
3338 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 For an empty file or a file with only ASCII characters most encodings
3340 will work and the first entry of 'fileencodings' will be used (except
3341 "ucs-bom", which requires the BOM to be present). If you prefer
3342 another encoding use an BufReadPost autocommand event to test if your
3343 preferred encoding is to be used. Example: >
3344 au BufReadPost * if search('\S', 'w') == 0 |
3345 \ set fenc=iso-2022-jp | endif
3346< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3347 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003348 When the |++enc| argument is used then the value of 'fileencodings' is
3349 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003350 Note that 'fileencodings' is not used for a new file, the global value
3351 of 'fileencoding' is used instead. You can set it with: >
3352 :setglobal fenc=iso-8859-2
3353< This means that a non-existing file may get a different encoding than
3354 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 The special value "ucs-bom" can be used to check for a Unicode BOM
3356 (Byte Order Mark) at the start of the file. It must not be preceded
3357 by "utf-8" or another Unicode encoding for this to work properly.
3358 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3359 because Vim cannot detect an error, thus the encoding is always
3360 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003361 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003362 environment. On MS-Windows this is the system encoding. Otherwise
3363 this is the default value for 'encoding'. It is useful when
3364 'encoding' is set to "utf-8" and your environment uses a non-latin1
3365 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003366 When 'encoding' is "utf-8" and a file contains an illegal byte
3367 sequence it won't be recognized as UTF-8. You can use the |8g8|
3368 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 WRONG VALUES: WHAT'S WRONG:
3370 latin1,utf-8 "latin1" will always be used
3371 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3372 file
3373 cp1250,latin1 "cp1250" will always be used
3374 If 'fileencodings' is empty, 'fileencoding' is not modified.
3375 See 'fileencoding' for the possible values.
3376 Setting this option does not have an effect until the next time a file
3377 is read.
3378
3379 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003380'fileformat' 'ff' string (MS-Windows default: "dos",
3381 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 This gives the <EOL> of the current buffer, which is used for
3384 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003385 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 unix <NL>
3387 mac <CR>
3388 When "dos" is used, CTRL-Z at the end of a file is ignored.
3389 See |file-formats| and |file-read|.
3390 For the character encoding of the file see 'fileencoding'.
3391 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003392 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 This option is set automatically when starting to edit a file and
3394 'fileformats' is not empty and 'binary' is off.
3395 When this option is set, after starting to edit a file, the 'modified'
3396 option is set, because the file would be different when written.
3397 This option can not be changed when 'modifiable' is off.
3398 For backwards compatibility: When this option is set to "dos",
3399 'textmode' is set, otherwise 'textmode' is reset.
3400
3401 *'fileformats'* *'ffs'*
3402'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003403 Vim+Vi MS-Windows: "dos,unix",
3404 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 Vi Cygwin: "unix,dos",
3406 Vi others: "")
3407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 This gives the end-of-line (<EOL>) formats that will be tried when
3409 starting to edit a new buffer and when reading a file into an existing
3410 buffer:
3411 - When empty, the format defined with 'fileformat' will be used
3412 always. It is not set automatically.
3413 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003414 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 'fileformats' name will be used when a file is read into an existing
3416 buffer, no matter what 'fileformat' for that buffer is set to.
3417 - When more than one name is present, separated by commas, automatic
3418 <EOL> detection will be done when reading a file. When starting to
3419 edit a file, a check is done for the <EOL>:
3420 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3421 'fileformat' is set to "dos".
3422 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003423 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003425 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3426 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003427 This means that "mac" is only chosen when:
3428 "unix" is not present or no <NL> is found in the file, and
3429 "dos" is not present or no <CR><NL> is found in the file.
3430 Except: if "unix" was chosen, but there is a <CR> before
3431 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003432 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 4. If 'fileformat' is still not set, the first name from
3434 'fileformats' is used.
3435 When reading a file into an existing buffer, the same is done, but
3436 this happens like 'fileformat' has been set appropriately for that
3437 file only, the option is not changed.
3438 When 'binary' is set, the value of 'fileformats' is not used.
3439
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003440 When Vim starts up with an empty buffer the first item is used. You
3441 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003442
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3444 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3445 done:
3446 - When 'fileformats' is empty, there is no automatic detection. Dos
3447 format will be used.
3448 - When 'fileformats' is set to one or more names, automatic detection
3449 is done. This is based on the first <NL> in the file: If there is a
3450 <CR> in front of it, Dos format is used, otherwise Unix format is
3451 used.
3452 Also see |file-formats|.
3453 For backwards compatibility: When this option is set to an empty
3454 string or one format (no comma is included), 'textauto' is reset,
3455 otherwise 'textauto' is set.
3456 NOTE: This option is set to the Vi default value when 'compatible' is
3457 set and to the Vim default value when 'compatible' is reset.
3458
Bram Moolenaarbf884932013-04-05 22:26:15 +02003459 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3460'fileignorecase' 'fic' boolean (default on for systems where case in file
3461 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003462 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003463 When set case is ignored when using file names and directories.
3464 See 'wildignorecase' for only ignoring case when doing completion.
3465
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 *'filetype'* *'ft'*
3467'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003468 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 When this option is set, the FileType autocommand event is triggered.
3470 All autocommands that match with the value of this option will be
3471 executed. Thus the value of 'filetype' is used in place of the file
3472 name.
3473 Otherwise this option does not always reflect the current file type.
3474 This option is normally set when the file type is detected. To enable
3475 this use the ":filetype on" command. |:filetype|
3476 Setting this option to a different value is most useful in a modeline,
3477 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003478 Example, for in an IDL file:
3479 /* vim: set filetype=idl : */ ~
3480 |FileType| |filetypes|
3481 When a dot appears in the value then this separates two filetype
3482 names. Example:
3483 /* vim: set filetype=c.doxygen : */ ~
3484 This will use the "c" filetype first, then the "doxygen" filetype.
3485 This works both for filetype plugins and for syntax files. More than
3486 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 This option is not copied to another buffer, independent of the 's' or
3488 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003489 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490
3491 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003492'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003493 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003494 Characters to fill the statuslines, vertical separators and special
3495 lines in the window.
3496 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003497 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003499 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003500 stl ' ' statusline of the current window
3501 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003502 vert '|' vertical separators |:vsplit|
3503 fold '-' filling 'foldtext'
3504 foldopen '-' mark the beginning of a fold
3505 foldclose '+' show a closed fold
3506 foldsep '|' open fold middle character
3507 diff '-' deleted lines of the 'diff' option
3508 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003509 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003511 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512
3513 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003514 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3515<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003516 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3517 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003518 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003519
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003521 item name highlight group ~
3522 stl StatusLine |hl-StatusLine|
3523 stlnc StatusLineNC |hl-StatusLineNC|
3524 vert VertSplit |hl-VertSplit|
3525 fold Folded |hl-Folded|
3526 diff DiffDelete |hl-DiffDelete|
3527 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003528 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003530 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3531'fixendofline' 'fixeol' boolean (default on)
3532 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003533 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003534 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003535 preserve the situation from the original file.
3536 When the 'binary' option is set the value of this option doesn't
3537 matter.
3538 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003539 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003540
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003542'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 {only available when compiled with the |+rightleft|
3545 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003546 This option was for using Farsi, which has been removed. See
3547 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548
3549 *'foldclose'* *'fcl'*
3550'foldclose' 'fcl' string (default "")
3551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 {not available when compiled without the |+folding|
3553 feature}
3554 When set to "all", a fold is closed when the cursor isn't in it and
3555 its level is higher than 'foldlevel'. Useful if you want folds to
3556 automatically close when moving out of them.
3557
3558 *'foldcolumn'* *'fdc'*
3559'foldcolumn' 'fdc' number (default 0)
3560 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 {not available when compiled without the |+folding|
3562 feature}
3563 When non-zero, a column with the specified width is shown at the side
3564 of the window which indicates open and closed folds. The maximum
3565 value is 12.
3566 See |folding|.
3567
3568 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3569'foldenable' 'fen' boolean (default on)
3570 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 {not available when compiled without the |+folding|
3572 feature}
3573 When off, all folds are open. This option can be used to quickly
3574 switch between showing all text unfolded and viewing the text with
3575 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003576 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 'foldenable' is off.
3578 This option is set by commands that create a new fold or close a fold.
3579 See |folding|.
3580
3581 *'foldexpr'* *'fde'*
3582'foldexpr' 'fde' string (default: "0")
3583 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003585 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003587 for each line to obtain its fold level. The context is set to the
3588 script where 'foldexpr' was set, script-local items can be accessed.
3589 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003590
Bram Moolenaar30b65812012-07-12 22:01:11 +02003591 The expression will be evaluated in the |sandbox| if set from a
3592 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003593 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003594 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003595
3596 It is not allowed to change text or jump to another window while
3597 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598
3599 *'foldignore'* *'fdi'*
3600'foldignore' 'fdi' string (default: "#")
3601 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 {not available when compiled without the |+folding|
3603 feature}
3604 Used only when 'foldmethod' is "indent". Lines starting with
3605 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003606 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 The default "#" works well for C programs. See |fold-indent|.
3608
3609 *'foldlevel'* *'fdl'*
3610'foldlevel' 'fdl' number (default: 0)
3611 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 {not available when compiled without the |+folding|
3613 feature}
3614 Sets the fold level: Folds with a higher level will be closed.
3615 Setting this option to zero will close all folds. Higher numbers will
3616 close fewer folds.
3617 This option is set by commands like |zm|, |zM| and |zR|.
3618 See |fold-foldlevel|.
3619
3620 *'foldlevelstart'* *'fdls'*
3621'foldlevelstart' 'fdls' number (default: -1)
3622 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 {not available when compiled without the |+folding|
3624 feature}
3625 Sets 'foldlevel' when starting to edit another buffer in a window.
3626 Useful to always start editing with all folds closed (value zero),
3627 some folds closed (one) or no folds closed (99).
3628 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003629 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 ignores this option and closes all folds.
3631 It is also done before BufReadPre autocommands, to allow an autocmd to
3632 overrule the 'foldlevel' value for specific files.
3633 When the value is negative, it is not used.
3634
3635 *'foldmarker'* *'fmr'* *E536*
3636'foldmarker' 'fmr' string (default: "{{{,}}}")
3637 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 {not available when compiled without the |+folding|
3639 feature}
3640 The start and end marker used when 'foldmethod' is "marker". There
3641 must be one comma, which separates the start and end marker. The
3642 marker is a literal string (a regular expression would be too slow).
3643 See |fold-marker|.
3644
3645 *'foldmethod'* *'fdm'*
3646'foldmethod' 'fdm' string (default: "manual")
3647 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 {not available when compiled without the |+folding|
3649 feature}
3650 The kind of folding used for the current window. Possible values:
3651 |fold-manual| manual Folds are created manually.
3652 |fold-indent| indent Lines with equal indent form a fold.
3653 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3654 |fold-marker| marker Markers are used to specify folds.
3655 |fold-syntax| syntax Syntax highlighting items specify folds.
3656 |fold-diff| diff Fold text that is not changed.
3657
3658 *'foldminlines'* *'fml'*
3659'foldminlines' 'fml' number (default: 1)
3660 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 {not available when compiled without the |+folding|
3662 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003663 Sets the number of screen lines above which a fold can be displayed
3664 closed. Also for manually closed folds. With the default value of
3665 one a fold can only be closed if it takes up two or more screen lines.
3666 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003667 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 "zc" to close a fold, which is displayed open because it's smaller
3669 than 'foldminlines', a following "zc" may close a containing fold.
3670
3671 *'foldnestmax'* *'fdn'*
3672'foldnestmax' 'fdn' number (default: 20)
3673 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 {not available when compiled without the |+folding|
3675 feature}
3676 Sets the maximum nesting of folds for the "indent" and "syntax"
3677 methods. This avoids that too many folds will be created. Using more
3678 than 20 doesn't work, because the internal limit is 20.
3679
3680 *'foldopen'* *'fdo'*
3681'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3682 search,tag,undo")
3683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 {not available when compiled without the |+folding|
3685 feature}
3686 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003687 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003689 NOTE: When the command is part of a mapping this option is not used.
3690 Add the |zv| command to the mapping to get the same effect.
3691 (rationale: the mapping may want to control opening folds itself)
3692
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 item commands ~
3694 all any
3695 block "(", "{", "[[", "[{", etc.
3696 hor horizontal movements: "l", "w", "fx", etc.
3697 insert any command in Insert mode
3698 jump far jumps: "G", "gg", etc.
3699 mark jumping to a mark: "'m", CTRL-O, etc.
3700 percent "%"
3701 quickfix ":cn", ":crew", ":make", etc.
3702 search search for a pattern: "/", "n", "*", "gd", etc.
3703 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003704 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 tag jumping to a tag: ":ta", CTRL-T, etc.
3706 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 When a movement command is used for an operator (e.g., "dl" or "y%")
3708 this option is not used. This means the operator will include the
3709 whole closed fold.
3710 Note that vertical movements are not here, because it would make it
3711 very difficult to move onto a closed fold.
3712 In insert mode the folds containing the cursor will always be open
3713 when text is inserted.
3714 To close folds you can re-apply 'foldlevel' with the |zx| command or
3715 set the 'foldclose' option to "all".
3716
3717 *'foldtext'* *'fdt'*
3718'foldtext' 'fdt' string (default: "foldtext()")
3719 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 {not available when compiled without the |+folding|
3721 feature}
3722 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003723 fold. The context is set to the script where 'foldexpr' was set,
3724 script-local items can be accessed. See |fold-foldtext| for the
3725 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726
Bram Moolenaar30b65812012-07-12 22:01:11 +02003727 The expression will be evaluated in the |sandbox| if set from a
3728 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003729 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003730
3731 It is not allowed to change text or jump to another window while
3732 evaluating 'foldtext' |textlock|.
3733
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003734 *'formatexpr'* *'fex'*
3735'formatexpr' 'fex' string (default "")
3736 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003737 {not available when compiled without the |+eval|
3738 feature}
3739 Expression which is evaluated to format a range of lines for the |gq|
3740 operator or automatic formatting (see 'formatoptions'). When this
3741 option is empty 'formatprg' is used.
3742
3743 The |v:lnum| variable holds the first line to be formatted.
3744 The |v:count| variable holds the number of lines to be formatted.
3745 The |v:char| variable holds the character that is going to be
3746 inserted if the expression is being evaluated due to
3747 automatic formatting. This can be empty. Don't insert
3748 it yet!
3749
3750 Example: >
3751 :set formatexpr=mylang#Format()
3752< This will invoke the mylang#Format() function in the
3753 autoload/mylang.vim file in 'runtimepath'. |autoload|
3754
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003755 The advantage of using a function call without arguments is that it is
3756 faster, see |expr-option-function|.
3757
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003758 The expression is also evaluated when 'textwidth' is set and adding
3759 text beyond that limit. This happens under the same conditions as
3760 when internal formatting is used. Make sure the cursor is kept in the
3761 same spot relative to the text then! The |mode()| function will
3762 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003763
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003764 When the expression evaluates to non-zero Vim will fall back to using
3765 the internal format mechanism.
3766
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003767 If the expression starts with s: or |<SID>|, then it is replaced with
3768 the script ID (|local-function|). Example: >
3769 set formatexpr=s:MyFormatExpr()
3770 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003771< Otherwise, the expression is evaluated in the context of the script
3772 where the option was set, thus script-local items are available.
3773
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003774 The expression will be evaluated in the |sandbox| when set from a
3775 modeline, see |sandbox-option|. That stops the option from working,
3776 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003777 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003778 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003779
Bram Moolenaar86b68352004-12-27 21:59:20 +00003780 *'formatlistpat'* *'flp'*
3781'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3782 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003783 A pattern that is used to recognize a list header. This is used for
3784 the "n" flag in 'formatoptions'.
3785 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003786 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003787 while still checking more characters. There must be a character
3788 following the pattern, when it matches the whole line it is handled
3789 like there is no match.
3790 The default recognizes a number, followed by an optional punctuation
3791 character and white space.
3792
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003793 *'formatoptions'* *'fo'*
3794'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3795 local to buffer
3796 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003797 formatting is to be done.
3798 See |fo-table| for possible values and |gq| for how to format text.
3799 When the 'paste' option is on, no formatting is done (like
3800 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003801 To avoid problems with flags that are added in the future, use the
3802 "+=" and "-=" feature of ":set" |add-option-flags|.
3803 NOTE: This option is set to the Vi default value when 'compatible' is
3804 set and to the Vim default value when 'compatible' is reset.
3805
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 *'formatprg'* *'fp'*
3807'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003808 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003810 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003812 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003813 If the 'formatexpr' option is not empty it will be used instead.
3814 Otherwise, if 'formatprg' option is an empty string, the internal
3815 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003816 Environment variables are expanded |:set_env|. See |option-backslash|
3817 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003818 This option cannot be set from a |modeline| or in the |sandbox|, for
3819 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820
Bram Moolenaard94464e2015-11-02 15:28:18 +01003821 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003822'fsync' 'fs' boolean (default on)
3823 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003824 When on, the library function fsync() will be called after writing a
3825 file. This will flush a file to disk, ensuring that it is safely
3826 written even on filesystems which do metadata-only journaling. This
3827 will force the harddrive to spin up on Linux systems running in laptop
3828 mode, so it may be undesirable in some situations. Be warned that
3829 turning this off increases the chances of data loss after a crash. On
3830 systems without an fsync() implementation, this variable is always
3831 off.
3832 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003833 'fsync' also applies to |writefile()| (unless a flag is used to
3834 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003835 This option cannot be set from a |modeline| or in the |sandbox|, for
3836 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003837
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3839'gdefault' 'gd' boolean (default off)
3840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 When on, the ":substitute" flag 'g' is default on. This means that
3842 all matches in a line are substituted instead of one. When a 'g' flag
3843 is given to a ":substitute" command, this will toggle the substitution
3844 of all or one match. See |complex-change|.
3845
3846 command 'gdefault' on 'gdefault' off ~
3847 :s/// subst. all subst. one
3848 :s///g subst. one subst. all
3849 :s///gg subst. all subst. one
3850
3851 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003852 Setting this option may break plugins that rely on the default
3853 behavior of the 'g' flag. This will also make the 'g' flag have the
3854 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003855 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856
3857 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003858'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 Format to recognize for the ":grep" command output.
3861 This is a scanf-like string that uses the same format as the
3862 'errorformat' option: see |errorformat|.
3863
3864 *'grepprg'* *'gp'*
3865'grepprg' 'gp' string (default "grep -n ",
3866 Unix: "grep -n $* /dev/null",
3867 Win32: "findstr /n" or "grep -n",
3868 VMS: "SEARCH/NUMBERS ")
3869 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003870 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 and '#' characters, which are expanded like when used in a command-
3872 line. The placeholder "$*" is allowed to specify where the arguments
3873 will be included. Environment variables are expanded |:set_env|. See
3874 |option-backslash| about including spaces and backslashes.
3875 When your "grep" accepts the "-H" argument, use this to make ":grep"
3876 also work well with a single file: >
3877 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003878< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003879 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3880 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003881 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 apply equally to 'grepprg'.
3883 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3884 otherwise it's "grep -n".
3885 This option cannot be set from a |modeline| or in the |sandbox|, for
3886 security reasons.
3887
3888 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3889'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3890 ve:ver35-Cursor,
3891 o:hor50-Cursor,
3892 i-ci:ver25-Cursor/lCursor,
3893 r-cr:hor20-Cursor/lCursor,
3894 sm:block-Cursor
3895 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003896 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 "n-v-c:block,o:hor50,i-ci:hor15,
3898 r-cr:hor30,sm:block")
3899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003901 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003903 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003904 height of the cursor can be changed. This can be done by specifying a
3905 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003906 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3907 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003909 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 mode-list and an argument-list:
3911 mode-list:argument-list,mode-list:argument-list,..
3912 The mode-list is a dash separated list of these modes:
3913 n Normal mode
3914 v Visual mode
3915 ve Visual mode with 'selection' "exclusive" (same as 'v',
3916 if not specified)
3917 o Operator-pending mode
3918 i Insert mode
3919 r Replace mode
3920 c Command-line Normal (append) mode
3921 ci Command-line Insert mode
3922 cr Command-line Replace mode
3923 sm showmatch in Insert mode
3924 a all modes
3925 The argument-list is a dash separated list of these arguments:
3926 hor{N} horizontal bar, {N} percent of the character height
3927 ver{N} vertical bar, {N} percent of the character width
3928 block block cursor, fills the whole character
3929 [only one of the above three should be present]
3930 blinkwait{N} *cursor-blinking*
3931 blinkon{N}
3932 blinkoff{N}
3933 blink times for cursor: blinkwait is the delay before
3934 the cursor starts blinking, blinkon is the time that
3935 the cursor is shown and blinkoff is the time that the
3936 cursor is not shown. The times are in msec. When one
3937 of the numbers is zero, there is no blinking. The
3938 default is: "blinkwait700-blinkon400-blinkoff250".
3939 These numbers are used for a missing entry. This
3940 means that blinking is enabled by default. To switch
3941 blinking off you can use "blinkon0". The cursor only
3942 blinks when Vim is waiting for input, not while
3943 executing a command.
3944 To make the cursor blink in an xterm, see
3945 |xterm-blink|.
3946 {group-name}
3947 a highlight group name, that sets the color and font
3948 for the cursor
3949 {group-name}/{group-name}
3950 Two highlight group names, the first is used when
3951 no language mappings are used, the other when they
3952 are. |language-mapping|
3953
3954 Examples of parts:
3955 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3956 block cursor with colors from the "nCursor"
3957 highlight group
3958 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3959 In Insert and Command-line Insert mode, use a
3960 30% vertical bar cursor with colors from the
3961 "iCursor" highlight group. Blink a bit
3962 faster.
3963
3964 The 'a' mode is different. It will set the given argument-list for
3965 all modes. It does not reset anything to defaults. This can be used
3966 to do a common setting for all modes. For example, to switch off
3967 blinking: "a:blinkon0"
3968
3969 Examples of cursor highlighting: >
3970 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3971 :highlight Cursor gui=NONE guifg=bg guibg=fg
3972<
3973 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003974 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975'guifont' 'gfn' string (default "")
3976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 {only available when compiled with GUI enabled}
3978 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003979 In its simplest form the value is just one font name.
3980 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981
3982 *'guifontset'* *'gfs'*
3983 *E250* *E252* *E234* *E597* *E598*
3984'guifontset' 'gfs' string (default "")
3985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 {only available when compiled with GUI enabled and
3987 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003988 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 When not empty, specifies two (or more) fonts to be used. The first
3990 one for normal English, the second one for your special language. See
3991 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003992
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3994'guifontwide' 'gfw' string (default "")
3995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 {only available when compiled with GUI enabled}
3997 When not empty, specifies a comma-separated list of fonts to be used
3998 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003999 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004000
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 *'guiheadroom'* *'ghr'*
4002'guiheadroom' 'ghr' number (default 50)
4003 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004004 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 The number of pixels subtracted from the screen height when fitting
4006 the GUI window on the screen. Set this before the GUI is started,
4007 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004008 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 lines will be left for window decorations and other items on the
4010 screen. Set it to a negative value to allow windows taller than the
4011 screen.
4012
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004013 *'guiligatures'* *'gli'* *E1243*
4014'guiligatures' 'gli' string (default "")
4015 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004016 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004017 List of ASCII characters that, when combined together, can create more
4018 complex shapes. Each character must be a printable ASCII character
4019 with a value in the 32-127 range.
4020 Example: >
4021 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4022< Changing this option updates screen output immediately. Set it to an
4023 empty string to disable ligatures.
4024
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004026'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4027 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004028 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004029 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004032 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 sequence of letters which describes what components and options of the
4034 GUI should be used.
4035 To avoid problems with flags that are added in the future, use the
4036 "+=" and "-=" feature of ":set" |add-option-flags|.
4037
Bram Moolenaar13568252018-03-16 20:46:58 +01004038 Valid characters are as follows:
4039 *'go-!'*
4040 '!' External commands are executed in a terminal window. Without
4041 this flag the MS-Windows GUI will open a console window to
4042 execute the command. The Unix GUI will simulate a dumb
4043 terminal to list the command output.
4044 The terminal window will be positioned at the bottom, and grow
4045 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004046 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 'a' Autoselect: If present, then whenever VISUAL mode is started,
4048 or the Visual area extended, Vim tries to become the owner of
4049 the windowing system's global selection. This means that the
4050 Visually highlighted text is available for pasting into other
4051 applications as well as into Vim itself. When the Visual mode
4052 ends, possibly due to an operation on the text, or when an
4053 application wants to paste the selection, the highlighted text
4054 is automatically yanked into the "* selection register.
4055 Thus the selection is still available for pasting into other
4056 applications after the VISUAL mode has ended.
4057 If not present, then Vim won't become the owner of the
4058 windowing system's global selection unless explicitly told to
4059 by a yank or delete operation for the "* register.
4060 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004061 *'go-P'*
4062 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004063 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004064 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004065 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 applies to the modeless selection.
4067
4068 'guioptions' autoselect Visual autoselect modeless ~
4069 "" - -
4070 "a" yes yes
4071 "A" - yes
4072 "aA" yes yes
4073
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004074 When using a terminal see the 'clipboard' option.
4075
Bram Moolenaar02467872007-05-06 13:22:01 +00004076 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 'c' Use console dialogs instead of popup dialogs for simple
4078 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004079 *'go-d'*
4080 'd' Use dark theme variant if available. Currently only works for
4081 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004082 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004083 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004084 'guitablabel' can be used to change the text in the labels.
4085 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004086 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004087 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004088 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 'f' Foreground: Don't use fork() to detach the GUI from the shell
4090 where it was started. Use this for programs that wait for the
4091 editor to finish (e.g., an e-mail program). Alternatively you
4092 can use "gvim -f" or ":gui -f" to start the GUI in the
4093 foreground. |gui-fork|
4094 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004095 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004096 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4098 corner of the window. It's black&white on non-GTK, because of
4099 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004100 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004102 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004103 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004105 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004107 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004108 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 'g' Grey menu items: Make menu items that are not active grey. If
4110 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004111 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 't' Include tearoff menu items. Currently only works for Win32,
4113 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004114 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004115 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4116 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004117 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004119 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 'R' Right-hand scrollbar is present when there is a vertically
4121 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004122 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004124 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 'L' Left-hand scrollbar is present when there is a vertically
4126 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004127 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4129 the longest visible line, or on the cursor line if the 'h'
4130 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004131 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 'h' Limit horizontal scrollbar size to the length of the cursor
4133 line. Reduces computations. |gui-horiz-scroll|
4134
4135 And yes, you may even have scrollbars on the left AND the right if
4136 you really want to :-). See |gui-scrollbars| for more information.
4137
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004138 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 'v' Use a vertical button layout for dialogs. When not included,
4140 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004141 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004142 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 'p' Use Pointer callbacks for X11 GUI. This is required for some
4144 window managers. If the cursor is not blinking or hollow at
4145 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004146 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004148 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004149 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004150 *'go-k'*
4151 'k' Keep the GUI window size when adding/removing a scrollbar, or
4152 toolbar, tabline, etc. Instead, the behavior is similar to
4153 when the window is maximized and will adjust 'lines' and
4154 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004155 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004156 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004157
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 *'guipty'* *'noguipty'*
4159'guipty' boolean (default on)
4160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 {only available when compiled with GUI enabled}
4162 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4163 I/O to/from shell commands. See |gui-pty|.
4164
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004165 *'guitablabel'* *'gtl'*
4166'guitablabel' 'gtl' string (default empty)
4167 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004168 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004169 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004170 pages line. When empty and when the result is empty Vim will use a
4171 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004172
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004173 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004174 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004175 The expression will be evaluated in the |sandbox| when set from a
4176 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004177 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004178
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004179 Only used when the GUI tab pages line is displayed. 'e' must be
4180 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4181 used.
4182
Bram Moolenaar57657d82006-04-21 22:12:41 +00004183 *'guitabtooltip'* *'gtt'*
4184'guitabtooltip' 'gtt' string (default empty)
4185 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004186 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004187 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004188 pages line. When empty Vim will use a default tooltip.
4189 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004190 You can include a line break. Simplest method is to use |:let|: >
4191 :let &guitabtooltip = "line one\nline two"
4192<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004193
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004195'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 (others) "$VIMRUNTIME/doc/help.txt")
4197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 Name of the main help file. All distributed help files should be
4199 placed together in one directory. Additionally, all "doc" directories
4200 in 'runtimepath' will be used.
4201 Environment variables are expanded |:set_env|. For example:
4202 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004203 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 spaces and backslashes.
4205 This option cannot be set from a |modeline| or in the |sandbox|, for
4206 security reasons.
4207
4208 *'helpheight'* *'hh'*
4209'helpheight' 'hh' number (default 20)
4210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 Minimal initial height of the help window when it is opened with the
4212 ":help" command. The initial height of the help window is half of the
4213 current window, or (when the 'ea' option is on) the same as other
4214 windows. When the height is less than 'helpheight', the height is
4215 set to 'helpheight'. Set to zero to disable.
4216
4217 *'helplang'* *'hlg'*
4218'helplang' 'hlg' string (default: messages language or empty)
4219 global
4220 {only available when compiled with the |+multi_lang|
4221 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004222 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 for which the desired help can be found. The English help will always
4224 be used as a last resort. You can add "en" to prefer English over
4225 another language, but that will only find tags that exist in that
4226 language and not in the English help.
4227 Example: >
4228 :set helplang=de,it
4229< This will first search German, then Italian and finally English help
4230 files.
4231 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4232 try to find the tag in the current language before using this option.
4233 See |help-translated|.
4234
4235 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4236'hidden' 'hid' boolean (default off)
4237 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 When off a buffer is unloaded when it is |abandon|ed. When on a
4239 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4240 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004241
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004243 hidden even if the 'hidden' option is off when these three are true:
4244 - the buffer is modified
4245 - 'autowrite' is off or writing is not possible
4246 - the '!' flag was used
4247 Also see |windows.txt|.
4248
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004249 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 This option is set for one command with ":hide {command}" |:hide|.
4251 WARNING: It's easy to forget that you have changes in hidden buffers.
4252 Think twice when using ":q!" or ":qa!".
4253
4254 *'highlight'* *'hl'*
4255'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004256 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4257 d:Directory,e:ErrorMsg,i:IncSearch,
4258 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004259 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004260 N:CursorLineNr,r:Question,s:StatusLine,
4261 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004262 v:Visual,V:VisualNOS,w:WarningMsg,
4263 W:WildMenu,f:Folded,F:FoldColumn,
4264 A:DiffAdd,C:DiffChange,D:DiffDelete,
4265 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004266 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004267 L:SpellLocal,+:Pmenu,=:PmenuSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004268 [:PmenuKind,]:PmenuKindSel,
4269 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004270 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4271 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004272 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004273 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004276 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004278 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004280 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4281 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 characters from 'showbreak'
4283 |hl-Directory| d directories in CTRL-D listing and other special
4284 things in listings
4285 |hl-ErrorMsg| e error messages
4286 h (obsolete, ignored)
4287 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004288 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4290 |hl-MoreMsg| m |more-prompt|
4291 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004292 |hl-LineNr| n line number for ":number" and ":#" commands, and
4293 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004294 |hl-LineNrAbove| a line number above the cursor for when the
4295 'relativenumber' option is set.
4296 |hl-LineNrBelow| b line number below the cursor for when the
4297 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004298 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4299 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 |hl-Question| r |hit-enter| prompt and yes/no questions
4301 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004302 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4304 |hl-VertSplit| c column used to separate vertically split windows
4305 |hl-Visual| v Visual mode
4306 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4307 Selection" Only X11 Gui's |gui-x11| and
4308 |xterm-clipboard|.
4309 |hl-WarningMsg| w warning messages
4310 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4311 |hl-Folded| f line used for closed folds
4312 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004313 |hl-DiffAdd| A added line in diff mode
4314 |hl-DiffChange| C changed line in diff mode
4315 |hl-DiffDelete| D deleted line in diff mode
4316 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004318 |hl-Conceal| - the placeholders used for concealed characters
4319 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004320 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004321 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004322 |hl-SpellRare| R rare word |spell|
4323 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004324 |hl-Pmenu| + popup menu normal line
4325 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004326 |hl-PmenuKind| [ popup menu "kind" normal line
4327 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004328 |hl-PmenuExtra| { popup menu "extra" normal line
4329 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004330 |hl-PmenuSbar| x popup menu scrollbar
4331 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332
4333 The display modes are:
4334 r reverse (termcap entry "mr" and "me")
4335 i italic (termcap entry "ZH" and "ZR")
4336 b bold (termcap entry "md" and "me")
4337 s standout (termcap entry "so" and "se")
4338 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004339 c undercurl (termcap entry "Us" and "Ce")
4340 2 double underline (termcap entry "Ds" and "Ce")
4341 d dotted underline (termcap entry "ds" and "Ce")
4342 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004343 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 n no highlighting
4345 - no highlighting
4346 : use a highlight group
4347 The default is used for occasions that are not included.
4348 If you want to change what the display modes do, see |dos-colors|
4349 for an example.
4350 When using the ':' display mode, this must be followed by the name of
4351 a highlight group. A highlight group can be used to define any type
4352 of highlighting, including using color. See |:highlight| on how to
4353 define one. The default uses a different group for each occasion.
4354 See |highlight-default| for the default highlight groups.
4355
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004357'history' 'hi' number (Vim default: 50, Vi default: 0,
4358 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004361 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004363 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 NOTE: This option is set to the Vi default value when 'compatible' is
4365 set and to the Vim default value when 'compatible' is reset.
4366
4367 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4368'hkmap' 'hk' boolean (default off)
4369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 {only available when compiled with the |+rightleft|
4371 feature}
4372 When on, the keyboard is mapped for the Hebrew character set.
4373 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4374 toggle this option. See |rileft.txt|.
4375 NOTE: This option is reset when 'compatible' is set.
4376
4377 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4378'hkmapp' 'hkp' boolean (default off)
4379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 {only available when compiled with the |+rightleft|
4381 feature}
4382 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4383 This is useful if you have a non-Hebrew keyboard.
4384 See |rileft.txt|.
4385 NOTE: This option is reset when 'compatible' is set.
4386
Bram Moolenaar036986f2017-03-16 17:41:02 +01004387 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4388'hlsearch' 'hls' boolean (default off)
4389 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004390 {not available when compiled without the
4391 |+extra_search| feature}
4392 When there is a previous search pattern, highlight all its matches.
4393 The type of highlighting used can be set with the 'l' occasion in the
4394 'highlight' option. This uses the "Search" highlight group by
4395 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004396 are not applied. If the "CurSearch" highlight group is set then the
4397 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004398 See also: 'incsearch' and |:match|.
4399 When you get bored looking at the highlighted matches, you can turn it
4400 off with |:nohlsearch|. This does not change the option value, as
4401 soon as you use a search command, the highlighting comes back.
4402 'redrawtime' specifies the maximum time spent on finding matches.
4403 When the search pattern can match an end-of-line, Vim will try to
4404 highlight all of the matched text. However, this depends on where the
4405 search starts. This will be the first line in the window or the first
4406 line below a closed fold. A match in a previous line which is not
4407 drawn may not continue in a newly drawn line.
4408 You can specify whether the highlight status is restored on startup
4409 with the 'h' flag in 'viminfo' |viminfo-h|.
4410 NOTE: This option is reset when 'compatible' is set.
4411
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 *'icon'* *'noicon'*
4413'icon' boolean (default off, on when title can be restored)
4414 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 When on, the icon text of the window will be set to the value of
4416 'iconstring' (if it is not empty), or to the name of the file
4417 currently being edited. Only the last part of the name is used.
4418 Overridden by the 'iconstring' option.
4419 Only works if the terminal supports setting window icons (currently
4420 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4421 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4422 builtin termcap).
4423 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004424 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004426 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427
4428 *'iconstring'*
4429'iconstring' string (default "")
4430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 When this option is not empty, it will be used for the icon text of
4432 the window. This happens only when the 'icon' option is on.
4433 Only works if the terminal supports setting window icon text
4434 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004435 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 When Vim was compiled with HAVE_X11 defined, the original icon will be
4437 restored if possible |X11|.
4438 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004439 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004441 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 {not available when compiled without the |+statusline| feature}
4443
4444 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4445'ignorecase' 'ic' boolean (default off)
4446 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004447 Ignore case in search patterns, |cmdline-completion|, when
4448 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004449 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 Can be overruled by using "\c" or "\C" in the pattern, see
4451 |/ignorecase|.
4452
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004453 *'imactivatefunc'* *'imaf'*
4454'imactivatefunc' 'imaf' string (default "")
4455 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004456 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004457 activate or deactivate the Input Method. The value can be the name of
4458 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4459 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004460 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004461 The expression will be evaluated in the |sandbox| when set from a
4462 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004463
4464 Example: >
4465 function ImActivateFunc(active)
4466 if a:active
4467 ... do something
4468 else
4469 ... do something
4470 endif
4471 " return value is not used
4472 endfunction
4473 set imactivatefunc=ImActivateFunc
4474<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 *'imactivatekey'* *'imak'*
4476'imactivatekey' 'imak' string (default "")
4477 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004479 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 Specifies the key that your Input Method in X-Windows uses for
4481 activation. When this is specified correctly, vim can fully control
4482 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4483 You can't use this option to change the activation key, the option
4484 tells Vim what the key is.
4485 Format:
4486 [MODIFIER_FLAG-]KEY_STRING
4487
4488 These characters can be used for MODIFIER_FLAG (case is ignored):
4489 S Shift key
4490 L Lock key
4491 C Control key
4492 1 Mod1 key
4493 2 Mod2 key
4494 3 Mod3 key
4495 4 Mod4 key
4496 5 Mod5 key
4497 Combinations are allowed, for example "S-C-space" or "SC-space" are
4498 both shift+ctrl+space.
4499 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4500
4501 Example: >
4502 :set imactivatekey=S-space
4503< "S-space" means shift+space. This is the activation key for kinput2 +
4504 canna (Japanese), and ami (Korean).
4505
4506 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4507'imcmdline' 'imc' boolean (default off)
4508 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 When set the Input Method is always on when starting to edit a command
4510 line, unless entering a search pattern (see 'imsearch' for that).
4511 Setting this option is useful when your input method allows entering
4512 English characters directly, e.g., when it's used to type accented
4513 characters with dead keys.
4514
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004515 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 When set the Input Method is never used. This is useful to disable
4519 the IM when it doesn't work properly.
4520 Currently this option is on by default for SGI/IRIX machines. This
4521 may change in later releases.
4522
4523 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004524'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 Specifies whether :lmap or an Input Method (IM) is to be used in
4527 Insert mode. Valid values:
4528 0 :lmap is off and IM is off
4529 1 :lmap is ON and IM is off
4530 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 To always reset the option to zero when leaving Insert mode with <Esc>
4532 this can be used: >
4533 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4534< This makes :lmap and IM turn off automatically when leaving Insert
4535 mode.
4536 Note that this option changes when using CTRL-^ in Insert mode
4537 |i_CTRL-^|.
4538 The value is set to 1 when setting 'keymap' to a valid keymap name.
4539 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004540 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 methods. Use 'imdisable' to disable XIM then.
4542
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004543 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004544 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004545 |+multi_byte_ime| or |global-ime|.
4546
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004548'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 Specifies whether :lmap or an Input Method (IM) is to be used when
4551 entering a search pattern. Valid values:
4552 -1 the value of 'iminsert' is used, makes it look like
4553 'iminsert' is also used when typing a search pattern
4554 0 :lmap is off and IM is off
4555 1 :lmap is ON and IM is off
4556 2 :lmap is off and IM is ON
4557 Note that this option changes when using CTRL-^ in Command-line mode
4558 |c_CTRL-^|.
4559 The value is set to 1 when it is not -1 and setting the 'keymap'
4560 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004561 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 methods. Use 'imdisable' to disable XIM then.
4563
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004564 *'imstatusfunc'* *'imsf'*
4565'imstatusfunc' 'imsf' string (default "")
4566 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004567 This option specifies a function that is called to obtain the status
4568 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004569 The value can be the name of a function, a |lambda| or a |Funcref|.
4570 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004571 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004572
4573 Example: >
4574 function ImStatusFunc()
4575 let is_active = ...do something
4576 return is_active ? 1 : 0
4577 endfunction
4578 set imstatusfunc=ImStatusFunc
4579<
4580 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004581 The expression will be evaluated in the |sandbox| when set from a
4582 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004583
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004584 *'imstyle'* *'imst'*
4585'imstyle' 'imst' number (default 1)
4586 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004587 {only available when compiled with |+xim| and
4588 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004589 This option specifies the input style of Input Method:
4590 0 use on-the-spot style
4591 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004592 See: |xim-input-style|
4593
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004594 For a long time on-the-spot style had been used in the GTK version of
4595 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004596 |single-repeat|, etc. Therefore over-the-spot style becomes the
4597 default now. This should work fine for most people, however if you
4598 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004599 The expression will be evaluated in the |sandbox| when set from a
4600 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004601
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 *'include'* *'inc'*
4603'include' 'inc' string (default "^\s*#\s*include")
4604 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 {not available when compiled without the
4606 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004607 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608 pattern, just like for the "/" command (See |pattern|). The default
4609 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004610 "]I", "[d", etc.
4611 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004612 comes after the matched pattern. But if "\zs" appears in the pattern
4613 then the text matched from "\zs" to the end, or until "\ze" if it
4614 appears, is used as the file name. Use this to include characters
4615 that are not in 'isfname', such as a space. You can then use
4616 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004617 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618
4619 *'includeexpr'* *'inex'*
4620'includeexpr' 'inex' string (default "")
4621 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004623 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004625 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004626 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004628 Note the double backslash: the `:set` command first halves them, then
4629 one remains it the value, where "\." matches a dot literally. For
4630 simple character replacements `tr()` avoids the need for escaping: >
4631 :setlocal includeexpr=tr(v:fname,'.','/')
4632<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004634 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 Also used for |<cfile>|.
4636
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004637 If the expression starts with s: or |<SID>|, then it is replaced with
4638 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004639 setlocal includeexpr=s:MyIncludeExpr()
4640 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004641< Otherwise, the expression is evaluated in the context of the script
4642 where the option was set, thus script-local items are available.
4643
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004644 It is more efficient if the value is just a function call without
4645 arguments, see |expr-option-function|.
4646
Bram Moolenaar30b65812012-07-12 22:01:11 +02004647 The expression will be evaluated in the |sandbox| when set from a
4648 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004649 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004650
4651 It is not allowed to change text or jump to another window while
4652 evaluating 'includeexpr' |textlock|.
4653
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004655'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004656 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004659 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004660 While typing a search command, show where the pattern, as it was typed
4661 so far, matches. The matched string is highlighted. If the pattern
4662 is invalid or not found, nothing is shown. The screen will be updated
4663 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004664 Also applies to the pattern in commands: >
4665 :global
4666 :lvimgrep
4667 :lvimgrepadd
4668 :smagic
4669 :snomagic
4670 :sort
4671 :substitute
4672 :vglobal
4673 :vimgrep
4674 :vimgrepadd
4675< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004676 original position when no match is found and when pressing <Esc>. You
4677 still need to finish the search command with <Enter> to move the
4678 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004679 You can use the CTRL-G and CTRL-T keys to move to the next and
4680 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004681 When compiled with the |+reltime| feature Vim only searches for about
4682 half a second. With a complicated pattern and/or a lot of text the
4683 match may not be found. This is to avoid that Vim hangs while you
4684 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004685 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004686 When 'hlsearch' is on, all matched strings are highlighted too while
4687 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004688 If you don't want to turn 'hlsearch' on, but want to highlight all
4689 matches while searching, you can turn on and off 'hlsearch' with
4690 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004691 augroup vimrc-incsearch-highlight
4692 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004693 autocmd CmdlineEnter /,\? :set hlsearch
4694 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004695 augroup END
4696<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004697 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004698 to the command line. If 'ignorecase' and 'smartcase' are set and the
4699 command line has no uppercase characters, the added character is
4700 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004701 CTRL-R CTRL-W can be used to add the word at the end of the current
4702 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 NOTE: This option is reset when 'compatible' is set.
4704
4705 *'indentexpr'* *'inde'*
4706'indentexpr' 'inde' string (default "")
4707 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004708 {not available when compiled without the |+eval|
4709 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 Expression which is evaluated to obtain the proper indent for a line.
4711 It is used when a new line is created, for the |=| operator and
4712 in Insert mode as specified with the 'indentkeys' option.
4713 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004714 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004715 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716 When 'paste' is set this option is not used for indenting.
4717 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004718 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004720
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004721 If the expression starts with s: or |<SID>|, then it is replaced with
4722 the script ID (|local-function|). Example: >
4723 set indentexpr=s:MyIndentExpr()
4724 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004725< Otherwise, the expression is evaluated in the context of the script
4726 where the option was set, thus script-local items are available.
4727
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004728 The advantage of using a function call without arguments is that it is
4729 faster, see |expr-option-function|.
4730
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 The expression must return the number of spaces worth of indent. It
4732 can return "-1" to keep the current indent (this means 'autoindent' is
4733 used for the indent).
4734 Functions useful for computing the indent are |indent()|, |cindent()|
4735 and |lispindent()|.
4736 The evaluation of the expression must not have side effects! It must
4737 not change the text, jump to another window, etc. Afterwards the
4738 cursor position is always restored, thus the cursor may be moved.
4739 Normally this option would be set to call a function: >
4740 :set indentexpr=GetMyIndent()
4741< Error messages will be suppressed, unless the 'debug' option contains
4742 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004743 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004744 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745
Bram Moolenaar30b65812012-07-12 22:01:11 +02004746 The expression will be evaluated in the |sandbox| when set from a
4747 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004748 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004749
4750 It is not allowed to change text or jump to another window while
4751 evaluating 'indentexpr' |textlock|.
4752
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004754'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 A list of keys that, when typed in Insert mode, cause reindenting of
4757 the current line. Only happens if 'indentexpr' isn't empty.
4758 The format is identical to 'cinkeys', see |indentkeys-format|.
4759 See |C-indenting| and |indent-expression|.
4760
4761 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4762'infercase' 'inf' boolean (default off)
4763 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004765 'ignorecase' is also on, the case of the match is adjusted depending
4766 on the typed text. If the typed text contains a lowercase letter
4767 where the match has an upper case letter, the completed part is made
4768 lowercase. If the typed text has no lowercase letters and the match
4769 has a lowercase letter where the typed text has an uppercase letter,
4770 and there is a letter before it, the completed part is made uppercase.
4771 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772
4773 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4774'insertmode' 'im' boolean (default off)
4775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 Makes Vim work in a way that Insert mode is the default mode. Useful
4777 if you want to use Vim as a modeless editor. Used for |evim|.
4778 These Insert mode commands will be useful:
4779 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004780 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 this is a mapping, it is executed as if 'insertmode' was off.
4782 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004784 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4785 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786
4787 These items change when 'insertmode' is set:
4788 - when starting to edit of a file, Vim goes to Insert mode.
4789 - <Esc> in Insert mode is a no-op and beeps.
4790 - <Esc> in Normal mode makes Vim go to Insert mode.
4791 - CTRL-L in Insert mode is a command, it is not inserted.
4792 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4793 However, when <Esc> is used inside a mapping, it behaves like
4794 'insertmode' was not set. This was done to be able to use the same
4795 mappings with 'insertmode' set or not set.
4796 When executing commands with |:normal| 'insertmode' is not used.
4797
4798 NOTE: This option is reset when 'compatible' is set.
4799
4800 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004801'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4803 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4804 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4805 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4806 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 The characters specified by this option are included in file names and
4809 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004810 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 Multi-byte characters 256 and above are always included, only the
4812 characters up to 255 are specified with this option.
4813 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004814 Think twice before adding white space to this option. Although a
4815 space may appear inside a file name, the effect will be that Vim
4816 doesn't know where a file name starts or ends when doing completion.
4817 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818
4819 Note that on systems using a backslash as path separator, Vim tries to
4820 do its best to make it work as you would expect. That is a bit
4821 tricky, since Vi originally used the backslash to escape special
4822 characters. Vim will not remove a backslash in front of a normal file
4823 name character on these systems, but it will on Unix and alikes. The
4824 '&' and '^' are not included by default, because these are special for
4825 cmd.exe.
4826
4827 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004828 Each part can be a single character number or a range. A range is two
4829 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 decimal number between 0 and 255 or the ASCII character itself (does
4831 not work for digits). Example:
4832 "_,-,128-140,#-43" (include '_' and '-' and the range
4833 128 to 140 and '#' to 43)
4834 If a part starts with '^', the following character number or range
4835 will be excluded from the option. The option is interpreted from left
4836 to right. Put the excluded character after the range where it is
4837 included. To include '^' itself use it as the last character of the
4838 option or the end of a range. Example:
4839 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4840 If the character is '@', all characters where isalpha() returns TRUE
4841 are included. Normally these are the characters a to z and A to Z,
4842 plus accented characters. To include '@' itself use "@-@". Examples:
4843 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004844 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 "a-z,A-Z,@-@" All letters plus the '@' character.
4846 A comma can be included by using it where a character number is
4847 expected. Example:
4848 "48-57,,,_" Digits, comma and underscore.
4849 A comma can be excluded by prepending a '^'. Example:
4850 " -~,^,,9" All characters from space to '~', excluding
4851 comma, plus <Tab>.
4852 See |option-backslash| about including spaces and backslashes.
4853
4854 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004855'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 "@,48-57,_,128-167,224-235"
4857 otherwise: "@,48-57,_,192-255")
4858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 The characters given by this option are included in identifiers.
4860 Identifiers are used in recognizing environment variables and after a
4861 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004862 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004863 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004865 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4867
4868 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004869'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 "@,48-57,_,128-167,224-235"
4871 otherwise: "@,48-57,_,192-255"
4872 Vi default: "@,48-57,_")
4873 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004875 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004876 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004877 characters above 255 check the "word" character class (any character
4878 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004879 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 For a help file it is set to all non-blank printable characters except
4881 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4882 command).
4883 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004884 This option also influences syntax highlighting, unless the syntax
4885 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 NOTE: This option is set to the Vi default value when 'compatible' is
4887 set and to the Vim default value when 'compatible' is reset.
4888
4889 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004890'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 "@,~-255"; otherwise: "@,161-255")
4892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 The characters given by this option are displayed directly on the
4894 screen. It is also used for "\p" in a |pattern|. The characters from
4895 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4896 even when they are not included in 'isprint' or excluded. See
4897 'isfname' for a description of the format of this option.
4898
4899 Non-printable characters are displayed with two characters:
4900 0 - 31 "^@" - "^_"
4901 32 - 126 always single characters
4902 127 "^?"
4903 128 - 159 "~@" - "~_"
4904 160 - 254 "| " - "|~"
4905 255 "~?"
4906 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4907 displayed as <xx>, with the hexadecimal value of the byte.
4908 When 'display' contains "uhex" all unprintable characters are
4909 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004910 The SpecialKey highlighting will be used for unprintable characters.
4911 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912
4913 Multi-byte characters 256 and above are always included, only the
4914 characters up to 255 are specified with this option. When a character
4915 is printable but it is not available in the current font, a
4916 replacement character will be shown.
4917 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4918 There is no option to specify these characters.
4919
4920 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4921'joinspaces' 'js' boolean (default on)
4922 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 Insert two spaces after a '.', '?' and '!' with a join command.
4924 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4925 Otherwise only one space is inserted.
4926 NOTE: This option is set when 'compatible' is set.
4927
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004928 *'jumpoptions'* *'jop'*
4929'jumpoptions' 'jop' string (default "")
4930 global
4931 List of words that change the behavior of the |jumplist|.
4932 stack Make the jumplist behave like the tagstack.
4933 Relative location of entries in the jumplist is
4934 preserved at the cost of discarding subsequent entries
4935 when navigating backwards in the jumplist and then
4936 jumping to a location. |jumplist-stack|
4937
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 *'key'*
4939'key' string (default "")
4940 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004941 {only available when compiled with the |+cryptv|
4942 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004944 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 Careful: Do not set the key value by hand, someone might see the typed
4946 key. Use the |:X| command. But you can make 'key' empty: >
4947 :set key=
4948< It is not possible to get the value of this option with ":set key" or
4949 "echo &key". This is to avoid showing it to someone who shouldn't
4950 know. It also means you cannot see it yourself once you have set it,
4951 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004952 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4953 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004954 You can use "&key" in an expression to detect whether encryption is
4955 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956
4957 *'keymap'* *'kmp'* *E544*
4958'keymap' 'kmp' string (default "")
4959 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 {only available when compiled with the |+keymap|
4961 feature}
4962 Name of a keyboard mapping. See |mbyte-keymap|.
4963 Setting this option to a valid keymap name has the side effect of
4964 setting 'iminsert' to one, so that the keymap becomes effective.
4965 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004966 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967
4968 *'keymodel'* *'km'*
4969'keymodel' 'km' string (default "")
4970 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004971 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 can do. These values can be used:
4973 startsel Using a shifted special key starts selection (either
4974 Select mode or Visual mode, depending on "key" being
4975 present in 'selectmode').
4976 stopsel Using a not-shifted special key stops selection.
4977 Special keys in this context are the cursor keys, <End>, <Home>,
4978 <PageUp> and <PageDown>.
4979 The 'keymodel' option is set by the |:behave| command.
4980
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004981 *'keyprotocol'* *'kpc'*
4982'keyprotocol' 'kpc' string (default: see below)
4983 global
4984 Specifies what keyboard protocol to use depending on the value of
4985 'term'. The supported keyboard protocols names are:
4986 none whatever the terminal uses
4987 mok2 modifyOtherKeys level 2, as supported by xterm
4988 kitty Kitty keyboard protocol, as supported by Kitty
4989
Bram Moolenaara87749e2022-11-30 10:23:17 +00004990 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004991 a pattern that is matched against the 'term' option, a colon and the
4992 protocol name to be used. To illustrate this, the default value would
4993 be set with: >
4994 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
4995
4996< This means that when 'term' contains "kitty, "foot" or "wezterm"
4997 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00004998 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004999
5000 The first match is used, thus if you want to have "kitty" use the
5001 kitty protocol, but "badkitty" not, then you should match "badkitty"
5002 first and use the "none" value: >
5003 set keyprotocol=badkitty:none,kitty:kitty
5004<
5005 The option is used after 'term' has been changed. First the termcap
5006 entries are set, possibly using the builtin list, see |builtin-terms|.
5007 Then this option is inspected and if there is a match and a protocol
5008 is specified the following happens:
5009 none Nothing, the regular t_TE and t_TI values remain
5010
5011 mok2 The t_TE value is changed to:
5012 CSI >4;m disables modifyOtherKeys
5013 The t_TI value is changed to:
5014 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005015 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005016
5017 kitty The t_TE value is changed to:
5018 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005019 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005020 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005021 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005022 CSI ?u request kitty keyboard protocol state
5023 CSI >c request the termresponse
5024
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005025 If you notice problems, such as characters being displayed that
5026 disappear after `CTRL-L`, you might want to try making this option
5027 empty. Then set the 'term' option to have it take effect: >
5028 set keyprotocol=
5029 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005030<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005031
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 *'keywordprg'* *'kp'*
5033'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005034 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 Program to use for the |K| command. Environment variables are
5037 expanded |:set_env|. ":help" may be used to access the Vim internal
5038 help. (Note that previously setting the global option to the empty
5039 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005040 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005041 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005042 When "man", "man -s" or an Ex command is used, Vim will automatically
5043 translate a count for the "K" command and pass it as the first
5044 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 See |option-backslash| about including spaces and backslashes.
5046 Example: >
5047 :set keywordprg=man\ -s
5048< This option cannot be set from a |modeline| or in the |sandbox|, for
5049 security reasons.
5050
5051 *'langmap'* *'lmap'* *E357* *E358*
5052'langmap' 'lmap' string (default "")
5053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 {only available when compiled with the |+langmap|
5055 feature}
5056 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005057 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005058 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 care of translating these special characters to the original meaning
5060 of the key. This means you don't have to change the keyboard mode to
5061 be able to execute Normal mode commands.
5062 This is the opposite of the 'keymap' option, where characters are
5063 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005064 Also consider setting 'langremap' to off, to prevent 'langmap' from
5065 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005066 This option cannot be set from a |modeline| or in the |sandbox|, for
5067 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005069 Example (for Greek, in UTF-8): *greek* >
5070 :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 +00005071< Example (exchanges meaning of z and y for commands): >
5072 :set langmap=zy,yz,ZY,YZ
5073<
5074 The 'langmap' option is a list of parts, separated with commas. Each
5075 part can be in one of two forms:
5076 1. A list of pairs. Each pair is a "from" character immediately
5077 followed by the "to" character. Examples: "aA", "aAbBcC".
5078 2. A list of "from" characters, a semi-colon and a list of "to"
5079 characters. Example: "abc;ABC"
5080 Example: "aA,fgh;FGH,cCdDeE"
5081 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005082 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083
5084 This will allow you to activate vim actions without having to switch
5085 back and forth between the languages. Your language characters will
5086 be understood as normal vim English characters (according to the
5087 langmap mappings) in the following cases:
5088 o Normal/Visual mode (commands, buffer/register names, user mappings)
5089 o Insert/Replace Mode: Register names after CTRL-R
5090 o Insert/Replace Mode: Mappings
5091 Characters entered in Command-line mode will NOT be affected by
5092 this option. Note that this option can be changed at any time
5093 allowing to switch between mappings for different languages/encodings.
5094 Use a mapping to avoid having to type it each time!
5095
5096 *'langmenu'* *'lm'*
5097'langmenu' 'lm' string (default "")
5098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 {only available when compiled with the |+menu| and
5100 |+multi_lang| features}
5101 Language to use for menu translation. Tells which file is loaded
5102 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005103 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104< (without the spaces). For example, to always use the Dutch menus, no
5105 matter what $LANG is set to: >
5106 :set langmenu=nl_NL.ISO_8859-1
5107< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005108 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 If your $LANG is set to a non-English language but you do want to use
5110 the English menus: >
5111 :set langmenu=none
5112< This option must be set before loading menus, switching on filetype
5113 detection or syntax highlighting. Once the menus are defined setting
5114 this option has no effect. But you could do this: >
5115 :source $VIMRUNTIME/delmenu.vim
5116 :set langmenu=de_DE.ISO_8859-1
5117 :source $VIMRUNTIME/menu.vim
5118< Warning: This deletes all menus that you defined yourself!
5119
Bram Moolenaard94464e2015-11-02 15:28:18 +01005120 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005121'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005122 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005123 {only available when compiled with the |+langmap|
5124 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005125 This is just like 'langremap' but with the value inverted. It only
5126 exists for backwards compatibility. When setting 'langremap' then
5127 'langnoremap' is set to the inverted value, and the other way around.
5128
5129 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005130'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005131 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005132 {only available when compiled with the |+langmap|
5133 feature}
5134 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005135 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005136 'langmap' disables some of your mappings, try resetting this option.
5137 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005138 that works for you to avoid mappings to break.
5139
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 *'laststatus'* *'ls'*
5141'laststatus' 'ls' number (default 1)
5142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 The value of this option influences when the last window will have a
5144 status line:
5145 0: never
5146 1: only if there are at least two windows
5147 2: always
5148 The screen looks nicer with a status line if you have several
5149 windows, but it takes another screen line. |status-line|
5150
5151 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5152'lazyredraw' 'lz' boolean (default off)
5153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 When this option is set, the screen will not be redrawn while
5155 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005156 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005158 This may occasionally cause display errors. It is only meant to be set
5159 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005160 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161
5162 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5163'linebreak' 'lbr' boolean (default off)
5164 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005165 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005167 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 than at the last character that fits on the screen. Unlike
5169 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005170 it only affects the way the file is displayed, not its contents.
5171 If 'breakindent' is set, line is visually indented. Then, the value
5172 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005173 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 Note that <Tab> characters after an <EOL> are mostly not displayed
5175 with the right amount of white space.
5176
5177 *'lines'* *E593*
5178'lines' number (default 24 or terminal height)
5179 global
5180 Number of lines of the Vim window.
5181 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005182 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 When Vim is running in the GUI or in a resizable window, setting this
5184 option will cause the window size to be changed. When you only want
5185 to use the size for the GUI, put the command in your |gvimrc| file.
5186 Vim limits the number of lines to what fits on the screen. You can
5187 use this command to get the tallest window possible: >
5188 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005189< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005190 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 When you set this option and Vim is unable to change the physical
5192 number of lines of the display, the display may be messed up.
5193
5194 *'linespace'* *'lsp'*
5195'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5196 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197 {only in the GUI}
5198 Number of pixel lines inserted between characters. Useful if the font
5199 uses the full character cell height, making lines touch each other.
5200 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005201 With some fonts there can be too much room between lines (to have
5202 space for ascents and descents). Then it makes sense to set
5203 'linespace' to a negative value. This may cause display problems
5204 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
5206 *'lisp'* *'nolisp'*
5207'lisp' boolean (default off)
5208 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 Lisp mode: When <Enter> is typed in insert mode set the indent for
5210 the next line to Lisp standards (well, sort of). Also happens with
5211 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5212 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5213 better. Also see 'lispwords'.
5214 The '-' character is included in keyword characters. Redefines the
5215 "=" operator to use this same indentation algorithm rather than
5216 calling an external program if 'equalprg' is empty.
5217 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005219 *'lispoptions'* *'lop'*
5220'lispoptions' 'lop' string (default "")
5221 local to buffer
5222 Comma-separated list of items that influence the Lisp indenting when
5223 enabled with the |'lisp'| option. Currently only one item is
5224 supported:
5225 expr:1 use 'indentexpr' for Lisp indenting when it is set
5226 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5227 Note that when using 'indentexpr' the `=` operator indents all the
5228 lines, otherwise the first line is not indented (Vi-compatible).
5229
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230 *'lispwords'* *'lw'*
5231'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005232 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005233 Comma-separated list of words that influence the Lisp indenting when
5234 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235
5236 *'list'* *'nolist'*
5237'list' boolean (default off)
5238 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005239 List mode: By default show tabs as CTRL-I is displayed, display $
5240 after end of line. Useful to see the difference between tabs and
5241 spaces and for trailing blanks. Further changed by the 'listchars'
5242 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005243
5244 The cursor is displayed at the start of the space a Tab character
5245 occupies, not at the end as usual in Normal mode. To get this cursor
5246 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005247 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005248<
5249 Note that list mode will also affect formatting (set with 'textwidth'
5250 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 changing the way tabs are displayed.
5252
5253 *'listchars'* *'lcs'*
5254'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005255 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005256 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005257 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005258 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259 eol:c Character to show at the end of each line. When
5260 omitted, there is no extra character at the end of the
5261 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005262 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005263 tab:xy[z] Two or three characters to be used to show a tab.
5264 The third character is optional.
5265
5266 tab:xy The 'x' is always used, then 'y' as many times as will
5267 fit. Thus "tab:>-" displays:
5268 >
5269 >-
5270 >--
5271 etc.
5272
5273 tab:xyz The 'z' is always used, then 'x' is prepended, and
5274 then 'y' is used as many times as will fit. Thus
5275 "tab:<->" displays:
5276 >
5277 <>
5278 <->
5279 <-->
5280 etc.
5281
5282 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005283 *lcs-space*
5284 space:c Character to show for a space. When omitted, spaces
5285 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005286 *lcs-multispace*
5287 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005288 One or more characters to use cyclically to show for
5289 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005290 setting, except for single spaces. When omitted, the
5291 "space" setting is used. For example,
5292 `:set listchars=multispace:---+` shows ten consecutive
5293 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005294 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005295 *lcs-lead*
5296 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005297 leading spaces are blank. Overrides the "space" and
5298 "multispace" settings for leading spaces. You can
5299 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005300 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005301< *lcs-leadmultispace*
5302 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005303 Like the |lcs-multispace| value, but for leading
5304 spaces only. Also overrides |lcs-lead| for leading
5305 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005306 `:set listchars=leadmultispace:---+` shows ten
5307 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005308 ---+---+--XXX ~
5309 Where "XXX" denotes the first non-blank characters in
5310 the line.
5311 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005312 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005313 trailing spaces are blank. Overrides the "space" and
5314 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005315 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 extends:c Character to show in the last column, when 'wrap' is
5317 off and the line continues beyond the right of the
5318 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005319 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005320 precedes:c Character to show in the first visible column of the
5321 physical line, when there is text preceding the
5322 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005323 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005324 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005325 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005326 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005327 nbsp:c Character to show for a non-breakable space character
5328 (0xA0 (160 decimal) and U+202F). Left blank when
5329 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005331 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005333 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005335 Each character can be specified as hex: >
5336 set listchars=eol:\\x24
5337 set listchars=eol:\\u21b5
5338 set listchars=eol:\\U000021b5
5339< Note that a double backslash is used. The number of hex characters
5340 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5341
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 Examples: >
5343 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005344 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 :set lcs=extends:>,precedes:<
5346< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005347 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5348 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005349 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350
5351 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5352'loadplugins' 'lpl' boolean (default on)
5353 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 When on the plugin scripts are loaded when starting up |load-plugins|.
5355 This option can be reset in your |vimrc| file to disable the loading
5356 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005357 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5358 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359
Bram Moolenaard94464e2015-11-02 15:28:18 +01005360 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005361'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005362 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005363 {only available when compiled with the |+lua/dyn|
5364 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005365 Specifies the name of the Lua shared library. The default is
5366 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005367 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005368 This option cannot be set from a |modeline| or in the |sandbox|, for
5369 security reasons.
5370
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005371 *'macatsui'* *'nomacatsui'*
5372'macatsui' boolean (default on)
5373 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005374 {not supported}
5375 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005376
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 *'magic'* *'nomagic'*
5378'magic' boolean (default on)
5379 global
5380 Changes the special characters that can be used in search patterns.
5381 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005382 WARNING: Switching this option off most likely breaks plugins! That
5383 is because many patterns assume it's on and will fail when it's off.
5384 Only switch it off when working with old Vi scripts. In any other
5385 situation write patterns that work when 'magic' is on. Include "\M"
5386 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005387 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5388 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389
5390 *'makeef'* *'mef'*
5391'makeef' 'mef' string (default: "")
5392 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393 {not available when compiled without the |+quickfix|
5394 feature}
5395 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5396 and the |:grep| command.
5397 When it is empty, an internally generated temp file will be used.
5398 When "##" is included, it is replaced by a number to make the name
5399 unique. This makes sure that the ":make" command doesn't overwrite an
5400 existing file.
5401 NOT used for the ":cf" command. See 'errorfile' for that.
5402 Environment variables are expanded |:set_env|.
5403 See |option-backslash| about including spaces and backslashes.
5404 This option cannot be set from a |modeline| or in the |sandbox|, for
5405 security reasons.
5406
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005407 *'makeencoding'* *'menc'*
5408'makeencoding' 'menc' string (default "")
5409 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005410 Encoding used for reading the output of external commands. When empty,
5411 encoding is not converted.
5412 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5413 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5414 and `:laddfile`.
5415
5416 This would be mostly useful when you use MS-Windows and set 'encoding'
5417 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5418 'makeencoding' to "char" has the same effect as setting to the system
5419 locale encoding. Example: >
5420 :set encoding=utf-8
5421 :set makeencoding=char " system locale is used
5422<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 *'makeprg'* *'mp'*
5424'makeprg' 'mp' string (default "make", VMS: "MMS")
5425 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005426 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005427 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5428 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005429 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005430 Environment variables are expanded |:set_env|. See |option-backslash|
5431 about including spaces and backslashes.
5432 Note that a '|' must be escaped twice: once for ":set" and once for
5433 the interpretation of a command. When you use a filter called
5434 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 :set makeprg=gmake\ \\\|\ myfilter
5436< The placeholder "$*" can be given (even multiple times) to specify
5437 where the arguments will be included, for example: >
5438 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5439< This option cannot be set from a |modeline| or in the |sandbox|, for
5440 security reasons.
5441
5442 *'matchpairs'* *'mps'*
5443'matchpairs' 'mps' string (default "(:),{:},[:]")
5444 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005446 other.
5447 Only character pairs are allowed that are different, thus you cannot
5448 jump between two double quotes.
5449 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005450 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005451 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 :set mps+=<:>
5453
5454< A more exotic example, to jump between the '=' and ';' in an
5455 assignment, useful for languages like C and Java: >
5456 :au FileType c,cpp,java set mps+==:;
5457
5458< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005459 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460
5461 *'matchtime'* *'mat'*
5462'matchtime' 'mat' number (default 5)
5463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 Tenths of a second to show the matching paren, when 'showmatch' is
5465 set. Note that this is not in milliseconds, like other options that
5466 set a time. This is to be compatible with Nvi.
5467
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005468 *'maxcombine'* *'mco'*
5469'maxcombine' 'mco' number (default 2)
5470 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005471 The maximum number of combining characters supported for displaying.
5472 Only used when 'encoding' is "utf-8".
5473 The default is OK for most languages. Hebrew may require 4.
5474 Maximum value is 6.
5475 Even when this option is set to 2 you can still edit text with more
5476 combining characters, you just can't see them. Use |g8| or |ga|.
5477 See |mbyte-combining|.
5478
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 *'maxfuncdepth'* *'mfd'*
5480'maxfuncdepth' 'mfd' number (default 100)
5481 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005482 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005483 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 Maximum depth of function calls for user functions. This normally
5485 catches endless recursion. When using a recursive function with
5486 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5487 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005488 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005489 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005491 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492
5493 *'maxmapdepth'* *'mmd'* *E223*
5494'maxmapdepth' 'mmd' number (default 1000)
5495 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 Maximum number of times a mapping is done without resulting in a
5497 character to be used. This normally catches endless mappings, like
5498 ":map x y" with ":map y x". It still does not catch ":map g wg",
5499 because the 'w' is used before the next mapping is done. See also
5500 |key-mapping|.
5501
5502 *'maxmem'* *'mm'*
5503'maxmem' 'mm' number (default between 256 to 5120 (system
5504 dependent) or half the amount of memory
5505 available)
5506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5508 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005509 other memory to be freed.
5510 The maximum usable value is about 2000000. Use this to work without a
5511 limit.
5512 The value is ignored when 'swapfile' is off.
5513 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005515 *'maxmempattern'* *'mmp'*
5516'maxmempattern' 'mmp' number (default 1000)
5517 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005518 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005519 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005520 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005521 When Vim runs into the limit it gives an error message and mostly
5522 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005523 Running into the limit often means that the pattern is very
5524 inefficient or too complex. This may already happen with the pattern
5525 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005526 Might also happen on redraw, when syntax rules try to match a complex
5527 text structure.
5528 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5529 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005530
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 *'maxmemtot'* *'mmt'*
5532'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5533 dependent) or half the amount of memory
5534 available)
5535 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005536 Maximum amount of memory in Kbyte to use for all buffers together.
5537 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005538 without a limit.
5539 On 64 bit machines higher values might work. But hey, do you really
5540 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005541 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005542 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005543 Buffers with 'swapfile' off still count to the total amount of memory
5544 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005545 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546
5547 *'menuitems'* *'mis'*
5548'menuitems' 'mis' number (default 25)
5549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 {not available when compiled without the |+menu|
5551 feature}
5552 Maximum number of items to use in a menu. Used for menus that are
5553 generated from a list of items, e.g., the Buffers menu. Changing this
5554 option has no direct effect, the menu must be refreshed first.
5555
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005556 *'mkspellmem'* *'msm'*
5557'mkspellmem' 'msm' string (default "460000,2000,500")
5558 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005559 {not available when compiled without the |+syntax|
5560 feature}
5561 Parameters for |:mkspell|. This tunes when to start compressing the
5562 word tree. Compression can be slow when there are many words, but
5563 it's needed to avoid running out of memory. The amount of memory used
5564 per word depends very much on how similar the words are, that's why
5565 this tuning is complicated.
5566
5567 There are three numbers, separated by commas:
5568 {start},{inc},{added}
5569
5570 For most languages the uncompressed word tree fits in memory. {start}
5571 gives the amount of memory in Kbyte that can be used before any
5572 compression is done. It should be a bit smaller than the amount of
5573 memory that is available to Vim.
5574
5575 When going over the {start} limit the {inc} number specifies the
5576 amount of memory in Kbyte that can be allocated before another
5577 compression is done. A low number means compression is done after
5578 less words are added, which is slow. A high number means more memory
5579 will be allocated.
5580
5581 After doing compression, {added} times 1024 words can be added before
5582 the {inc} limit is ignored and compression is done when any extra
5583 amount of memory is needed. A low number means there is a smaller
5584 chance of hitting the {inc} limit, less memory is used but it's
5585 slower.
5586
5587 The languages for which these numbers are important are Italian and
5588 Hungarian. The default works for when you have about 512 Mbyte. If
5589 you have 1 Gbyte you could use: >
5590 :set mkspellmem=900000,3000,800
5591< If you have less than 512 Mbyte |:mkspell| may fail for some
5592 languages, no matter what you set 'mkspellmem' to.
5593
dkearns8ebdbc92023-10-29 06:26:19 +11005594 This option cannot be set from a |modeline| or in the |sandbox|, for
5595 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005596
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005598'modeline' 'ml' boolean (Vim default: on (off for root),
5599 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005601 If 'modeline' is on 'modelines' gives the number of lines that is
5602 checked for set commands. If 'modeline' is off or 'modelines' is zero
5603 no lines are checked. See |modeline|.
5604
5605 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5606'modelineexpr' 'mle' boolean (default: off)
5607 global
5608 When on allow some options that are an expression to be set in the
5609 modeline. Check the option for whether it is affected by
5610 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005611 This option cannot be set from a |modeline| or in the |sandbox|, for
5612 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005613
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 *'modelines'* *'mls'*
5615'modelines' 'mls' number (default 5)
5616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 If 'modeline' is on 'modelines' gives the number of lines that is
5618 checked for set commands. If 'modeline' is off or 'modelines' is zero
5619 no lines are checked. See |modeline|.
5620 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5621 set and to the Vim default value when 'compatible' is reset.
5622
5623 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005624 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625'modifiable' 'ma' boolean (default on)
5626 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 When off the buffer contents cannot be changed. The 'fileformat' and
5628 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005629 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630
5631 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5632'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005633 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 When on, the buffer is considered to be modified. This option is set
5635 when:
5636 1. A change was made to the text since it was last written. Using the
5637 |undo| command to go back to the original text will reset the
5638 option. But undoing changes that were made before writing the
5639 buffer will set the option again, since the text is different from
5640 when it was written.
5641 2. 'fileformat' or 'fileencoding' is different from its original
5642 value. The original value is set when the buffer is read or
5643 written. A ":set nomodified" command also resets the original
5644 values to the current values and the 'modified' option will be
5645 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005646 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005647 This option is not set when a change is made to the buffer as the
5648 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5649 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5650 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5652 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005653 Note that the text may actually be the same, e.g. 'modified' is set
5654 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655
5656 *'more'* *'nomore'*
5657'more' boolean (Vim default: on, Vi default: off)
5658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 When on, listings pause when the whole screen is filled. You will get
5660 the |more-prompt|. When this option is off there are no pauses, the
5661 listing continues until finished.
5662 NOTE: This option is set to the Vi default value when 'compatible' is
5663 set and to the Vim default value when 'compatible' is reset.
5664
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005665 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005666'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005667 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005669 Enable the use of the mouse. Works for most terminals (xterm, Win32
5670 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5671 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5672 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005673 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 v Visual mode
5675 i Insert mode
5676 c Command-line mode
5677 h all previous modes when editing a help file
5678 a all previous modes
5679 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005680 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005682< If your terminal can't overrule the mouse events going to the
5683 application, use: >
5684 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005685< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005686 back to Vim using the mouse events.
5687 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5688 "xterm".
5689
5690 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 modeless selection. This doesn't move the text cursor.
5692
5693 See |mouse-using|. Also see |'clipboard'|.
5694
5695 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005696 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 the mouse buttons can still be used by keeping the shift key pressed.
5698 Also see the 'clipboard' option.
5699
5700 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5701'mousefocus' 'mousef' boolean (default off)
5702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 {only works in the GUI}
5704 The window that the mouse pointer is on is automatically activated.
5705 When changing the window layout or window focus in another way, the
5706 mouse pointer is moved to the window with keyboard focus. Off is the
5707 default because it makes using the pull down menus a little goofy, as
5708 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005709 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005710 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711
5712 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5713'mousehide' 'mh' boolean (default on)
5714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 {only works in the GUI}
5716 When on, the mouse pointer is hidden when characters are typed.
5717 The mouse pointer is restored when the mouse is moved.
5718
5719 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005720'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 Sets the model to use for the mouse. The name mostly specifies what
5723 the right mouse button is used for:
5724 extend Right mouse button extends a selection. This works
5725 like in an xterm.
5726 popup Right mouse button pops up a menu. The shifted left
5727 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005728 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 popup_setpos Like "popup", but the cursor will be moved to the
5730 position where the mouse was clicked, and thus the
5731 selected operation will act upon the clicked object.
5732 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005733 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 course, that right clicking outside a selection will
5735 end Visual mode.
5736 Overview of what button does what for each model:
5737 mouse extend popup(_setpos) ~
5738 left click place cursor place cursor
5739 left drag start selection start selection
5740 shift-left search word extend selection
5741 right click extend selection popup menu (place cursor)
5742 right drag extend selection -
5743 middle click paste paste
5744
5745 In the "popup" model the right mouse button produces a pop-up menu.
5746 You need to define this first, see |popup-menu|.
5747
5748 Note that you can further refine the meaning of buttons with mappings.
5749 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5750 selection (because that's handled in the GUI code directly).
5751
5752 The 'mousemodel' option is set by the |:behave| command.
5753
h_east59858792023-10-25 22:47:05 +09005754 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005755'mousemoveevent' 'mousemev' boolean (default off)
5756 global
5757 {only works in the GUI}
5758 When on, mouse move events are delivered to the input queue and are
5759 available for mapping. The default, off, avoids the mouse movement
5760 overhead except when needed. See |gui-mouse-mapping|.
5761 Warning: Setting this option can make pending mappings to be aborted
5762 when the mouse is moved.
5763 Currently only works in the GUI, may be made to work in a terminal
5764 later.
5765
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005767'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5768 vs:leftright,vd:lrsizing,m:no,
5769 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 {only available when compiled with the |+mouseshape|
5772 feature}
5773 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005774 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 like used for 'guicursor'. Each part consist of a mode/location-list
5776 and an argument-list:
5777 mode-list:shape,mode-list:shape,..
5778 The mode-list is a dash separated list of these modes/locations:
5779 In a normal window: ~
5780 n Normal mode
5781 v Visual mode
5782 ve Visual mode with 'selection' "exclusive" (same as 'v',
5783 if not specified)
5784 o Operator-pending mode
5785 i Insert mode
5786 r Replace mode
5787
5788 Others: ~
5789 c appending to the command-line
5790 ci inserting in the command-line
5791 cr replacing in the command-line
5792 m at the 'Hit ENTER' or 'More' prompts
5793 ml idem, but cursor in the last line
5794 e any mode, pointer below last window
5795 s any mode, pointer on a status line
5796 sd any mode, while dragging a status line
5797 vs any mode, pointer on a vertical separator line
5798 vd any mode, while dragging a vertical separator line
5799 a everywhere
5800
5801 The shape is one of the following:
5802 avail name looks like ~
5803 w x arrow Normal mouse pointer
5804 w x blank no pointer at all (use with care!)
5805 w x beam I-beam
5806 w x updown up-down sizing arrows
5807 w x leftright left-right sizing arrows
5808 w x busy The system's usual busy pointer
5809 w x no The system's usual 'no input' pointer
5810 x udsizing indicates up-down resizing
5811 x lrsizing indicates left-right resizing
5812 x crosshair like a big thin +
5813 x hand1 black hand
5814 x hand2 white hand
5815 x pencil what you write with
5816 x question big ?
5817 x rightup-arrow arrow pointing right-up
5818 w x up-arrow arrow pointing up
5819 x <number> any X11 pointer number (see X11/cursorfont.h)
5820
5821 The "avail" column contains a 'w' if the shape is available for Win32,
5822 x for X11.
5823 Any modes not specified or shapes not available use the normal mouse
5824 pointer.
5825
5826 Example: >
5827 :set mouseshape=s:udsizing,m:no
5828< will make the mouse turn to a sizing arrow over the status lines and
5829 indicate no input when the hit-enter prompt is displayed (since
5830 clicking the mouse has no effect in this state.)
5831
5832 *'mousetime'* *'mouset'*
5833'mousetime' 'mouset' number (default 500)
5834 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005835 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 time in msec between two mouse clicks for the second click to be
5837 recognized as a multi click.
5838
laburnumT3f7855a2023-12-05 18:37:03 +01005839 *'mzquantum'* *'mzq'*
5840'mzquantum' 'mzq' number (default 100)
5841 global
5842 {not available when compiled without the |+mzscheme|
5843 feature}
5844 The number of milliseconds between polls for MzScheme threads.
5845 Negative or zero value means no thread scheduling.
5846 NOTE: This option is set to the Vim default value when 'compatible'
5847 is reset.
5848
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005849 *'mzschemedll'*
5850'mzschemedll' string (default depends on the build)
5851 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005852 {only available when compiled with the |+mzscheme/dyn|
5853 feature}
5854 Specifies the name of the MzScheme shared library. The default is
5855 DYNAMIC_MZSCH_DLL which was specified at compile time.
5856 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005857 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005858 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005859 This option cannot be set from a |modeline| or in the |sandbox|, for
5860 security reasons.
5861
5862 *'mzschemegcdll'*
5863'mzschemegcdll' string (default depends on the build)
5864 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005865 {only available when compiled with the |+mzscheme/dyn|
5866 feature}
5867 Specifies the name of the MzScheme GC shared library. The default is
5868 DYNAMIC_MZGC_DLL which was specified at compile time.
5869 The value can be equal to 'mzschemedll' if it includes the GC code.
5870 Environment variables are expanded |:set_env|.
5871 This option cannot be set from a |modeline| or in the |sandbox|, for
5872 security reasons.
5873
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005875'nrformats' 'nf' string (default "bin,octal,hex",
5876 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 This defines what bases Vim will consider for numbers when using the
5879 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5880 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005881 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005883 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005884 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005886 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887 considered to be hexadecimal. Example: Using CTRL-X on
5888 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005889 bin If included, numbers starting with "0b" or "0B" will be
5890 considered to be binary. Example: Using CTRL-X on
5891 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005892 unsigned If included, numbers are recognized as unsigned. Thus a
5893 leading dash or negative sign won't be considered as part of
5894 the number. Examples:
5895 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5896 (without "unsigned" it would become "9-2021").
5897 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5898 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005899 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5900 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 Numbers which simply begin with a digit in the range 1-9 are always
5902 considered decimal. This also happens for numbers that are not
5903 recognized as octal or hex.
5904
5905 *'number'* *'nu'* *'nonumber'* *'nonu'*
5906'number' 'nu' boolean (default off)
5907 local to window
5908 Print the line number in front of each line. When the 'n' option is
5909 excluded from 'cpoptions' a wrapped line will not use the column of
5910 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005911 The 'numberwidth' option can be used to set the room used for the line
5912 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 When a long, wrapped line doesn't start with the first character, '-'
5914 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005915 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5916 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005917 *number_relativenumber*
5918 The 'relativenumber' option changes the displayed number to be
5919 relative to the cursor. Together with 'number' there are these
5920 four combinations (cursor in line 3):
5921
Bram Moolenaar3848e002016-03-19 18:42:29 +01005922 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005923 'nornu' 'nornu' 'rnu' 'rnu'
5924
5925 |apple | 1 apple | 2 apple | 2 apple
5926 |pear | 2 pear | 1 pear | 1 pear
5927 |nobody | 3 nobody | 0 nobody |3 nobody
5928 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005930 *'numberwidth'* *'nuw'*
5931'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5932 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005933 {only available when compiled with the |+linebreak|
5934 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005935 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005936 when the 'number' or 'relativenumber' option is set or printing lines
5937 with a line number. Since one space is always between the number and
5938 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005939 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005940 fit the highest line number in the buffer respectively the number of
5941 rows in the window, depending on whether 'number' or 'relativenumber'
5942 is set. Thus with the Vim default of 4 there is room for a line number
5943 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005944 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005945 NOTE: This option is set to the Vi default value when 'compatible' is
5946 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005947
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005948 *'omnifunc'* *'ofu'*
5949'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005950 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005951 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005952 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005953 This option specifies a function to be used for Insert mode omni
5954 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005955 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005956 invoked and what it should return. The value can be the name of a
5957 function, a |lambda| or a |Funcref|. See |option-value-function| for
5958 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005959 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005960 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005961 This option cannot be set from a |modeline| or in the |sandbox|, for
5962 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005963
Bram Moolenaar02467872007-05-06 13:22:01 +00005964 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005965'opendevice' 'odev' boolean (default off)
5966 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005967 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005968 Enable reading and writing from devices. This may get Vim stuck on a
5969 device that can be opened but doesn't actually do the I/O. Therefore
5970 it is off by default.
5971 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5972 result in editing a device.
5973
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005974 *'operatorfunc'* *'opfunc'*
5975'operatorfunc' 'opfunc' string (default: empty)
5976 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005977 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005978 See |:map-operator| for more info and an example. The value can be
5979 the name of a function, a |lambda| or a |Funcref|. See
5980 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005981
5982 This option cannot be set from a |modeline| or in the |sandbox|, for
5983 security reasons.
5984
Bram Moolenaar251e1912011-06-19 05:09:16 +02005985 *'osfiletype'* *'oft'*
5986'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005988 This option was supported on RISC OS, which has been removed.
5989
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005990 *'packpath'* *'pp'*
5991'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005992 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11005993 This option cannot be set from a |modeline| or in the |sandbox|, for
5994 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005995
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005997'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 global
5999 Specifies the nroff macros that separate paragraphs. These are pairs
6000 of two letters (see |object-motions|).
6001
6002 *'paste'* *'nopaste'*
6003'paste' boolean (default off)
6004 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006005 Put Vim in Paste mode. This is useful if you want to cut or copy
6006 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 unexpected effects.
6008 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006009 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 knows about pasting and will mostly do the right thing without 'paste'
6011 being set. The same is true for a terminal where Vim handles the
6012 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006013 This option is reset when starting the GUI. Thus if you set it in
6014 your .vimrc it will work in a terminal, but not in the GUI. Setting
6015 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6016 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 When the 'paste' option is switched on (also when it was already on):
6018 - mapping in Insert mode and Command-line mode is disabled
6019 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006021 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006022 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 - 'revins' is reset
6024 - 'ruler' is reset
6025 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006026 - 'smarttab' is reset
6027 - 'softtabstop' is set to 0
6028 - 'textwidth' is set to 0
6029 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006030 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006033 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006034 - 'indentexpr'
6035 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006036 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 NOTE: When you start editing another file while the 'paste' option is
6038 on, settings from the modelines or autocommands may change the
6039 settings again, causing trouble when pasting text. You might want to
6040 set the 'paste' option again.
6041 When the 'paste' option is reset the mentioned options are restored to
6042 the value before the moment 'paste' was switched from off to on.
6043 Resetting 'paste' before ever setting it does not have any effect.
6044 Since mapping doesn't work while 'paste' is active, you need to use
6045 the 'pastetoggle' option to toggle the 'paste' option with some key.
6046
6047 *'pastetoggle'* *'pt'*
6048'pastetoggle' 'pt' string (default "")
6049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 When non-empty, specifies the key sequence that toggles the 'paste'
6051 option. This is like specifying a mapping: >
6052 :map {keys} :set invpaste<CR>
6053< Where {keys} is the value of 'pastetoggle'.
6054 The difference is that it will work even when 'paste' is set.
6055 'pastetoggle' works in Insert mode and Normal mode, but not in
6056 Command-line mode.
6057 Mappings are checked first, thus overrule 'pastetoggle'. However,
6058 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6059 this: >
6060 :map <F10> :set paste<CR>
6061 :map <F11> :set nopaste<CR>
6062 :imap <F10> <C-O>:set paste<CR>
6063 :imap <F11> <nop>
6064 :set pastetoggle=<F11>
6065< This will make <F10> start paste mode and <F11> stop paste mode.
6066 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6067 mode everything is inserted literally, except the 'pastetoggle' key
6068 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006069 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070
6071 *'pex'* *'patchexpr'*
6072'patchexpr' 'pex' string (default "")
6073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 {not available when compiled without the |+diff|
6075 feature}
6076 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006077 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006078 This option cannot be set from a |modeline| or in the |sandbox|, for
6079 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006080
Bram Moolenaardbc28022014-07-26 13:40:44 +02006081 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082'patchmode' 'pm' string (default "")
6083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 When non-empty the oldest version of a file is kept. This can be used
6085 to keep the original version of a file if you are changing files in a
6086 source distribution. Only the first time that a file is written a
6087 copy of the original file will be kept. The name of the copy is the
6088 name of the original file with the string in the 'patchmode' option
6089 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006090 ".orig" or ".org". 'backupdir' must not be empty for this to work
6091 (Detail: The backup file is renamed to the patchmode file after the
6092 new file has been successfully written, that's why it must be possible
6093 to write a backup file). If there was no file to be backed up, an
6094 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 When the 'backupskip' pattern matches, a patchmode file is not made.
6096 Using 'patchmode' for compressed files appends the extension at the
6097 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6098 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006099 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006101 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 other systems: ".,,")
6104 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006106 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6107 provided that the file being searched for has a relative path (not
6108 starting with "/", "./" or "../"). The directories in the 'path'
6109 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110 - Use commas to separate directory names: >
6111 :set path=.,/usr/local/include,/usr/include
6112< - Spaces can also be used to separate directory names (for backwards
6113 compatibility with version 3.0). To have a space in a directory
6114 name, precede it with an extra backslash, and escape the space: >
6115 :set path=.,/dir/with\\\ space
6116< - To include a comma in a directory name precede it with an extra
6117 backslash: >
6118 :set path=.,/dir/with\\,comma
6119< - To search relative to the directory of the current file, use: >
6120 :set path=.
6121< - To search in the current directory use an empty string between two
6122 commas: >
6123 :set path=,,
6124< - A directory name may end in a ':' or '/'.
6125 - Environment variables are expanded |:set_env|.
6126 - When using |netrw.vim| URLs can be used. For example, adding
6127 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006128 - Search upwards and downwards in a directory tree using "*", "**" and
6129 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130 - Careful with '\' characters, type two to get one in the option: >
6131 :set path=.,c:\\include
6132< Or just use '/' instead: >
6133 :set path=.,c:/include
6134< Don't forget "." or files won't even be found in the same directory as
6135 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006136 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 it is something like 256 or 1024 characters.
6138 You can check if all the include files are found, using the value of
6139 'path', see |:checkpath|.
6140 The use of |:set+=| and |:set-=| is preferred when adding or removing
6141 directories from the list. This avoids problems when a future version
6142 uses another default. To remove the current directory use: >
6143 :set path-=
6144< To add the current directory use: >
6145 :set path+=
6146< To use an environment variable, you probably need to replace the
6147 separator. Here is an example to append $INCL, in which directory
6148 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006149 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150< Replace the ';' with a ':' or whatever separator is used. Note that
6151 this doesn't work when $INCL contains a comma or white space.
6152
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006153 *'perldll'*
6154'perldll' string (default depends on the build)
6155 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006156 {only available when compiled with the |+perl/dyn|
6157 feature}
6158 Specifies the name of the Perl shared library. The default is
6159 DYNAMIC_PERL_DLL, which was specified at compile time.
6160 Environment variables are expanded |:set_env|.
6161 This option cannot be set from a |modeline| or in the |sandbox|, for
6162 security reasons.
6163
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6165'preserveindent' 'pi' boolean (default off)
6166 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 When changing the indent of the current line, preserve as much of the
6168 indent structure as possible. Normally the indent is replaced by a
6169 series of tabs followed by spaces as required (unless |'expandtab'| is
6170 enabled, in which case only spaces are used). Enabling this option
6171 means the indent will preserve as many existing characters as possible
6172 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006173 'expandtab' does not apply to the preserved white space, a Tab remains
6174 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 NOTE: When using ">>" multiple times the resulting indent is a mix of
6176 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006177 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 Also see 'copyindent'.
6179 Use |:retab| to clean up white space.
6180
6181 *'previewheight'* *'pvh'*
6182'previewheight' 'pvh' number (default 12)
6183 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006184 {not available when compiled without the |+quickfix|
6185 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006187 commands. Used for |CTRL-W_}| when no count is given. Not used when
6188 'previewpopup' is set.
6189
6190 *'previewpopup'* *'pvp'*
6191'previewpopup' 'pvp' string (default empty)
6192 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006193 {not available when compiled without the |+textprop|
6194 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006195 When not empty a popup window is used for commands that would open a
6196 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006197 Not used for the insert completion info, add "popup" to
6198 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199
6200 *'previewwindow'* *'nopreviewwindow'*
6201 *'pvw'* *'nopvw'* *E590*
6202'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006203 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006204 {not available when compiled without the |+quickfix|
6205 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006206 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207 set. It's normally not set directly, but by using one of the commands
6208 |:ptag|, |:pedit|, etc.
6209
6210 *'printdevice'* *'pdev'*
6211'printdevice' 'pdev' string (default empty)
6212 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 {only available when compiled with the |+printer|
6214 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006215 The name of the printer to be used for |:hardcopy|.
6216 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006217 This option cannot be set from a |modeline| or in the |sandbox|, for
6218 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219
Bram Moolenaar8299df92004-07-10 09:47:34 +00006220 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006221'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 {only available when compiled with the |+printer|
6224 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006225 Sets the character encoding used when printing.
6226 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227
6228 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006229'printexpr' 'pexpr' string (default: see below)
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 Expression used to print the PostScript produced with |:hardcopy|.
6234 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006235 This option cannot be set from a |modeline| or in the |sandbox|, for
6236 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237
Bram Moolenaar8299df92004-07-10 09:47:34 +00006238 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239'printfont' 'pfn' string (default "courier")
6240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 {only available when compiled with the |+printer|
6242 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006243 The name of the font that will be used for |:hardcopy|.
6244 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245
6246 *'printheader'* *'pheader'*
6247'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
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 format of the header produced in |:hardcopy| output.
6252 See |pheader-option|.
6253
6254 *'printmbcharset'* *'pmbcs'*
6255'printmbcharset' 'pmbcs' string (default "")
6256 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006257 {only available when compiled with the |+printer|
6258 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006259 The CJK character set to be used for CJK output from |:hardcopy|.
6260 See |pmbcs-option|.
6261
6262 *'printmbfont'* *'pmbfn'*
6263'printmbfont' 'pmbfn' 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 List of font names to be used for CJK output from |:hardcopy|.
6268 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269
6270 *'printoptions'* *'popt'*
6271'printoptions' 'popt' string (default "")
6272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006274 List of items that control the format of the output of |:hardcopy|.
6275 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006277 *'prompt'* *'noprompt'*
6278'prompt' boolean (default on)
6279 global
6280 When on a ":" prompt is used in Ex mode.
6281
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006282 *'pumheight'* *'ph'*
6283'pumheight' 'ph' number (default 0)
6284 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006285 Determines the maximum number of items to show in the popup menu for
6286 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006287 |ins-completion-menu|.
6288
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006289 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006290'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006291 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006292 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006293 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006294
Bram Moolenaard94464e2015-11-02 15:28:18 +01006295 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006296'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006297 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006298 {only available when compiled with the |+python/dyn|
6299 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006300 Specifies the name of the Python 2.x shared library. The default is
6301 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006302 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006303 This option cannot be set from a |modeline| or in the |sandbox|, for
6304 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006305
Bram Moolenaar94073162018-01-31 21:49:05 +01006306 *'pythonhome'*
6307'pythonhome' string (default "")
6308 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006309 {only available when compiled with the |+python/dyn|
6310 feature}
6311 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6312 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6313 which was specified at compile time, will be used for the Python 2.x
6314 home directory.
6315 Environment variables are expanded |:set_env|.
6316 This option cannot be set from a |modeline| or in the |sandbox|, for
6317 security reasons.
6318
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006319 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006320'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006321 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006322 {only available when compiled with the |+python3/dyn|
6323 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006324 Specifies the name of the Python 3 shared library. The default is
6325 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006326 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006327 This option cannot be set from a |modeline| or in the |sandbox|, for
6328 security reasons.
6329
Bram Moolenaar94073162018-01-31 21:49:05 +01006330 *'pythonthreehome'*
6331'pythonthreehome' string (default "")
6332 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006333 {only available when compiled with the |+python3/dyn|
6334 feature}
6335 Specifies the name of the Python 3 home directory. When
6336 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6337 PYTHON3_HOME, which was specified at compile time, will be used for
6338 the Python 3 home directory.
6339 Environment variables are expanded |:set_env|.
6340 This option cannot be set from a |modeline| or in the |sandbox|, for
6341 security reasons.
6342
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006343 *'pyxversion'* *'pyx'*
6344'pyxversion' 'pyx' number (default depends on the build)
6345 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006346 {only available when compiled with the |+python| or
6347 the |+python3| feature}
6348 Specifies the python version used for pyx* functions and commands
6349 |python_x|. The default value is as follows:
6350
6351 Compiled with Default ~
6352 |+python| and |+python3| 0
6353 only |+python| 2
6354 only |+python3| 3
6355
6356 Available values are 0, 2 and 3.
6357 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6358 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6359 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6360 to 2 if Python 2 is available.
6361 See also: |has-pythonx|
6362
6363 If Vim is compiled with only |+python| or |+python3| setting
6364 'pyxversion' has no effect. The pyx* functions and commands are
6365 always the same as the compiled version.
6366
6367 This option cannot be set from a |modeline| or in the |sandbox|, for
6368 security reasons.
6369
Bram Moolenaar858ba062020-05-31 23:11:59 +02006370 *'quickfixtextfunc'* *'qftf'*
6371'quickfixtextfunc' 'qftf' string (default "")
6372 global
6373 {only available when compiled with the |+quickfix|
6374 feature}
6375 This option specifies a function to be used to get the text to display
6376 in the quickfix and location list windows. This can be used to
6377 customize the information displayed in the quickfix or location window
6378 for each entry in the corresponding quickfix or location list. See
6379 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006380 function and an example. The value can be the name of a function, a
6381 |lambda| or a |Funcref|. See |option-value-function| for more
6382 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006383
6384 This option cannot be set from a |modeline| or in the |sandbox|, for
6385 security reasons.
6386
Bram Moolenaar677ee682005-01-27 14:41:15 +00006387 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006388'quoteescape' 'qe' string (default "\")
6389 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006390 The characters that are used to escape quotes in a string. Used for
6391 objects like a', a" and a` |a'|.
6392 When one of the characters in this option is found inside a string,
6393 the following character will be skipped. The default value makes the
6394 text "foo\"bar\\" considered to be one string.
6395
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6397'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006398 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 If on, writes fail unless you use a '!'. Protects you from
6400 accidentally overwriting a file. Default on when Vim is started
6401 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006402 When using ":w!" the 'readonly' option is reset for the current
6403 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006404 When using the ":view" command the 'readonly' option is set for the
6405 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006406 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006408 *'redrawtime'* *'rdt'*
6409'redrawtime' 'rdt' number (default 2000)
6410 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006411 {only available when compiled with the |+reltime|
6412 feature}
6413 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006414 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006415 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006416 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006417 matches will be highlighted.
6418 For syntax highlighting the time applies per window. When over the
6419 limit syntax highlighting is disabled until |CTRL-L| is used.
6420 This is used to avoid that Vim hangs when using a very complicated
6421 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006422
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006423 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006424'regexpengine' 're' number (default 0)
6425 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006426 This selects the default regexp engine. |two-engines|
6427 The possible values are:
6428 0 automatic selection
6429 1 old engine
6430 2 NFA engine
6431 Note that when using the NFA engine and the pattern contains something
6432 that is not supported the pattern will not match. This is only useful
6433 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006434 Using automatic selection enables Vim to switch the engine, if the
6435 default engine becomes too costly. E.g., when the NFA engine uses too
6436 many states. This should prevent Vim from hanging on a combination of
6437 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006438
Bram Moolenaar64486672010-05-16 15:46:46 +02006439 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6440'relativenumber' 'rnu' boolean (default off)
6441 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006442 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006443 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006444 precede some vertical motion commands (e.g. j k + -) with, without
6445 having to calculate it yourself. Especially useful in combination with
6446 other commands (e.g. y d c < > gq gw =).
6447 When the 'n' option is excluded from 'cpoptions' a wrapped
6448 line will not use the column of line numbers (this is the default when
6449 'compatible' isn't set).
6450 The 'numberwidth' option can be used to set the room used for the line
6451 number.
6452 When a long, wrapped line doesn't start with the first character, '-'
6453 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006454 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6455 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006456
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006457 The number in front of the cursor line also depends on the value of
6458 'number', see |number_relativenumber| for all combinations of the two
6459 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006460
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 *'remap'* *'noremap'*
6462'remap' boolean (default on)
6463 global
6464 Allows for mappings to work recursively. If you do not want this for
6465 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006466 NOTE: To avoid portability problems with Vim scripts, always keep
6467 this option at the default "on". Only switch it off when working with
6468 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469
zeertzjqd086b8f2024-02-25 15:42:52 +08006470 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006471'renderoptions' 'rop' string (default: empty)
6472 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006473 {only available when compiled with GUI and DIRECTX on
6474 MS-Windows}
6475 Select a text renderer and set its options. The options depend on the
6476 renderer.
6477
6478 Syntax: >
6479 set rop=type:{renderer}(,{name}:{value})*
6480<
6481 Currently, only one optional renderer is available.
6482
6483 render behavior ~
6484 directx Vim will draw text using DirectX (DirectWrite). It makes
6485 drawn glyphs more beautiful than default GDI.
6486 It requires 'encoding' is "utf-8", and only works on
6487 MS-Windows Vista or newer version.
6488
6489 Options:
6490 name meaning type value ~
6491 gamma gamma float 1.0 - 2.2 (maybe)
6492 contrast enhancedContrast float (unknown)
6493 level clearTypeLevel float (unknown)
6494 geom pixelGeometry int 0 - 2 (see below)
6495 renmode renderingMode int 0 - 6 (see below)
6496 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006497 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006498
Bram Moolenaar92467d32017-12-05 13:22:16 +01006499 See this URL for detail (except for scrlines):
6500 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006501
6502 For geom: structure of a device pixel.
6503 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6504 1 - DWRITE_PIXEL_GEOMETRY_RGB
6505 2 - DWRITE_PIXEL_GEOMETRY_BGR
6506
6507 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006508 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006509
6510 For renmode: method of rendering glyphs.
6511 0 - DWRITE_RENDERING_MODE_DEFAULT
6512 1 - DWRITE_RENDERING_MODE_ALIASED
6513 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6514 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6515 4 - DWRITE_RENDERING_MODE_NATURAL
6516 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6517 6 - DWRITE_RENDERING_MODE_OUTLINE
6518
6519 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006520 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006521
6522 For taamode: antialiasing mode used for drawing text.
6523 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6524 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6525 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6526 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6527
6528 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006529 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6530
Bram Moolenaara338adc2018-01-31 20:51:47 +01006531 For scrlines:
6532 This was used for optimizing scrolling behavior, however this
6533 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006534
6535 Example: >
6536 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006537 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006538 set rop=type:directx
6539<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006540 If select a raster font (Courier, Terminal or FixedSys which
6541 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006542 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006543
6544 NOTE: It is known that some fonts and options combination
6545 causes trouble on drawing glyphs.
6546
Bram Moolenaar92467d32017-12-05 13:22:16 +01006547 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006548 special made fonts (True-Type fonts which includes only
6549 bitmap glyphs).
6550 - 'taamode:3' will not work with some vector fonts.
6551
6552 NOTE: With this option, you can display colored emoji
6553 (emoticon) in Windows 8.1 or later. To display colored emoji,
6554 there are some conditions which you should notice.
6555
6556 - If your font includes non-colored emoji already, it will
6557 be used.
6558 - If your font doesn't have emoji, the system chooses an
6559 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6560 will be used.
6561 - When this alternative font didn't have fixed width glyph,
6562 emoji might be rendered beyond the bounding box of drawing
6563 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006564
6565 Other render types are currently not supported.
6566
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 *'report'*
6568'report' number (default 2)
6569 global
6570 Threshold for reporting number of lines changed. When the number of
6571 changed lines is more than 'report' a message will be given for most
6572 ":" commands. If you want it always, set 'report' to 0.
6573 For the ":substitute" command the number of substitutions is used
6574 instead of the number of lines.
6575
6576 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6577'restorescreen' 'rs' boolean (default on)
6578 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006579 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 When set, the screen contents is restored when exiting Vim. This also
6581 happens when executing external commands.
6582
6583 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6584 options in your .vimrc. To disable restoring:
6585 set t_ti= t_te=
6586 To enable restoring (for an xterm):
6587 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6588 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6589
6590 *'revins'* *'ri'* *'norevins'* *'nori'*
6591'revins' 'ri' boolean (default off)
6592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593 {only available when compiled with the |+rightleft|
6594 feature}
6595 Inserting characters in Insert mode will work backwards. See "typing
6596 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6597 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006598 NOTE: This option is reset when 'compatible' is set.
6599 This option is reset when 'paste' is set and restored when 'paste' is
6600 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601
6602 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6603'rightleft' 'rl' boolean (default off)
6604 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 {only available when compiled with the |+rightleft|
6606 feature}
6607 When on, display orientation becomes right-to-left, i.e., characters
6608 that are stored in the file appear from the right to the left.
6609 Using this option, it is possible to edit files for languages that
6610 are written from the right to the left such as Hebrew and Arabic.
6611 This option is per window, so it is possible to edit mixed files
6612 simultaneously, or to view the same file in both ways (this is
6613 useful whenever you have a mixed text file with both right-to-left
6614 and left-to-right strings so that both sets are displayed properly
6615 in different windows). Also see |rileft.txt|.
6616
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006617 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618'rightleftcmd' 'rlc' string (default "search")
6619 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 {only available when compiled with the |+rightleft|
6621 feature}
6622 Each word in this option enables the command line editing to work in
6623 right-to-left mode for a group of commands:
6624
6625 search "/" and "?" commands
6626
6627 This is useful for languages such as Hebrew, Arabic and Farsi.
6628 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6629
Bram Moolenaard94464e2015-11-02 15:28:18 +01006630 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006631'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006632 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006633 {only available when compiled with the |+ruby/dyn|
6634 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006635 Specifies the name of the Ruby shared library. The default is
6636 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006637 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006638 This option cannot be set from a |modeline| or in the |sandbox|, for
6639 security reasons.
6640
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006642'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006645 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 text in the file is shown on the far right:
6647 Top first line is visible
6648 Bot last line is visible
6649 All first and last line are visible
6650 45% relative position in the file
6651 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006652 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006653 ruler is shown there. Otherwise it is shown in the last line of the
6654 screen. If the statusline is given by 'statusline' (i.e. not empty),
6655 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006657 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 the text column (byte number) and the screen column are shown,
6659 separated with a dash.
6660 For an empty line "0-1" is shown.
6661 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006662 This option is reset when 'paste' is set and restored when 'paste' is
6663 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 If you don't want to see the ruler all the time but want to know where
6665 you are, use "g CTRL-G" |g_CTRL-G|.
6666 NOTE: This option is reset when 'compatible' is set.
6667
6668 *'rulerformat'* *'ruf'*
6669'rulerformat' 'ruf' string (default empty)
6670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 {not available when compiled without the |+statusline|
6672 feature}
6673 When this option is not empty, it determines the content of the ruler
6674 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006675 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006676 This option cannot be set in a modeline when 'modelineexpr' is off.
6677
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 The default ruler width is 17 characters. To make the ruler 15
6679 characters wide, put "%15(" at the start and "%)" at the end.
6680 Example: >
6681 :set rulerformat=%15(%c%V\ %p%%%)
6682<
6683 *'runtimepath'* *'rtp'* *vimfiles*
6684'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006685 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 $VIM/vimfiles,
6687 $VIMRUNTIME,
6688 $VIM/vimfiles/after,
6689 $HOME/.vim/after"
6690 Amiga: "home:vimfiles,
6691 $VIM/vimfiles,
6692 $VIMRUNTIME,
6693 $VIM/vimfiles/after,
6694 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006695 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 $VIM/vimfiles,
6697 $VIMRUNTIME,
6698 $VIM/vimfiles/after,
6699 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006700 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 $VIMRUNTIME,
6702 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006703 Haiku: "$BE_USER_SETTINGS/vim,
6704 $VIM/vimfiles,
6705 $VIMRUNTIME,
6706 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006707 $BE_USER_SETTINGS/vim/after"
6708 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 $VIM/vimfiles,
6710 $VIMRUNTIME,
6711 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006712 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 This is a list of directories which will be searched for runtime
6715 files:
6716 filetype.vim filetypes by file name |new-filetype|
6717 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006718 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 colors/ color scheme files |:colorscheme|
6720 compiler/ compiler files |:compiler|
6721 doc/ documentation |write-local-help|
6722 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006723 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 indent/ indent scripts |indent-expression|
6725 keymap/ key mapping files |mbyte-keymap|
6726 lang/ menu translations |:menutrans|
6727 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006728 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 plugin/ plugin scripts |write-plugin|
6730 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006731 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 syntax/ syntax files |mysyntaxfile|
6733 tutor/ files for vimtutor |tutor|
6734
6735 And any other file searched for with the |:runtime| command.
6736
6737 The defaults for most systems are setup to search five locations:
6738 1. In your home directory, for your personal preferences.
6739 2. In a system-wide Vim directory, for preferences from the system
6740 administrator.
6741 3. In $VIMRUNTIME, for files distributed with Vim.
6742 *after-directory*
6743 4. In the "after" directory in the system-wide Vim directory. This is
6744 for the system administrator to overrule or add to the distributed
6745 defaults (rarely needed)
6746 5. In the "after" directory in your home directory. This is for
6747 personal preferences to overrule or add to the distributed defaults
6748 or system-wide settings (rarely needed).
6749
Bram Moolenaard0796902016-09-16 20:02:31 +02006750 More entries are added when using |packages|. If it gets very long
6751 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6752 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006753
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6755 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006756 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006757 wildcards.
6758 See |:runtime|.
6759 Example: >
6760 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6761< This will use the directory "~/vimruntime" first (containing your
6762 personal Vim runtime files), then "/mygroup/vim" (shared between a
6763 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6764 files).
6765 You probably should always include $VIMRUNTIME somewhere, to use the
6766 distributed runtime files. You can put a directory before $VIMRUNTIME
6767 to find files which replace a distributed runtime files. You can put
6768 a directory after $VIMRUNTIME to find files which add to distributed
6769 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006770 When Vim is started with |--clean| the home directory entries are not
6771 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 This option cannot be set from a |modeline| or in the |sandbox|, for
6773 security reasons.
6774
6775 *'scroll'* *'scr'*
6776'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006777 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6779 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006780 changes. This may happen when enabling the |status-line| or
6781 'tabline' option after setting the 'scroll' option.
6782 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006783 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006784 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785
6786 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6787'scrollbind' 'scb' boolean (default off)
6788 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006789 See also |scroll-binding|. When this option is set, scrolling the
6790 current window also scrolls other scrollbind windows (windows that
6791 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 differences between two versions of a file, see 'diff'.
6793 See |'scrollopt'| for options that determine how this option should be
6794 interpreted.
6795 This option is mostly reset when splitting a window to edit another
6796 file. This means that ":split | edit file" results in two windows
6797 with scroll-binding, but ":split file" does not.
6798
Bram Moolenaarae20f342019-11-05 21:09:23 +01006799 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6800'scrollfocus' 'scf' boolean (default off)
6801 global
6802 {only for MS-Windows GUI}
6803 When using the scroll wheel and this option is set, the window under
6804 the mouse pointer is scrolled. With this option off the current
6805 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006806 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006807
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 *'scrolljump'* *'sj'*
6809'scrolljump' 'sj' number (default 1)
6810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 Minimal number of lines to scroll when the cursor gets off the
6812 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6813 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006814 When set to a negative number from -1 to -100 this is used as the
6815 percentage of the window height. Thus -50 scrolls half the window
6816 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 NOTE: This option is set to 1 when 'compatible' is set.
6818
6819 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006820'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006821 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 Minimal number of screen lines to keep above and below the cursor.
6823 This will make some context visible around where you are working. If
6824 you set it to a very large value (999) the cursor line will always be
6825 in the middle of the window (except at the start or end of the file or
6826 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006827 After using the local value, go back the global value with one of
6828 these two: >
6829 setlocal scrolloff<
6830 setlocal scrolloff=-1
6831< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 NOTE: This option is set to 0 when 'compatible' is set.
6833
6834 *'scrollopt'* *'sbo'*
6835'scrollopt' 'sbo' string (default "ver,jump")
6836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006838 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6839 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 The following words are available:
6841 ver Bind vertical scrolling for 'scrollbind' windows
6842 hor Bind horizontal scrolling for 'scrollbind' windows
6843 jump Applies to the offset between two windows for vertical
6844 scrolling. This offset is the difference in the first
6845 displayed line of the bound windows. When moving
6846 around in a window, another 'scrollbind' window may
6847 reach a position before the start or after the end of
6848 the buffer. The offset is not changed though, when
6849 moving back the 'scrollbind' window will try to scroll
6850 to the desired position when possible.
6851 When now making that window the current one, two
6852 things can be done with the relative offset:
6853 1. When "jump" is not included, the relative offset is
6854 adjusted for the scroll position in the new current
6855 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006856 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 2. When "jump" is included, the other windows are
6858 scrolled to keep the same relative offset. When
6859 going back to the other window, it still uses the
6860 same relative offset.
6861 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006862 When 'diff' mode is active there always is vertical scroll binding,
6863 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864
6865 *'sections'* *'sect'*
6866'sections' 'sect' string (default "SHNHH HUnhsh")
6867 global
6868 Specifies the nroff macros that separate sections. These are pairs of
6869 two letters (See |object-motions|). The default makes a section start
6870 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6871
6872 *'secure'* *'nosecure'* *E523*
6873'secure' boolean (default off)
6874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 When on, ":autocmd", shell and write commands are not allowed in
6876 ".vimrc" and ".exrc" in the current directory and map commands are
6877 displayed. Switch it off only if you know that you will not run into
6878 problems, or when the 'exrc' option is off. On Unix this option is
6879 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006880 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 'secure' at the end of your ~/.vimrc then.
6882 This option cannot be set from a |modeline| or in the |sandbox|, for
6883 security reasons.
6884
6885 *'selection'* *'sel'*
6886'selection' 'sel' string (default "inclusive")
6887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 This option defines the behavior of the selection. It is only used
6889 in Visual and Select mode.
6890 Possible values:
6891 value past line inclusive ~
6892 old no yes
6893 inclusive yes yes
6894 exclusive yes no
6895 "past line" means that the cursor is allowed to be positioned one
6896 character past the line.
6897 "inclusive" means that the last character of the selection is included
6898 in an operation. For example, when "x" is used to delete the
6899 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006900 When "old" is used and 'virtualedit' allows the cursor to move past
6901 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 Note that when "exclusive" is used and selecting from the end
6903 backwards, you cannot include the last character of a line, when
6904 starting in Normal mode and 'virtualedit' empty.
6905
6906 The 'selection' option is set by the |:behave| command.
6907
6908 *'selectmode'* *'slm'*
6909'selectmode' 'slm' string (default "")
6910 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006911 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 Select mode instead of Visual mode, when a selection is started.
6913 Possible values:
6914 mouse when using the mouse
6915 key when using shifted special keys
6916 cmd when using "v", "V" or CTRL-V
6917 See |Select-mode|.
6918 The 'selectmode' option is set by the |:behave| command.
6919
6920 *'sessionoptions'* *'ssop'*
6921'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006922 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006924 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 feature}
6926 Changes the effect of the |:mksession| command. It is a comma
6927 separated list of words. Each word enables saving and restoring
6928 something:
6929 word save and restore ~
6930 blank empty windows
6931 buffers hidden and unloaded buffers, not just those in windows
6932 curdir the current directory
6933 folds manually created folds, opened/closed folds and local
6934 fold options
6935 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006936 and contain at least one lowercase letter. Only
6937 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 help the help window
6939 localoptions options and mappings local to a window or buffer (not
6940 global values for local options)
6941 options all options and mappings (also global values for local
6942 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006943 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 resize size of the Vim window: 'lines' and 'columns'
6945 sesdir the directory in which the session file is located
6946 will become the current directory (useful with
6947 projects accessed over a network from different
6948 systems)
6949 slash backslashes in file names replaced with forward
6950 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006951 tabpages all tab pages; without this only the current tab page
6952 is restored, so that you can make a session for each
6953 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006954 terminal include terminal windows where the command can be
6955 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 unix with Unix end-of-line format (single <NL>), even when
6957 on Windows or DOS
6958 winpos position of the whole Vim window
6959 winsize window sizes
6960
6961 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006962 When neither "curdir" nor "sesdir" is included, file names are stored
6963 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006964 If you leave out "options" many things won't work well after restoring
6965 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 "slash" and "unix" are useful on Windows when sharing session files
6967 with Unix. The Unix version of Vim cannot source dos format scripts,
6968 but the Windows version of Vim can source unix format scripts.
6969
6970 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006971'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 global
6973 Name of the shell to use for ! and :! commands. When changing the
6974 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6975 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006976 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 See |option-backslash| about including spaces and backslashes.
6978 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006979
Bram Moolenaara2baa732022-02-04 16:09:54 +00006980 In |restricted-mode| shell commands will not be possible. This mode
6981 is used if the value of $SHELL ends in "false" or "nologin".
6982
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006983 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006984 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6986< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006987 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006989 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006991 Example with escaped space (Vim will do this when initializing the
6992 option from $SHELL): >
6993 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006994< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006995 backslashes are consumed by `:set`.
6996
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 Under MS-Windows, when the executable ends in ".com" it must be
6998 included. Thus setting the shell to "command.com" or "4dos.com"
6999 works, but "command" and "4dos" do not work for all commands (e.g.,
7000 filtering).
7001 For unknown reasons, when using "4dos.com" the current directory is
7002 changed to "C:\". To avoid this set 'shell' like this: >
7003 :set shell=command.com\ /c\ 4dos
7004< This option cannot be set from a |modeline| or in the |sandbox|, for
7005 security reasons.
7006
7007 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007008'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007009 Win32, when 'shell' contains "powershell":
7010 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007011 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007014 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7015 For MS-Windows, the default is set according to the value of 'shell',
7016 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007017 On Unix it can have more than one flag. Each white space separated
7018 part is passed as an argument to the shell command.
7019 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007020 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 This option cannot be set from a |modeline| or in the |sandbox|, for
7022 security reasons.
7023
7024 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007025'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7026 "2>&1| tee", or
7027 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 {not available when compiled without the |+quickfix|
7030 feature}
7031 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007032 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 including spaces and backslashes.
7034 The name of the temporary file can be represented by "%s" if necessary
7035 (the file name is appended automatically if no %s appears in the value
7036 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007037 For the Amiga the default is ">". For MS-Windows using powershell the
7038 default is "2>&1 | Out-File -Encoding default", otherwise the default
7039 is ">%s 2>&1". The output is directly saved in a file and not echoed
7040 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007041 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042 in a file and echoed to the screen. If the 'shell' option is "csh" or
7043 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007044 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007045 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7046 means that stderr is also included. Before using the 'shell' option a
7047 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007048 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7049 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 The initialization of this option is done after reading the ".vimrc"
7051 and the other initializations, so that when the 'shell' option is set
7052 there, the 'shellpipe' option changes automatically, unless it was
7053 explicitly set before.
7054 When 'shellpipe' is set to an empty string, no redirection of the
7055 ":make" output will be done. This is useful if you use a 'makeprg'
7056 that writes to 'makeef' by itself. If you want no piping, but do
7057 want to include the 'makeef', set 'shellpipe' to a single space.
7058 Don't forget to precede the space with a backslash: ":set sp=\ ".
7059 In the future pipes may be used for filtering and this option will
7060 become obsolete (at least for Unix).
7061 This option cannot be set from a |modeline| or in the |sandbox|, for
7062 security reasons.
7063
7064 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007065'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 Quoting character(s), put around the command passed to the shell, for
7068 the "!" and ":!" commands. The redirection is kept outside of the
7069 quoting. See 'shellxquote' to include the redirection. It's
7070 probably not useful to set both options.
7071 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007072 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007073 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 This option cannot be set from a |modeline| or in the |sandbox|, for
7075 security reasons.
7076
7077 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007078'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7079 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 String to be used to put the output of a filter command in a temporary
7082 file. See also |:!|. See |option-backslash| about including spaces
7083 and backslashes.
7084 The name of the temporary file can be represented by "%s" if necessary
7085 (the file name is appended automatically if no %s appears in the value
7086 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007087 The default is ">". For Unix, if the 'shell' option is "csh" or
7088 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007089 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007090 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7091 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007092 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7093 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007094 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7095 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 The initialization of this option is done after reading the ".vimrc"
7097 and the other initializations, so that when the 'shell' option is set
7098 there, the 'shellredir' option changes automatically unless it was
7099 explicitly set before.
7100 In the future pipes may be used for filtering and this option will
7101 become obsolete (at least for Unix).
7102 This option cannot be set from a |modeline| or in the |sandbox|, for
7103 security reasons.
7104
7105 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7106'shellslash' 'ssl' boolean (default off)
7107 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007108 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007110 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007111 powershell.exe. Backward slashes can still be typed, but they are
7112 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 Note that setting or resetting this option has no effect for some
7114 existing file names, thus this option needs to be set before opening
7115 any file for best results. This might change in the future.
7116 'shellslash' only works when a backslash can be used as a path
7117 separator. To test if this is so use: >
7118 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007119< Also see 'completeslash'.
7120
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007121 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7122'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7123 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007124 When on, use temp files for shell commands. When off use a pipe.
7125 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007126 Currently a pipe is only supported on Unix and MS-Windows 2K and
7127 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007128 :if has("filterpipe")
7129< The advantage of using a pipe is that nobody can read the temp file
7130 and the 'shell' command does not need to support redirection.
7131 The advantage of using a temp file is that the file type and encoding
7132 can be detected.
7133 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7134 |FilterWritePost| autocommands event are not triggered when
7135 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007136 The `system()` function does not respect this option and always uses
7137 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007138 NOTE: This option is set to the Vim default value when 'compatible'
7139 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007140
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 *'shelltype'* *'st'*
7142'shelltype' 'st' number (default 0)
7143 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007144 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 On the Amiga this option influences the way how the commands work
7146 which use a shell.
7147 0 and 1: always use the shell
7148 2 and 3: use the shell only to filter lines
7149 4 and 5: use shell only for ':sh' command
7150 When not using the shell, the command is executed directly.
7151
7152 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7153 1 and 3: use "shell cmd" to start external commands
7154
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007155 *'shellxescape'* *'sxe'*
7156'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007157 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007158 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007159 When 'shellxquote' is set to "(" then the characters listed in this
7160 option will be escaped with a '^' character. This makes it possible
7161 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007162 This option cannot be set from a |modeline| or in the |sandbox|, for
7163 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007164
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 *'shellxquote'* *'sxq'*
7166'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007167 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007168 for Win32, when 'shell' is
7169 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007170 for Win32, when 'shell' contains "sh"
7171 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 for Unix, when using system(): "\"")
7173 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 Quoting character(s), put around the command passed to the shell, for
7175 the "!" and ":!" commands. Includes the redirection. See
7176 'shellquote' to exclude the redirection. It's probably not useful
7177 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007178 When the value is '(' then ')' is appended. When the value is '"('
7179 then ')"' is appended.
7180 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007181 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007182 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7183 pwsh.exe which automatically strips off the first and last quote on a
7184 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7185 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007186 'shell', to reduce the need to set this option by the user. See
7187 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 This option cannot be set from a |modeline| or in the |sandbox|, for
7189 security reasons.
7190
7191 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7192'shiftround' 'sr' boolean (default off)
7193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 Round indent to multiple of 'shiftwidth'. Applies to > and <
7195 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7196 a multiple of 'shiftwidth' (this is Vi compatible).
7197 NOTE: This option is reset when 'compatible' is set.
7198
7199 *'shiftwidth'* *'sw'*
7200'shiftwidth' 'sw' number (default 8)
7201 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007202 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007204 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007205 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206
7207 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007208'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7209 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007210 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 This option helps to avoid all the |hit-enter| prompts caused by file
7212 messages, for example with CTRL-G, and to avoid some other messages.
7213 It is a list of flags:
7214 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007215 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7216 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7217 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7218 m use "[+]" instead of "[Modified]" *shm-m*
7219 n use "[New]" instead of "[New File]" *shm-n*
7220 r use "[RO]" instead of "[readonly]" *shm-r*
7221 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007223 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7224 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007225 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007226 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007228 o overwrite message for writing a file with subsequent *shm-o*
7229 message for reading a file (useful for ":wn" or when
7230 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007231 O message for reading a file overwrites any previous *shm-O*
7232 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007233 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7234 "search hit TOP, continuing at BOTTOM" messages; when using
7235 the search count do not show "W" after the count message (see
7236 S below)
7237 t truncate file message at the start if it is too long *shm-t*
7238 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007239 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007240 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007241 long to fit on the command line; "..." will appear in the
7242 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007243 W don't give "written" or "[w]" when writing a file *shm-W*
7244 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007245 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007246 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007247 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007248 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007249 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7250 match", "Pattern not found", "Back at original", etc.
7251 C don't give messages while scanning for ins-completion *shm-C*
7252 items, for instance "scanning tags"
7253 q use "recording" instead of "recording @a" *shm-q*
7254 F don't give the file info when editing a file, like *shm-F*
7255 `:silent` was used for the command; note that this also
7256 affects messages from autocommands
Bram Moolenaar938ae282023-02-20 20:44:55 +00007257 S do not show search count message when searching, e.g. *shm-S*
7258 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259
7260 This gives you the opportunity to avoid that a change between buffers
7261 requires you to hit <Enter>, but still gives as useful a message as
7262 possible for the space available. To get the whole message that you
7263 would have got with 'shm' empty, use ":file!"
7264 Useful values:
7265 shm= No abbreviation of message.
7266 shm=a Abbreviation, but no loss of information.
7267 shm=at Abbreviation, and truncate message when necessary.
7268
7269 NOTE: This option is set to the Vi default value when 'compatible' is
7270 set and to the Vim default value when 'compatible' is reset.
7271
7272 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7273'shortname' 'sn' boolean (default off)
7274 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 Filenames are assumed to be 8 characters plus one extension of 3
7276 characters. Multiple dots in file names are not allowed. When this
7277 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007278 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007280 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281
7282 *'showbreak'* *'sbr'* *E595*
7283'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007284 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007285 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 feature}
7287 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007288 values are "> " or "+++ ": >
7289 :set showbreak=>\
7290< Note the backslash to escape the trailing space. It's easier like
7291 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007292 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007293< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 comma (in a future version the comma might be used to separate the
7295 part that is shown at the end and at the start of a line).
7296 The characters are highlighted according to the '@' flag in
7297 'highlight'.
7298 Note that tabs after the showbreak will be displayed differently.
7299 If you want the 'showbreak' to appear in between line numbers, add the
7300 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007301 A window-local value overrules a global value. If the global value is
7302 set and you want no value in the current window use NONE: >
7303 :setlocal showbreak=NONE
7304<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007306'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7307 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007309 Show (partial) command in the last line of the screen. Set this
7310 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 In Visual mode the size of the selected area is shown:
7312 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007313 If the number of bytes is different it is also displayed: "2-6"
7314 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007316 - When selecting a block, the size in screen characters:
7317 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007318 This information can be displayed in an alternative location using the
7319 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 NOTE: This option is set to the Vi default value when 'compatible' is
7321 set and to the Vim default value when 'compatible' is reset.
7322
Luuk van Baalba936f62022-12-15 13:15:39 +00007323 *'showcmdloc'* *'sloc'*
7324'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007325 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007326 This option can be used to display the (partially) entered command in
7327 another location. Possible values are:
7328 last Last line of the screen (default).
7329 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007330 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007331 Setting this option to "statusline" or "tabline" means that these will
7332 be redrawn whenever the command changes, which can be on every key
7333 pressed.
7334 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7335 place the text. Without a custom 'statusline' or 'tabline' it will be
7336 displayed in a convenient location.
7337
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7339'showfulltag' 'sft' boolean (default off)
7340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 When completing a word in insert mode (see |ins-completion|) from the
7342 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007343 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 matched a C function, you can see a template for what arguments are
7345 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007346 Note that this doesn't work well together with having "longest" in
7347 'completeopt', because the completion from the search pattern may not
7348 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349
7350 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7351'showmatch' 'sm' boolean (default off)
7352 global
7353 When a bracket is inserted, briefly jump to the matching one. The
7354 jump is only done if the match can be seen on the screen. The time to
7355 show the match can be set with 'matchtime'.
7356 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007357 seen or not).
7358 This option is reset when 'paste' is set and restored when 'paste' is
7359 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 When the 'm' flag is not included in 'cpoptions', typing a character
7361 will immediately move the cursor back to where it belongs.
7362 See the "sm" field in 'guicursor' for setting the cursor shape and
7363 blinking when showing the match.
7364 The 'matchpairs' option can be used to specify the characters to show
7365 matches for. 'rightleft' and 'revins' are used to look for opposite
7366 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007367 Also see the matchparen plugin for highlighting the match when moving
7368 around |pi_paren.txt|.
7369 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370
7371 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7372'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7373 global
7374 If in Insert, Replace or Visual mode put a message on the last line.
7375 Use the 'M' flag in 'highlight' to set the type of highlighting for
7376 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007377 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 doesn't mean XIM is really active, especially when 'imactivatekey' is
7379 not set.
7380 NOTE: This option is set to the Vi default value when 'compatible' is
7381 set and to the Vim default value when 'compatible' is reset.
7382
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007383 *'showtabline'* *'stal'*
7384'showtabline' 'stal' number (default 1)
7385 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007386 The value of this option specifies when the line with tab page labels
7387 will be displayed:
7388 0: never
7389 1: only if there are at least two tab pages
7390 2: always
7391 This is both for the GUI and non-GUI implementation of the tab pages
7392 line.
7393 See |tab-page| for more information about tab pages.
7394
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 *'sidescroll'* *'ss'*
7396'sidescroll' 'ss' number (default 0)
7397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 The minimal number of columns to scroll horizontally. Used only when
7399 the 'wrap' option is off and the cursor is moved off of the screen.
7400 When it is zero the cursor will be put in the middle of the screen.
7401 When using a slow terminal set it to a large number or 0. When using
7402 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7403 commands.
7404
7405 *'sidescrolloff'* *'siso'*
7406'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007407 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007409 right of the cursor if 'nowrap' is set. Setting this option to a
7410 value greater than 0 while having |'sidescroll'| also at a non-zero
7411 value makes some context visible in the line you are scrolling in
7412 horizontally (except at beginning of the line). Setting this option
7413 to a large value (like 999) has the effect of keeping the cursor
7414 horizontally centered in the window, as long as one does not come too
7415 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007416 After using the local value, go back the global value with one of
7417 these two: >
7418 setlocal sidescrolloff<
7419 setlocal sidescrolloff=-1
7420< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421
7422 Example: Try this together with 'sidescroll' and 'listchars' as
7423 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007424 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425
7426 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7427 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007428<
7429 *'signcolumn'* *'scl'*
7430'signcolumn' 'scl' string (default "auto")
7431 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007432 {not available when compiled without the |+signs|
7433 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007434 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007435 "auto" only when there is a sign to display
7436 "no" never
7437 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007438 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007439 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7442'smartcase' 'scs' boolean (default off)
7443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 Override the 'ignorecase' option if the search pattern contains upper
7445 case characters. Only used when the search pattern is typed and
7446 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007447 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7449 recalling the search pattern from history and hitting <Enter>.
7450 NOTE: This option is reset when 'compatible' is set.
7451
7452 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7453'smartindent' 'si' boolean (default off)
7454 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 Do smart autoindenting when starting a new line. Works for C-like
7456 programs, but can also be used for other languages. 'cindent' does
7457 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007458 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007459 setting 'si' has no effect. 'indentexpr' is a more advanced
7460 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 Normally 'autoindent' should also be on when using 'smartindent'.
7462 An indent is automatically inserted:
7463 - After a line ending in '{'.
7464 - After a line starting with a keyword from 'cinwords'.
7465 - Before a line starting with '}' (only with the "O" command).
7466 When typing '}' as the first character in a new line, that line is
7467 given the same indent as the matching '{'.
7468 When typing '#' as the first character in a new line, the indent for
7469 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007470 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7472 When using the ">>" command, lines starting with '#' are not shifted
7473 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007474 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007475 This option is reset when 'paste' is set and restored when 'paste' is
7476 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477
7478 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7479'smarttab' 'sta' boolean (default off)
7480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007482 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7483 <BS> will delete a 'shiftwidth' worth of space at the start of the
7484 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007485 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007486 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7487 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007488 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007490 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007491 This option is reset when 'paste' is set and restored when 'paste' is
7492 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 NOTE: This option is reset when 'compatible' is set.
7494
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007495 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7496'smoothscroll' 'sms' boolean (default off)
7497 local to window
7498 Scrolling works with screen lines. When 'wrap' is set and the first
7499 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007500 above the window. "<<<" is displayed at the start of the first line,
7501 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007502 You may also want to add "lastline" to the 'display' option to show as
7503 much of the last line as possible.
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007504 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
7505 and scrolling with the mouse.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007506
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 *'softtabstop'* *'sts'*
7508'softtabstop' 'sts' number (default 0)
7509 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 Number of spaces that a <Tab> counts for while performing editing
7511 operations, like inserting a <Tab> or using <BS>. It "feels" like
7512 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7513 used. This is useful to keep the 'ts' setting at its standard value
7514 of 8, while being able to edit like it is set to 'sts'. However,
7515 commands like "x" still work on the actual characters.
7516 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007517 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007518 'softtabstop' is set to 0 when the 'paste' option is set and restored
7519 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7521 spaces is minimized by using <Tab>s.
7522 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7523 set.
7524 NOTE: This option is set to 0 when 'compatible' is set.
7525
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007526 If Vim is compiled with the |+vartabs| feature then the value of
7527 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7528 anything other than an empty string.
7529
Bram Moolenaar217ad922005-03-20 22:37:15 +00007530 *'spell'* *'nospell'*
7531'spell' boolean (default off)
7532 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007533 {not available when compiled without the |+syntax|
7534 feature}
7535 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007536 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007537
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007538 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007539'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007540 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007541 {not available when compiled without the |+syntax|
7542 feature}
7543 Pattern to locate the end of a sentence. The following word will be
7544 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007545 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007546 When this check is not wanted make this option empty.
7547 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007548 Be careful with special characters, see |option-backslash| about
7549 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007550 To set this option automatically depending on the language, see
7551 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007552
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007553 *'spellfile'* *'spf'*
7554'spellfile' 'spf' string (default empty)
7555 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007556 {not available when compiled without the |+syntax|
7557 feature}
7558 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007559 commands. It must end in ".{encoding}.add". You need to include the
7560 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007561 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007562 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007563 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007564 |zg| and |zw| commands can be used to access each. This allows using
7565 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007566 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007567 you: Using the first directory in 'runtimepath' that is writable. If
7568 there is no "spell" directory yet it will be created. For the file
7569 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007570 ignoring the region.
7571 The resulting ".spl" file will be used for spell checking, it does not
7572 have to appear in 'spelllang'.
7573 Normally one file is used for all regions, but you can add the region
7574 name if you want to. However, it will then only be used when
7575 'spellfile' is set to it, for entries in 'spelllang' only files
7576 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007577 This option cannot be set from a |modeline| or in the |sandbox|, for
7578 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007579
Bram Moolenaar217ad922005-03-20 22:37:15 +00007580 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007581'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007582 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007583 {not available when compiled without the |+syntax|
7584 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007585 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007586 on spellchecking will be done for these languages. Example: >
7587 set spelllang=en_us,nl,medical
7588< This means US English, Dutch and medical words are recognized. Words
7589 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007590 The word list name must consist of alphanumeric characters, a dash or
7591 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007592 recommended to separate the two letter language name from a
7593 specification. Thus "en-rare" is used for rare English words.
7594 A region name must come last and have the form "_xx", where "xx" is
7595 the two-letter, lower case region name. You can use more than one
7596 region by listing them: "en_us,en_ca" supports both US and Canadian
7597 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007598 Britain. (Note: currently en_au and en_nz dictionaries are older than
7599 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007600 If the name "cjk" is included East Asian characters are excluded from
7601 spell checking. This is useful when editing text that also has Asian
7602 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007603 Note that the "medical" dictionary does not exist, it is just an
7604 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007605 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007606 As a special case the name of a .spl file can be given as-is. The
7607 first "_xx" in the name is removed and used as the region name
7608 (_xx is an underscore, two letters and followed by a non-letter).
7609 This is mainly for testing purposes. You must make sure the correct
7610 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007611 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007612 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7613 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007614 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007615
Bram Moolenaar98692072006-02-04 00:57:42 +00007616 If the |spellfile.vim| plugin is active and you use a language name
7617 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7618 will ask you if you want to download the file.
7619
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007620 After this option has been set successfully, Vim will source the files
7621 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007622 up to the first character that is not an ASCII letter or number and
7623 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007624
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007625 *'spelloptions'* *'spo'*
7626'spelloptions' 'spo' string (default "")
7627 local to buffer
7628 {not available when compiled without the |+syntax|
7629 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007630 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007631 camel When a word is CamelCased, assume "Cased" is a
7632 separate word: every upper-case character in a word
7633 that comes after a lower case character indicates the
7634 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007635
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007636 *'spellsuggest'* *'sps'*
7637'spellsuggest' 'sps' string (default "best")
7638 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007639 {not available when compiled without the |+syntax|
7640 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007641 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007642 the |spellsuggest()| function. This is a comma-separated list of
7643 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007644
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007645 best Internal method that works best for English. Finds
7646 changes like "fast" and uses a bit of sound-a-like
7647 scoring to improve the ordering.
7648
7649 double Internal method that uses two methods and mixes the
7650 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007651 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007652 word. That only works when the language specifies
7653 sound folding. Can be slow and doesn't always give
7654 better results.
7655
7656 fast Internal method that only checks for simple changes:
7657 character inserts/deletes/swaps. Works well for
7658 simple typing mistakes.
7659
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007660 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007661 Not used for |spellsuggest()|. The number of
7662 suggestions is never more than the value of 'lines'
7663 minus two.
7664
Bram Moolenaar585ee072022-01-29 11:22:17 +00007665 timeout:{millisec} Limit the time searching for suggestions to
7666 {millisec} milli seconds. Applies to the following
7667 methods. When omitted the limit is 5000. When
7668 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007669 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007670
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007671 file:{filename} Read file {filename}, which must have two columns,
7672 separated by a slash. The first column contains the
7673 bad word, the second column the suggested good word.
7674 Example:
7675 theribal/terrible ~
7676 Use this for common mistakes that do not appear at the
7677 top of the suggestion list with the internal methods.
7678 Lines without a slash are ignored, use this for
7679 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007680 The word in the second column must be correct,
7681 otherwise it will not be used. Add the word to an
7682 ".add" file if it is currently flagged as a spelling
7683 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007684 The file is used for all languages.
7685
7686 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007687 trouble with spaces. Best is to call a function
7688 without arguments, see |expr-option-function|.
7689 |v:val| holds the badly spelled word. The expression
7690 must evaluate to a List of Lists, each with a
7691 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007692 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007693 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007694 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007695 internal methods use. A lower score is better.
7696 This may invoke |spellsuggest()| if you temporarily
7697 set 'spellsuggest' to exclude the "expr:" part.
7698 Errors are silently ignored, unless you set the
7699 'verbose' option to a non-zero value.
7700
7701 Only one of "best", "double" or "fast" may be used. The others may
7702 appear several times in any order. Example: >
7703 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7704<
7705 This option cannot be set from a |modeline| or in the |sandbox|, for
7706 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007707
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7709'splitbelow' 'sb' boolean (default off)
7710 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 When on, splitting a window will put the new window below the current
7712 one. |:split|
7713
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007714 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007715'splitkeep' 'spk' string (default "cursor")
7716 global
7717 The value of this option determines the scroll behavior when opening,
7718 closing or resizing horizontal splits.
7719
7720 Possible values are:
7721 cursor Keep the same relative cursor position.
7722 screen Keep the text on the same screen line.
7723 topline Keep the topline the same.
7724
7725 For the "screen" and "topline" values, the cursor position will be
7726 changed when necessary. In this case, the jumplist will be populated
7727 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007728 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007729
Bram Moolenaar071d4272004-06-13 20:20:40 +00007730 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7731'splitright' 'spr' boolean (default off)
7732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 When on, splitting a window will put the new window right of the
7734 current one. |:vsplit|
7735
7736 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7737'startofline' 'sol' boolean (default on)
7738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007740 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007741 (if possible). This applies to the commands:
7742 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7743 - "d", "<<" and ">>" with a linewise operator
7744 - "%" with a count
7745 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7746 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 In case of buffer changing commands the cursor is placed at the column
7748 where it was the last time the buffer was edited.
7749 NOTE: This option is set when 'compatible' is set.
7750
Bram Moolenaar00654022011-02-25 14:42:19 +01007751 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007753 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007754 {not available when compiled without the |+statusline|
7755 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007756 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 Also see |status-line|.
7758
7759 The option consists of printf style '%' items interspersed with
7760 normal text. Each status line item is of the form:
7761 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007762 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007763 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764
Bram Moolenaar238a5642006-02-21 22:12:05 +00007765 When the option starts with "%!" then it is used as an expression,
7766 evaluated and the result is used as the option value. Example: >
7767 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007768< The *g:statusline_winid* variable will be set to the |window-ID| of the
7769 window that the status line belongs to.
7770 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007771 Note that the "%!" expression is evaluated in the context of the
7772 current window and buffer, while %{} items are evaluated in the
7773 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007774
7775 When there is error while evaluating the option then it will be made
7776 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007777 When the result contains unprintable characters the result is
7778 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007779
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 Note that the only effect of 'ruler' when this option is set (and
7781 'laststatus' is 2) is controlling the output of |CTRL-G|.
7782
7783 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007784 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007786 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 minwid Minimum width of the item, padding as set by '-' & '0'.
7788 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007789 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 on the left for text items. Numeric items will be
7791 shifted down to maxwid-2 digits followed by '>'number
7792 where number is the amount of missing digits, much like
7793 an exponential notation.
7794 item A one letter code as described below.
7795
7796 Following is a description of the possible statusline items. The
7797 second character in "item" is the type:
7798 N for number
7799 S for string
7800 F for flags as described below
7801 - not applicable
7802
7803 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007804 f S Path to the file in the buffer, as typed or relative to current
7805 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007806 F S Full path to the file in the buffer.
7807 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007808 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007810 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007812 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007813 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007814 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007816 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007818 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7820 being used: "<keymap>"
7821 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007822 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 B N As above, in hexadecimal.
7824 o N Byte number in file of byte under cursor, first byte is 1.
7825 Mnemonic: Offset from start of file (with one added)
7826 {not available when compiled without |+byte_offset| feature}
7827 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007828 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 l N Line number.
7830 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007831 c N Column number (byte index).
7832 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007833 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 p N Percentage through file in lines as in |CTRL-G|.
7835 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007836 percentage described for 'ruler'. Always 3 in length, unless
7837 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007838 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007839 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007841 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007842 Note that there is no '%' before the closing '}'. The
7843 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007844 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007845 {% - This is almost same as { except the result of the expression is
7846 re-evaluated as a statusline format string. Thus if the
7847 return value of expr contains % items they will get expanded.
7848 The expression can contain the } character, the end of
7849 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007850 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007851 func! Stl_filename() abort
7852 return "%t"
7853 endfunc
7854< `stl=%{Stl_filename()}` results in `"%t"`
7855 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007856 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 ( - Start of item group. Can be used for setting the width and
7858 alignment of a section. Must be followed by %) somewhere.
7859 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007860 T N For 'tabline': start of tab page N label. Use %T after the last
7861 label. This information is used for mouse clicks.
7862 X N For 'tabline': start of close tab N label. Use %X after the
7863 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7864 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 < - Where to truncate line if too long. Default is at the start.
7866 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007867 = - Separation point between alignment sections. Each section will
7868 be separated by an equal number of spaces. With one %= what
7869 comes after it will be right-aligned. With two %= there is a
7870 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007872 # - Set highlight group. The name must follow and then a # again.
7873 Thus use %#HLname# for highlight group HLname. The same
7874 highlighting is used, also for the statusline of non-current
7875 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007877 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007878 The difference between User{N} and StatusLine will be applied to
7879 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007880 The number N must be between 1 and 9. See |hl-User1..9|
7881
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007882 When displaying a flag, Vim removes the leading comma, if any, when
7883 that flag comes right after plaintext. This will make a nice display
7884 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885
Bram Moolenaar582fd852005-03-28 20:58:01 +00007886 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 not set) and a minwid is not set for the group, the whole group will
7888 become empty. This will make a group like the following disappear
7889 completely from the statusline when none of the flags are set. >
7890 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007891< Beware that an expression is evaluated each and every time the status
7892 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007893 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007894 While evaluating %{} the current buffer and current window will be set
7895 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007896 currently being drawn. The expression will evaluate in this context.
7897 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7898 real current buffer and "g:actual_curwin" to the |window-ID| of the
7899 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007900
Bram Moolenaar30b65812012-07-12 22:01:11 +02007901 The 'statusline' option will be evaluated in the |sandbox| if set from
7902 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007903 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007904
7905 It is not allowed to change text or jump to another window while
7906 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907
7908 If the statusline is not updated when you want it (e.g., after setting
7909 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007910 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007912 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 Otherwise the result is taken as flag text and applied to the rules
7914 described above.
7915
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007916 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007918 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919
7920 Examples:
7921 Emulate standard status line with 'ruler' set >
7922 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7923< Similar, but add ASCII value of char under the cursor (like "ga") >
7924 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7925< Display byte count and byte value, modified flag in red. >
7926 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7927 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7928< Display a ,GZ flag if a compressed file is loaded >
7929 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7930< In the |:autocmd|'s: >
7931 :let b:gzflag = 1
7932< And: >
7933 :unlet b:gzflag
7934< And define this function: >
7935 :function VarExists(var, val)
7936 : if exists(a:var) | return a:val | else | return '' | endif
7937 :endfunction
7938<
7939 *'suffixes'* *'su'*
7940'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007942 Files with these suffixes get a lower priority when multiple files
7943 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007944 suffixes. Spaces after the comma are ignored. A dot is also seen as
7945 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 separator, precede it with a backslash (see |option-backslash| about
7947 including spaces and backslashes).
7948 See 'wildignore' for completely ignoring files.
7949 The use of |:set+=| and |:set-=| is preferred when adding or removing
7950 suffixes from the list. This avoids problems when a future version
7951 uses another default.
7952
7953 *'suffixesadd'* *'sua'*
7954'suffixesadd' 'sua' string (default "")
7955 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007956 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 file for the "gf", "[I", etc. commands. Example: >
7958 :set suffixesadd=.java
7959<
7960 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7961'swapfile' 'swf' boolean (default on)
7962 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007963 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 swapfile is not wanted for a specific buffer. For example, with
7965 confidential information that even root must not be able to access.
7966 Careful: All text will be in memory:
7967 - Don't use this for big files.
7968 - Recovery will be impossible!
7969 A swapfile will only be present when |'updatecount'| is non-zero and
7970 'swapfile' is set.
7971 When 'swapfile' is reset, the swap file for the current buffer is
7972 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7973 non-zero, a swap file is immediately created.
7974 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007975 If you want to open a new buffer without creating a swap file for it,
7976 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007977 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978
7979 This option is used together with 'bufhidden' and 'buftype' to
7980 specify special kinds of buffers. See |special-buffers|.
7981
7982 *'swapsync'* *'sws'*
7983'swapsync' 'sws' string (default "fsync")
7984 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007986 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 When this option is empty parts of the swap file may be in memory and
7988 not written to disk. When the system crashes you may lose more work.
7989 On Unix the system does a sync now and then without Vim asking for it,
7990 so the disadvantage of setting this option off is small. On some
7991 systems the swap file will not be written at all. For a unix system
7992 setting it to "sync" will use the sync() call instead of the default
7993 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007994 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995
7996 *'switchbuf'* *'swb'*
7997'switchbuf' 'swb' string (default "")
7998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008000 This option is checked, when
8001 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008002 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008003 - jumping to a tag using the |:stag| command.
8004 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8005 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8006 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008007 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008008 useopen If included, jump to the first open window in the
8009 current tab page that contains the specified buffer
8010 (if there is one). Otherwise: Do not examine other
8011 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008012 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008013 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008015 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008016 Otherwise: do not split, use current window (when used
8017 in the quickfix window: the previously used window or
8018 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008019 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008020 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008021 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008022 uselast If included, jump to the previously used window when
8023 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008024 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8025 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008027 *'synmaxcol'* *'smc'*
8028'synmaxcol' 'smc' number (default 3000)
8029 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008030 {not available when compiled without the |+syntax|
8031 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008032 Maximum column in which to search for syntax items. In long lines the
8033 text after this column is not highlighted and following lines may not
8034 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008035 This helps to avoid very slow redrawing for an XML file that is one
8036 long line.
8037 Set to zero to remove the limit.
8038
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 *'syntax'* *'syn'*
8040'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008041 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 {not available when compiled without the |+syntax|
8043 feature}
8044 When this option is set, the syntax with this name is loaded, unless
8045 syntax highlighting has been switched off with ":syntax off".
8046 Otherwise this option does not always reflect the current syntax (the
8047 b:current_syntax variable does).
8048 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008049 not automatically recognized. Example, in an IDL file:
8050 /* vim: set syntax=idl : */ ~
8051 When a dot appears in the value then this separates two filetype
8052 names. Example:
8053 /* vim: set syntax=c.doxygen : */ ~
8054 This will use the "c" syntax first, then the "doxygen" syntax.
8055 Note that the second one must be prepared to be loaded as an addition,
8056 otherwise it will be skipped. More than one dot may appear.
8057 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 :set syntax=OFF
8059< To switch syntax highlighting on according to the current value of the
8060 'filetype' option: >
8061 :set syntax=ON
8062< What actually happens when setting the 'syntax' option is that the
8063 Syntax autocommand event is triggered with the value as argument.
8064 This option is not copied to another buffer, independent of the 's' or
8065 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008066 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008068 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008069'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008070 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008071 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008072 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008073 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008074
8075 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008076 option and only when there is no GUI tab line. When 'e' is in
8077 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008078 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008079
8080 The value is evaluated like with 'statusline'. You can use
8081 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008082 the text to be displayed. Use "%1T" for the first label, "%2T" for
8083 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008084
Bram Moolenaare12bab32019-01-08 22:02:56 +01008085 When changing something that is used in 'tabline' that does not
8086 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008087 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008088
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008089 Keep in mind that only one of the tab pages is the current one, others
8090 are invisible and you can't jump to their windows.
8091
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008092 *'tabpagemax'* *'tpm'*
8093'tabpagemax' 'tpm' number (default 10)
8094 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008095 Maximum number of tab pages to be opened by the |-p| command line
8096 argument or the ":tab all" command. |tabpage|
8097
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008098 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099'tabstop' 'ts' number (default 8)
8100 local to buffer
8101 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008102 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103
8104 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008105 appear wrong in many places, e.g., when printing it.
8106 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107
8108 There are four main ways to use tabs in Vim:
8109 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8110 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008111 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008113 This is the recommended way, the file will look the same with other
8114 tools and when listing it in a terminal.
8115 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8116 'expandtab'. This way you will always insert spaces. The
8117 formatting will never be messed up when 'tabstop' is changed (leave
8118 it at 8 just in case). The file will be a bit larger.
8119 You do need to check if no Tabs exist in the file. You can get rid
8120 of them by first setting 'expandtab' and using `%retab!`, making
8121 sure the value of 'tabstop' is set correctly.
8122 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 'expandtab'. This way you will always insert spaces. The
8124 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008125 You do need to check if no Tabs exist in the file, just like in the
8126 item just above.
8127 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008128 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008129 works when using Vim to edit the file, other tools assume a tabstop
8130 is worth 8 spaces.
8131 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 'noexpandtab'. This should then work (for initial indents only)
8133 for any tabstop setting that people use. It might be nice to have
8134 tabs after the first non-blank inserted as spaces if you do this
8135 though. Otherwise aligned comments will be wrong when 'tabstop' is
8136 changed.
8137
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008138 If Vim is compiled with the |+vartabs| feature then the value of
8139 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8140 than an empty string.
8141
Bram Moolenaar071d4272004-06-13 20:20:40 +00008142 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8143'tagbsearch' 'tbs' boolean (default on)
8144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008146 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147 searching makes searching for a tag a LOT faster, but a linear search
8148 will find more tags if the tags file wasn't properly sorted.
8149 Vim normally assumes that your tags files are sorted, or indicate that
8150 they are not sorted. Only when this is not the case does the
8151 'tagbsearch' option need to be switched off.
8152
8153 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008154 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 certain files, or retry all files with a linear search. When
8156 'tagbsearch' is off, only a linear search is done.
8157
8158 Linear searching is done anyway, for one file, when Vim finds a line
8159 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008160 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161< [The whitespace before and after the '0' must be a single <Tab>]
8162
8163 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008164 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 instead of a normal tag name, a retry is done with a linear search.
8166 Tags in unsorted tags files, and matches with different case will only
8167 be found in the retry.
8168
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008169 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008170 linear search can be avoided when case is ignored. Use a value of '2'
8171 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8172 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008173 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8174 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8175 used for this as well. Note that case must be folded to uppercase for
8176 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008177
8178 By default, tag searches are case-sensitive. Case is ignored when
8179 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8180 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008181 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8182 'tagcase' is "smart", and the pattern contains only lowercase
8183 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008184
8185 When 'tagbsearch' is off, tags searching is slower when a full match
8186 exists, but faster when no full match exists. Tags in unsorted tags
8187 files may only be found with 'tagbsearch' off.
8188 When the tags file is not sorted, or sorted in a wrong way (not on
8189 ASCII byte value), 'tagbsearch' should be off, or the line given above
8190 must be included in the tags file.
8191 This option doesn't affect commands that find all matching tags (e.g.,
8192 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008194 *'tagcase'* *'tc'*
8195'tagcase' 'tc' string (default "followic")
8196 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008197 This option specifies how case is handled when searching the tags
8198 file:
8199 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008200 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008201 ignore Ignore case
8202 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008203 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008204 NOTE: This option is set to the Vi default value when 'compatible' is
8205 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008206
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008207 *'tagfunc'* *'tfu'*
8208'tagfunc' 'tfu' string (default: empty)
8209 local to buffer
8210 {not available when compiled without the |+eval|
8211 feature}
8212 This option specifies a function to be used to perform tag searches.
8213 The function gets the tag pattern and should return a List of matching
8214 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008215 function and an example. The value can be the name of a function, a
8216 |lambda| or a |Funcref|. See |option-value-function| for more
8217 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008218 This option cannot be set from a |modeline| or in the |sandbox|, for
8219 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008220
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 *'taglength'* *'tl'*
8222'taglength' 'tl' number (default 0)
8223 global
8224 If non-zero, tags are significant up to this number of characters.
8225
8226 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8227'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8228 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008229 If on and using a tags file in another directory, file names in that
8230 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 NOTE: This option is set to the Vi default value when 'compatible' is
8232 set and to the Vim default value when 'compatible' is reset.
8233
8234 *'tags'* *'tag'* *E433*
8235'tags' 'tag' string (default "./tags,tags", when compiled with
8236 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8237 global or local to buffer |global-local|
8238 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008239 include a space or comma in a file name, precede it with backslashes
8240 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241 When a file name starts with "./", the '.' is replaced with the path
8242 of the current file. But only when the 'd' flag is not included in
8243 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8244 |tags-option|.
8245 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008246 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8247 find all files named "tags" below "/lib". The filename itself cannot
8248 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008249 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008250 The |tagfiles()| function can be used to get a list of the file names
8251 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8253 files are also supported. They are automatically recognized. The
8254 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8255 differences are ignored (MS-Windows). |emacs-tags|
8256 The use of |:set+=| and |:set-=| is preferred when adding or removing
8257 file names from the list. This avoids problems when a future version
8258 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259
8260 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8261'tagstack' 'tgst' boolean (default on)
8262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 When on, the |tagstack| is used normally. When off, a ":tag" or
8264 ":tselect" command with an argument will not push the tag onto the
8265 tagstack. A following ":tag" without an argument, a ":pop" command or
8266 any other command that uses the tagstack will use the unmodified
8267 tagstack, but does change the pointer to the active entry.
8268 Resetting this option is useful when using a ":tag" command in a
8269 mapping which should not change the tagstack.
8270
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008271 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008272'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008273 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008274 {only available when compiled with the |+tcl/dyn|
8275 feature}
8276 Specifies the name of the Tcl shared library. The default is
8277 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008278 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008279 This option cannot be set from a |modeline| or in the |sandbox|, for
8280 security reasons.
8281
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 *'term'* *E529* *E530* *E531*
8283'term' string (default is $TERM, if that fails:
8284 in the GUI: "builtin_gui"
8285 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008286 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008287 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288 on Unix: "ansi"
8289 on VMS: "ansi"
8290 on Win 32: "win32")
8291 global
8292 Name of the terminal. Used for choosing the terminal control
8293 characters. Environment variables are expanded |:set_env|.
8294 For example: >
8295 :set term=$TERM
8296< See |termcap|.
8297
8298 *'termbidi'* *'tbidi'*
8299 *'notermbidi'* *'notbidi'*
8300'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 {only available when compiled with the |+arabic|
8303 feature}
8304 The terminal is in charge of Bi-directionality of text (as specified
8305 by Unicode). The terminal is also expected to do the required shaping
8306 that some languages (such as Arabic) require.
8307 Setting this option implies that 'rightleft' will not be set when
8308 'arabic' is set and the value of 'arabicshape' will be ignored.
8309 Note that setting 'termbidi' has the immediate effect that
8310 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8311 This option is reset when the GUI is started.
8312 For further details see |arabic.txt|.
8313
8314 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008315'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 Encoding used for the terminal. This specifies what character
8318 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008319 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008320 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008321 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008322 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8324 Any attempts to set a different value will be rejected, and an error
8325 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008326 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 because the Win32 system always passes Unicode characters.
8328 When empty, the same encoding is used as for the 'encoding' option.
8329 This is the normal value.
8330 Not all combinations for 'termencoding' and 'encoding' are valid. See
8331 |encoding-table|.
8332 The value for this option must be supported by internal conversions or
8333 iconv(). When this is not possible no conversion will be done and you
8334 will probably experience problems with non-ASCII characters.
8335 Example: You are working with the locale set to euc-jp (Japanese) and
8336 want to edit a UTF-8 file: >
8337 :let &termencoding = &encoding
8338 :set encoding=utf-8
8339< You need to do this when your system has no locale support for UTF-8.
8340
Bram Moolenaar938ae282023-02-20 20:44:55 +00008341 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008342'termguicolors' 'tgc' boolean (default off)
8343 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008344 {not available when compiled without the
8345 |+termguicolors| feature}
8346 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008347 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008348
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008349 Requires a ISO-8613-3 compatible terminal. If setting this option
8350 does not work (produces a colorless UI) reading |xterm-true-color|
8351 might help.
8352
8353 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8354 is required. Use this check to find out: >
8355 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008356< This requires Vim to be built with the |+vtp| feature.
8357
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008358 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008359
8360 When using Vim with Windows Terminal, the background of Windows
8361 Terminal is normally filled with the Vim background color. Setting
8362 'termguicolors' and the guibg of the Normal highlight group to NONE
8363 will make the background transparent: >
8364 :hi Normal guibg=NONE
8365<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008366 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008367
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008368 *'termwinkey'* *'twk'*
8369'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008370 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008371 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008372 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008373 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008374 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008375< The string must be one key stroke but can be multiple bytes.
8376 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008377 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008378 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008379
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008380 *'termwinscroll'* *'twsl'*
8381'termwinscroll' 'twsl' number (default 10000)
8382 local to buffer
8383 {not available when compiled without the
8384 |+terminal| feature}
8385 Number of scrollback lines to keep. When going over this limit the
8386 first 10% of the scrollback lines are deleted. This is just to reduce
8387 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008388 Also used as a limit for text sent to the terminal in one write,
8389 multiplied by the number of columns times 3 (average number of bytes
8390 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008391
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008392 *'termwinsize'* *'tws'*
8393'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008394 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008395 Size used when opening the |terminal| window. Format:
8396 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008397 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008398 - When set with a "x" (e.g., "24x80") the terminal size is not
8399 adjusted to the window size. If the window is smaller only the
8400 top-left part is displayed.
8401 - When set with a "*" (e.g., "10*50") the terminal size follows the
8402 window size, but will not be smaller than the specified rows and/or
8403 columns.
8404 - When rows is zero then use the height of the window.
8405 - When columns is zero then use the width of the window.
8406 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008407 - Can be overruled in the |term_start()| options with "term_rows" and
8408 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008409
8410 Examples:
8411 "30x0" uses 30 rows and the current window width.
8412 "20*0" uses at least 20 rows and the current window width.
8413 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008414 Note that the command running in the terminal window may still change
8415 the size of the terminal. In that case the Vim window will be
8416 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008417
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008418 *'termwintype'* *'twt'*
8419'termwintype' 'twt' string (default "")
8420 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008421 {only available when compiled with the |terminal|
8422 feature on MS-Windows}
8423 Specify the virtual console (pty) used when opening the terminal
8424 window.
8425
8426 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008427 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008428 "winpty" use winpty, fail if not supported
8429 "conpty" use |ConPTY|, fail if not supported
8430
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008431 |ConPTY| support depends on the platform. Windows 10 October 2018
8432 Update is the first version that supports ConPTY, however it is still
8433 considered unstable. ConPTY might become stable in the next release
8434 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008435 supported then you cannot open a terminal window.
8436
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 *'terse'* *'noterse'*
8438'terse' boolean (default off)
8439 global
8440 When set: Add 's' flag to 'shortmess' option (this makes the message
8441 for a search that hits the start or end of the file not being
8442 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8443 shortens a lot of messages}
8444
8445 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8446'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 This option is obsolete. Use 'fileformats'.
8449 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8450 set to the default value for the current system. When 'textauto' is
8451 reset, 'fileformats' is made empty.
8452 NOTE: This option is set to the Vi default value when 'compatible' is
8453 set and to the Vim default value when 'compatible' is reset.
8454
8455 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008456'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008457 others: default off)
8458 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 This option is obsolete. Use 'fileformat'.
8460 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8461 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8462 "unix".
8463
8464 *'textwidth'* *'tw'*
8465'textwidth' 'tw' number (default 0)
8466 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467 Maximum width of text that is being inserted. A longer line will be
8468 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008469 this.
8470 'textwidth' is set to 0 when the 'paste' option is set and restored
8471 when 'paste' is reset.
8472 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008474 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475 NOTE: This option is set to 0 when 'compatible' is set.
8476
8477 *'thesaurus'* *'tsr'*
8478'thesaurus' 'tsr' string (default "")
8479 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008481 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8482 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008483
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008484 This option is not used if 'thesaurusfunc' is set, either for the
8485 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008486
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008487 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008489 name. See |option-backslash| about using backslashes. The use of
8490 |:set+=| and |:set-=| is preferred when adding or removing directories
8491 from the list. This avoids problems when a future version uses
8492 another default. Backticks cannot be used in this option for security
8493 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008495 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008496'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008497 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008498 {not available when compiled without the |+eval|
8499 feature}
8500 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008501 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008502 The value can be the name of a function, a |lambda| or a |Funcref|.
8503 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008504
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008505 This option cannot be set from a |modeline| or in the |sandbox|, for
8506 security reasons.
8507
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8509'tildeop' 'top' boolean (default off)
8510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 When on: The tilde command "~" behaves like an operator.
8512 NOTE: This option is reset when 'compatible' is set.
8513
8514 *'timeout'* *'to'* *'notimeout'* *'noto'*
8515'timeout' 'to' boolean (default on)
8516 global
laburnumT3f7855a2023-12-05 18:37:03 +01008517
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008519'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 These two options together determine the behavior when part of a
8522 mapped key sequence or keyboard code has been received:
8523
8524 'timeout' 'ttimeout' action ~
8525 off off do not time out
8526 on on or off time out on :mappings and key codes
8527 off on time out on key codes
8528
8529 If both options are off, Vim will wait until either the complete
8530 mapping or key sequence has been received, or it is clear that there
8531 is no mapping or key sequence for the received characters. For
8532 example: if you have mapped "vl" and Vim has received 'v', the next
8533 character is needed to see if the 'v' is followed by an 'l'.
8534 When one of the options is on, Vim will wait for about 1 second for
8535 the next character to arrive. After that the already received
8536 characters are interpreted as single characters. The waiting time can
8537 be changed with the 'timeoutlen' option.
8538 On slow terminals or very busy systems timing out may cause
8539 malfunctioning cursor keys. If both options are off, Vim waits
8540 forever after an entered <Esc> if there are key codes that start
8541 with <Esc>. You will have to type <Esc> twice. If you do not have
8542 problems with key codes, but would like to have :mapped key
8543 sequences not timing out in 1 second, set the 'ttimeout' option and
8544 reset the 'timeout' option.
8545
8546 NOTE: 'ttimeout' is reset when 'compatible' is set.
8547
8548 *'timeoutlen'* *'tm'*
8549'timeoutlen' 'tm' number (default 1000)
8550 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008551
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008553'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 The time in milliseconds that is waited for a key code or mapped key
8556 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8557 when part of a command has been typed.
8558 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8559 different timeout value for key codes is desired set 'ttimeoutlen' to
8560 a non-negative number.
8561
8562 ttimeoutlen mapping delay key code delay ~
8563 < 0 'timeoutlen' 'timeoutlen'
8564 >= 0 'timeoutlen' 'ttimeoutlen'
8565
8566 The timeout only happens when the 'timeout' and 'ttimeout' options
8567 tell so. A useful setting would be >
8568 :set timeout timeoutlen=3000 ttimeoutlen=100
8569< (time out on mapping after three seconds, time out on key codes after
8570 a tenth of a second).
8571
8572 *'title'* *'notitle'*
8573'title' boolean (default off, on when title can be restored)
8574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 When on, the title of the window will be set to the value of
8576 'titlestring' (if it is not empty), or to:
8577 filename [+=-] (path) - VIM
8578 Where:
8579 filename the name of the file being edited
8580 - indicates the file cannot be modified, 'ma' off
8581 + indicates the file was modified
8582 = indicates the file is read-only
8583 =+ indicates the file is read-only and modified
8584 (path) is the path of the file being edited
8585 - VIM the server name |v:servername| or "VIM"
8586 Only works if the terminal supports setting window titles
8587 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008588 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8590 *X11*
8591 When Vim was compiled with HAVE_X11 defined, the original title will
8592 be restored if possible. The output of ":version" will include "+X11"
8593 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8594 works for the icon name |'icon'|.
8595 But: When Vim was started with the |-X| argument, restoring the title
8596 will not work (except in the GUI).
8597 If the title cannot be restored, it is set to the value of 'titleold'.
8598 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008599 When using an xterm from a remote machine you can use this command: >
8600
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008602 ssh -X machine_name xterm &
8603<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 then the WINDOWID environment variable should be inherited and the
8605 title of the window should change back to what it should be after
8606 exiting Vim.
8607
8608 *'titlelen'*
8609'titlelen' number (default 85)
8610 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008612 title. When the title is longer, only the end of the path name is
8613 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 Using a percentage makes this adapt to the width of the window. But
8615 it won't work perfectly, because the actual number of characters
8616 available also depends on the font used and other things in the title
8617 bar. When 'titlelen' is zero the full path is used. Otherwise,
8618 values from 1 to 30000 percent can be used.
8619 'titlelen' is also used for the 'titlestring' option.
8620
8621 *'titleold'*
8622'titleold' string (default "Thanks for flying Vim")
8623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 This option will be used for the window title when exiting Vim if the
8625 original title cannot be restored. Only happens if 'title' is on or
8626 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008627 This option cannot be set from a |modeline| or in the |sandbox|, for
8628 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 *'titlestring'*
8630'titlestring' string (default "")
8631 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 When this option is not empty, it will be used for the title of the
8633 window. This happens only when the 'title' option is on.
8634 Only works if the terminal supports setting window titles (currently
8635 Amiga console, Win32 console, all GUI versions and terminals with a
8636 non-empty 't_ts' option).
8637 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008638 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008639
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 When this option contains printf-style '%' items, they will be
8641 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008642 This option cannot be set in a modeline when 'modelineexpr' is off.
8643
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008645 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8647< The value of 'titlelen' is used to align items in the middle or right
8648 of the available space.
8649 Some people prefer to have the file name first: >
8650 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8651< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008652 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 separating space only when needed.
8654 NOTE: Use of special characters in 'titlestring' may cause the display
8655 to be garbled (e.g., when it contains a CR or NL character).
8656 {not available when compiled without the |+statusline| feature}
8657
8658 *'toolbar'* *'tb'*
8659'toolbar' 'tb' string (default "icons,tooltips")
8660 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008661 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008662 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 possible values are:
8664 icons Toolbar buttons are shown with icons.
8665 text Toolbar buttons shown with text.
8666 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008667 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 tooltips Tooltips are active for toolbar buttons.
8669 Tooltips refer to the popup help text which appears after the mouse
8670 cursor is placed over a toolbar button for a brief moment.
8671
8672 If you want the toolbar to be shown with icons as well as text, do the
8673 following: >
8674 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008675< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 will show icons if both are requested.
8677
8678 If none of the strings specified in 'toolbar' are valid or if
8679 'toolbar' is empty, this option is ignored. If you want to disable
8680 the toolbar, you need to set the 'guioptions' option. For example: >
8681 :set guioptions-=T
8682< Also see |gui-toolbar|.
8683
8684 *'toolbariconsize'* *'tbis'*
8685'toolbariconsize' 'tbis' string (default "small")
8686 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008687 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008689 tiny Use tiny icons.
8690 small Use small icons (default).
8691 medium Use medium-sized icons.
8692 large Use large icons.
8693 huge Use even larger icons.
8694 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008696 the current theme. Common dimensions are giant=48x48, huge=32x32,
8697 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008698
8699 If 'toolbariconsize' is empty, the global default size as determined
8700 by user preferences or the current theme is used.
8701
8702 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8703'ttybuiltin' 'tbi' boolean (default on)
8704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 When on, the builtin termcaps are searched before the external ones.
8706 When off the builtin termcaps are searched after the external ones.
8707 When this option is changed, you should set the 'term' option next for
8708 the change to take effect, for example: >
8709 :set notbi term=$TERM
8710< See also |termcap|.
8711 Rationale: The default for this option is "on", because the builtin
8712 termcap entries are generally better (many systems contain faulty
8713 xterm entries...).
8714
8715 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008716'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 Indicates a fast terminal connection. More characters will be sent to
8719 the screen for redrawing, instead of using insert/delete line
8720 commands. Improves smoothness of redrawing when there are multiple
8721 windows and the terminal does not support a scrolling region.
8722 Also enables the extra writing of characters at the end of each screen
8723 line for lines that wrap. This helps when using copy/paste with the
8724 mouse in an xterm and other terminals.
8725
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008726 The default used to be set only for some terminal names, but these
8727 days nearly all terminals are fast, therefore the default is now "on".
8728 If you have a slow connection you may want to set this option off,
8729 e.g. depending on the host name: >
8730 if hostname() =~ 'faraway'
8731 set nottyfast
8732 endif
8733<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734 *'ttymouse'* *'ttym'*
8735'ttymouse' 'ttym' string (default depends on 'term')
8736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737 {only in Unix and VMS, doesn't work in the GUI; not
8738 available when compiled without |+mouse|}
8739 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008740 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 *xterm-mouse*
8742 xterm xterm-like mouse handling. The mouse generates
8743 "<Esc>[Mscr", where "scr" is three bytes:
8744 "s" = button state
8745 "c" = column plus 33
8746 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008747 This only works up to 223 columns! See "dec",
8748 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008749 xterm2 Works like "xterm", but with the xterm reporting the
8750 mouse position while the mouse is dragged. This works
8751 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008752 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 work. See below for how Vim detects this
8754 automatically.
8755 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008756 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008758 for the row and column. No other mouse events are
8759 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 *dec-mouse*
8761 dec DEC terminal mouse handling. The mouse generates a
8762 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008763 This is also available for an Xterm, if it was
8764 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 *jsbterm-mouse*
8766 jsbterm JSB term mouse handling.
8767 *pterm-mouse*
8768 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008769 *urxvt-mouse*
8770 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008771 The mouse works only if the terminal supports this
8772 encoding style, but it does not have 223 columns limit
8773 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008774 *sgr-mouse*
8775 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008776 mouse reporting. The mouse works even in columns
8777 beyond 223. This option is backward compatible with
8778 "xterm2" because it can also decode "xterm2" style
8779 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780
8781 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008782 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8783 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8785 recognized, if enabled at compile time. DEC terminal mouse codes
8786 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008787 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8788 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008790 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8791 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8792 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008793 If the terminfo/termcap entry "XM" exists and the first number is
8794 "1006" then 'ttymouse' will be set to "sgr". This works for many
8795 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008796 Additionally, if vim is compiled with the |+termresponse| feature and
8797 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008798 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008800 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8801 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8802 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008803 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8804 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008805 :set t_RV=
8806<
8807 *'ttyscroll'* *'tsl'*
8808'ttyscroll' 'tsl' number (default 999)
8809 global
8810 Maximum number of lines to scroll the screen. If there are more lines
8811 to scroll the window is redrawn. For terminals where scrolling is
8812 very slow and redrawing is not slow this can be set to a small number,
8813 e.g., 3, to speed up displaying.
8814
8815 *'ttytype'* *'tty'*
8816'ttytype' 'tty' string (default from $TERM)
8817 global
8818 Alias for 'term', see above.
8819
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008820 *'undodir'* *'udir'*
8821'undodir' 'udir' string (default ".")
8822 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008823 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008824 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008825 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008826 "." means using the directory of the file. The undo file name for
8827 "file.txt" is ".file.txt.un~".
8828 For other directories the file name is the full path of the edited
8829 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008830 When writing: The first directory that exists is used. "." always
8831 works, no directories after "." will be used for writing.
8832 When reading all entries are tried to find an undo file. The first
8833 undo file that exists is used. When it cannot be read an error is
8834 given, no further entry is used.
8835 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008836 This option cannot be set from a |modeline| or in the |sandbox|, for
8837 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008838
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008839 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008840'undofile' 'udf' boolean (default off)
8841 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008842 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008843 When on, Vim automatically saves undo history to an undo file when
8844 writing a buffer to a file, and restores undo history from the same
8845 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008846 The directory where the undo file is stored is specified by 'undodir'.
8847 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008848 The undo file is not read when 'undoreload' causes the buffer from
8849 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008850 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008851 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008852
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008854'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008855 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008856 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008857 is kept in memory, higher numbers will cause more memory to be used.
8858 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8860 itself: >
8861 set ul=0
8862< But you can also get Vi compatibility by including the 'u' flag in
8863 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008864 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008865 Set to -1 for no undo at all. You might want to do this only for the
8866 current buffer: >
8867 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008868< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008869
8870 The local value is set to -123456 when the global value is to be used.
8871
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008872 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008874 *'undoreload'* *'ur'*
8875'undoreload' 'ur' number (default 10000)
8876 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008877 Save the whole buffer for undo when reloading it. This applies to the
8878 ":e!" command and reloading for when the buffer changed outside of
8879 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008880 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008881 of lines is smaller than the value of this option.
8882 Set this option to zero to disable undo for a reload.
8883
8884 When saving undo for a reload, any undo file is not read.
8885
8886 Note that this causes the whole buffer to be stored in memory. Set
8887 this option to a lower value if you run out of memory.
8888
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 *'updatecount'* *'uc'*
8890'updatecount' 'uc' number (default: 200)
8891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 After typing this many characters the swap file will be written to
8893 disk. When zero, no swap file will be created at all (see chapter on
8894 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8895 Vim with the "-n" option, see |startup|. When editing in readonly
8896 mode this option will be initialized to 10000.
8897 The swapfile can be disabled per buffer with |'swapfile'|.
8898 When 'updatecount' is set from zero to non-zero, swap files are
8899 created for all buffers that have 'swapfile' set. When 'updatecount'
8900 is set to zero, existing swap files are not deleted.
8901 Also see |'swapsync'|.
8902 This option has no meaning in buffers where |'buftype'| is "nofile"
8903 or "nowrite".
8904
8905 *'updatetime'* *'ut'*
8906'updatetime' 'ut' number (default 4000)
8907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908 If this many milliseconds nothing is typed the swap file will be
8909 written to disk (see |crash-recovery|). Also used for the
8910 |CursorHold| autocommand event.
8911
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008912 *'varsofttabstop'* *'vsts'*
8913'varsofttabstop' 'vsts' string (default "")
8914 local to buffer
8915 {only available when compiled with the |+vartabs|
8916 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008917 A list of the number of spaces that a <Tab> counts for while editing,
8918 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8919 width <Tab>s are being inserted, while in fact a mixture of spaces
8920 and <Tab>s is used. Tab widths are separated with commas, with the
8921 final value applying to all subsequent tabs.
8922
8923 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008924 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008925 to use the following: >
8926 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008927< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8928 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008929
8930 Note that the value of |'softtabstop'| will be ignored while
8931 'varsofttabstop' is set.
8932
8933 *'vartabstop'* *'vts'*
8934'vartabstop' 'vts' string (default "")
8935 local to buffer
8936 {only available when compiled with the |+vartabs|
8937 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008938 A list of the number of spaces that a <Tab> in the file counts for,
8939 separated by commas. Each value corresponds to one tab, with the
8940 final value applying to all subsequent tabs. For example: >
8941 :set vartabstop=4,20,10,8
8942< This will make the first tab 4 spaces wide, the second 20 spaces,
8943 the third 10 spaces, and all following tabs 8 spaces.
8944
8945 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8946 is set.
8947
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 *'verbose'* *'vbs'*
8949'verbose' 'vbs' number (default 0)
8950 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008951 When bigger than zero, Vim will give messages about what it is doing.
8952 Currently, these messages are given:
8953 >= 1 When the viminfo file is read or written.
8954 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008955 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008956 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 >= 8 Files for which a group of autocommands is executed.
8958 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008959 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008960 >= 12 Every executed function.
8961 >= 13 When an exception is thrown, caught, finished, or discarded.
8962 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008963 >= 15 Every executed Ex command from a script (truncated at 200
8964 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008965 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966
8967 This option can also be set with the "-V" argument. See |-V|.
8968 This option is also set by the |:verbose| command.
8969
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008970 When the 'verbosefile' option is set then the verbose messages are not
8971 displayed.
8972
8973 *'verbosefile'* *'vfile'*
8974'verbosefile' 'vfile' string (default empty)
8975 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008976 When not empty all messages are written in a file with this name.
8977 When the file exists messages are appended.
8978 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008979 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008980 Setting 'verbosefile' to a new value is like making it empty first.
8981 The difference with |:redir| is that verbose messages are not
8982 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11008983 This option cannot be set from a |modeline| or in the |sandbox|, for
8984 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008985
Bram Moolenaar071d4272004-06-13 20:20:40 +00008986 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09008987'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008988 for Win32: "$HOME/vimfiles/view",
Christian Brabandtb8b1c8e2023-06-23 22:23:01 +01008989 for Unix: "$HOME/.vim/view",
h_east59858792023-10-25 22:47:05 +09008990 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008991 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008993 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008994 feature}
8995 Name of the directory where to store files for |:mkview|.
8996 This option cannot be set from a |modeline| or in the |sandbox|, for
8997 security reasons.
8998
8999 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009000'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009002 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009004 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009005 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006 word save and restore ~
9007 cursor cursor position in file and in window
9008 folds manually created folds, opened/closed folds and local
9009 fold options
9010 options options and mappings local to a window or buffer (not
9011 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009012 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 slash backslashes in file names replaced with forward
9014 slashes
9015 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009016 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009017 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009018
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009019 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009020 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009021 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022
9023 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009024'viminfo' 'vi' string (Vi default: "", Vim default for
9025 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009026 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9027 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009029 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 feature}
9031 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009032 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9033 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009034 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009035 consisting of a single character identifying the particular parameter,
9036 followed by a number or string which specifies the value of that
9037 parameter. If a particular character is left out, then the default
9038 value is used for that parameter. The following is a list of the
9039 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009040 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009041 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009042 ! When included, save and restore global variables that start
9043 with an uppercase letter, and don't contain a lowercase
9044 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009045 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009046 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009047 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 " Maximum number of lines saved for each register. Old name of
9049 the '<' item, with the disadvantage that you need to put a
9050 backslash before the ", otherwise it will be recognized as the
9051 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009052 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 % When included, save and restore the buffer list. If Vim is
9054 started with a file name argument, the buffer list is not
9055 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009056 buffer list is restored from the viminfo file. Quickfix
9057 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9058 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009059 When followed by a number, the number specifies the maximum
9060 number of buffers that are stored. Without a number all
9061 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009062 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 ' Maximum number of previously edited files for which the marks
9064 are remembered. This parameter must always be included when
9065 'viminfo' is non-empty.
9066 Including this item also means that the |jumplist| and the
9067 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009068 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009070 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009071 patterns are also saved. When not included, the value of
9072 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009073 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009075 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009076 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 < Maximum number of lines saved for each register. If zero then
9078 registers are not saved. When not included, all lines are
9079 saved. '"' is the old name for this item.
9080 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009081 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009083 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009084 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009085 c When included, convert the text in the viminfo file from the
9086 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009087 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009088 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089 f Whether file marks need to be stored. If zero, file marks ('0
9090 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009091 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009092 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009093 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 h Disable the effect of 'hlsearch' when loading the viminfo
9095 file. When not included, it depends on whether ":nohlsearch"
9096 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009097 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009098 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009099 the 'n'. Must be at the end of the option! If the
9100 'viminfofile' option is set, that file name overrides the one
9101 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009102 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009103 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009104 r Removable media. The argument is a string (up to the next
9105 ','). This parameter can be given several times. Each
9106 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009107 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9109 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9110 ignored. Maximum length of each 'r' argument is 50
9111 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009112 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009113 s Maximum size of an item in Kbyte. If zero then registers are
9114 not saved. Currently only applies to registers. The default
9115 "s10" will exclude registers with more than 10 Kbyte of text.
9116 Also see the '<' item above: line count limit.
9117
9118 Example: >
9119 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9120<
9121 '50 Marks will be remembered for the last 50 files you
9122 edited.
9123 <1000 Contents of registers (up to 1000 lines each) will be
9124 remembered.
9125 s100 Registers with more than 100 Kbyte text are skipped.
9126 :0 Command-line history will not be saved.
9127 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9128 no / Since '/' is not specified, the default will be used,
9129 that is, save all of the search history, and also the
9130 previous search and substitute patterns.
9131 no % The buffer list will not be saved nor read back.
9132 no h 'hlsearch' highlighting will be restored.
9133
9134 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9135 load the contents of the file, this is not done automatically.
9136
9137 This option cannot be set from a |modeline| or in the |sandbox|, for
9138 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009139 NOTE: This option is set to the Vim default value when 'compatible'
9140 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009142 *'viminfofile'* *'vif'*
9143'viminfofile' 'vif' string (default: "")
9144 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009145 {not available when compiled without the |+viminfo|
9146 feature}
9147 When non-empty, overrides the file name used for viminfo.
9148 When equal to "NONE" no viminfo file will be read or written.
9149 This option can be set with the |-i| command line flag. The |--clean|
9150 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009151 This option cannot be set from a |modeline| or in the |sandbox|, for
9152 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009153
Bram Moolenaar071d4272004-06-13 20:20:40 +00009154 *'virtualedit'* *'ve'*
9155'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009156 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009157 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009158 block Allow virtual editing in Visual block mode.
9159 insert Allow virtual editing in Insert mode.
9160 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009161 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009162 none When used as the local value, do not allow virtual
9163 editing even when the global value is set. When used
9164 as the global value, "none" is the same as "".
9165 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009166
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009168 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009169 of the line. Useful for selecting a rectangle in Visual mode and
9170 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009171 "onemore" is not the same, it will only allow moving the cursor just
9172 after the last character of the line. This makes some commands more
9173 consistent. Previously the cursor was always past the end of the line
9174 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009175 break some plugins or Vim scripts. For example because |l| can move
9176 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009177 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009178 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009179 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009180 It doesn't make sense to combine "all" with "onemore", but you will
9181 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009182 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009183 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009184
9185 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9186'visualbell' 'vb' boolean (default off)
9187 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009188 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009189 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009190 use: >
9191 :set vb t_vb=
9192< If you want a short flash, you can use this on many terminals: >
9193 :set vb t_vb=[?5h$<100>[?5l
9194< Here $<100> specifies the time, you can use a smaller or bigger value
9195 to get a shorter or longer flash.
9196
9197 Note: Vim will limit the bell to once per half a second. This avoids
9198 having to wait for the flashing to finish when there are lots of
9199 bells, e.g. on key repeat. This also happens without 'visualbell'
9200 set.
9201
Bram Moolenaar071d4272004-06-13 20:20:40 +00009202 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9203 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9204 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009205
9206 Note: When the GUI starts, 't_vb' is reset to its default value. You
9207 might want to set it again in your |gvimrc|.
9208
Bram Moolenaar071d4272004-06-13 20:20:40 +00009209 Does not work on the Amiga, you always get a screen flash.
9210 Also see 'errorbells'.
9211
9212 *'warn'* *'nowarn'*
9213'warn' boolean (default on)
9214 global
9215 Give a warning message when a shell command is used while the buffer
9216 has been changed.
9217
9218 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9219'weirdinvert' 'wiv' boolean (default off)
9220 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009221 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009222 It is provided for backwards compatibility with version 4.x.
9223 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9224 vice versa. Has no effect when the GUI is running.
9225
9226 *'whichwrap'* *'ww'*
9227'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009229 Allow specified keys that move the cursor left/right to move to the
9230 previous/next line when the cursor is on the first/last character in
9231 the line. Concatenate characters to allow this for these keys:
9232 char key mode ~
9233 b <BS> Normal and Visual
9234 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009235 h "h" Normal and Visual (not recommended)
9236 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009237 < <Left> Normal and Visual
9238 > <Right> Normal and Visual
9239 ~ "~" Normal
9240 [ <Left> Insert and Replace
9241 ] <Right> Insert and Replace
9242 For example: >
9243 :set ww=<,>,[,]
9244< allows wrap only when cursor keys are used.
9245 When the movement keys are used in combination with a delete or change
9246 operator, the <EOL> also counts for a character. This makes "3h"
9247 different from "3dh" when the cursor crosses the end of a line. This
9248 is also true for "x" and "X", because they do the same as "dl" and
9249 "dh". If you use this, you may also want to use the mapping
9250 ":map <BS> X" to make backspace delete the character in front of the
9251 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009252 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009253 line (not an empty line) then it will not move to the next line. This
9254 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009255 NOTE: This option is set to the Vi default value when 'compatible' is
9256 set and to the Vim default value when 'compatible' is reset.
9257
9258 *'wildchar'* *'wc'*
9259'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261 Character you have to type to start wildcard expansion in the
9262 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009263 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009264 The character is not recognized when used inside a macro. See
9265 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009266 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009267 <Esc> can be used, but hitting it twice in a row will still exit
9268 command-line as a failsafe measure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009269 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009270 :set wc=<Tab>
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 *'wildcharm'* *'wcm'*
9275'wildcharm' 'wcm' number (default: none (0))
9276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009277 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009278 recognized when used inside a macro. You can find "spare" command-line
9279 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 you'll never actually type 'wildcharm', just use it in mappings that
9281 automatically invoke completion mode, e.g.: >
9282 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009283 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009284< Then after typing :ss you can use CTRL-P & CTRL-N.
9285
9286 *'wildignore'* *'wig'*
9287'wildignore' 'wig' string (default "")
9288 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009290 patterns is ignored when expanding |wildcards|, completing file or
9291 directory names, and influences the result of |expand()|, |glob()| and
9292 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009293 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9294 Also see 'suffixes'.
9295 Example: >
9296 :set wildignore=*.o,*.obj
9297< The use of |:set+=| and |:set-=| is preferred when adding or removing
9298 a pattern from the list. This avoids problems when a future version
9299 uses another default.
9300
h_east596a9f22023-11-21 21:24:23 +09009301 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009302'wildignorecase' 'wic' boolean (default off)
9303 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009304 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009305 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009306 Does not apply when the shell is used to expand wildcards, which
9307 happens when there are special characters.
9308
Bram Moolenaar071d4272004-06-13 20:20:40 +00009309 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009310'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009312 When 'wildmenu' is on, command-line completion operates in an enhanced
9313 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009314 the possible matches are shown.
9315 When 'wildoptions' contains "pum", then the completion matches are
9316 shown in a popup menu. Otherwise they are displayed just above the
9317 command line, with the first match highlighted (overwriting the status
9318 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009319 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009320 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9321 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9322 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009323 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009324 If there are more matches than can fit in the line, a ">" is shown on
9325 the right and/or a "<" is shown on the left. The status line scrolls
9326 as needed.
9327 The "wildmenu" mode is abandoned when a key is hit that is not used
9328 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009329 While the "wildmenu" is active, the following keys have special
9330 meanings:
9331 CTRL-P - go to the previous entry
9332 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009333 <CR> - in menu completion, when the cursor is just after a
9334 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009335 CTRL-E - end completion, go back to what was there before
9336 selecting a match.
9337 CTRL-Y - accept the currently selected match and stop
9338 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009339
9340 When not using the popup menu for command line completion, the
9341 following keys have special meanings:
9342 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343 <Up> - in filename/menu name completion: move up into
9344 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009345 <Down> - in filename/menu name completion: move into a
9346 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009347
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009348 When using the popup menu for command line completion, the following
9349 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009350 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009351 <PageUp> - select a match several entries back
9352 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009353 <Left> - in filename/menu name completion: move up into
9354 parent directory or parent menu.
9355 <Right> - in filename/menu name completion: move into a
9356 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009357
Bram Moolenaar071d4272004-06-13 20:20:40 +00009358 This makes the menus accessible from the console |console-menus|.
9359
9360 If you prefer the <Left> and <Right> keys to move the cursor instead
9361 of selecting a different match, use this: >
9362 :cnoremap <Left> <Space><BS><Left>
9363 :cnoremap <Right> <Space><BS><Right>
9364<
9365 The "WildMenu" highlighting is used for displaying the current match
9366 |hl-WildMenu|.
9367
9368 *'wildmode'* *'wim'*
9369'wildmode' 'wim' string (Vim default: "full")
9370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009371 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009372 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009373 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009374 first part specifies the behavior for the first use of 'wildchar',
9375 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009376
9377 Each part consists of a colon separated list consisting of the
9378 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009379 "" Complete only the first match.
9380 "full" Complete the next full match. After the last match,
9381 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009382 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009383 "longest" Complete till longest common string. If this doesn't
9384 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009385 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009386 "lastused" When completing buffer names and more than one buffer
9387 matches, sort buffers by time last used (other than
9388 the current buffer).
9389 When there is only a single match, it is fully completed in all cases.
9390
9391 Examples of useful colon-separated values:
9392 "longest:full" Like "longest", but also start 'wildmenu' if it is
9393 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009394 "list:full" When more than one match, list all matches and
9395 complete first match.
9396 "list:longest" When more than one match, list all matches and
9397 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009398 "list:lastused" When more than one buffer matches, list all matches
9399 and sort buffers by time last used (other than the
9400 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009401
9402 Examples: >
9403 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009404< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009405 :set wildmode=longest,full
9406< Complete longest common string, then each full match >
9407 :set wildmode=list:full
9408< List all matches and complete each full match >
9409 :set wildmode=list,full
9410< List all matches without completing, then each full match >
9411 :set wildmode=longest,list
9412< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009413 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009414
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009415 *'wildoptions'* *'wop'*
9416'wildoptions' 'wop' string (default "")
9417 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009418 A list of words that change how |cmdline-completion| is done.
9419 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009420 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009421 this value is specified, wildcard expansion will not
9422 be used for completion. The matches will be sorted by
9423 the "best match" rather than alphabetically sorted.
9424 This will find more matches than the wildcard
9425 expansion. Currently fuzzy matching based completion
9426 is not supported for file and directory names and
9427 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009428 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009429 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009430 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009431 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009432 is displayed per line. Often used tag kinds are:
9433 d #define
9434 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009435
Bram Moolenaar071d4272004-06-13 20:20:40 +00009436 *'winaltkeys'* *'wak'*
9437'winaltkeys' 'wak' string (default "menu")
9438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009439 {only used in Win32, Motif, GTK and Photon GUI}
9440 Some GUI versions allow the access to menu entries by using the ALT
9441 key in combination with a character that appears underlined in the
9442 menu. This conflicts with the use of the ALT key for mappings and
9443 entering special characters. This option tells what to do:
9444 no Don't use ALT keys for menus. ALT key combinations can be
9445 mapped, but there is no automatic handling. This can then be
9446 done with the |:simalt| command.
9447 yes ALT key handling is done by the windowing system. ALT key
9448 combinations cannot be mapped.
9449 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009450 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009451 keys can be mapped.
9452 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9453 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009454 This option is not used for <F10>; on Win32 and with GTK <F10> will
9455 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009456
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009457 *'wincolor'* *'wcr'*
9458'wincolor' 'wcr' string (default empty)
9459 local to window
9460 Highlight group name to use for this window instead of the Normal
9461 color |hl-Normal|.
9462
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009463 *'window'* *'wi'*
9464'window' 'wi' number (default screen height - 1)
9465 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009466 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9467 window and the value is smaller than 'lines' minus one. The screen
9468 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009469 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9470 in a much smarter way, taking care of wrapping lines.
9471 When resizing the Vim window, the value is smaller than 1 or more than
9472 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009473 Note: Do not confuse this with the height of the Vim window, use
9474 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009475
Colin Kennedy21570352024-03-03 16:16:47 +01009476 *'winfixbuf'*
9477'winfixbuf' 'wfb' boolean (default off)
9478 local to window
9479 If enabled, the buffer and any window that displays it are paired.
9480 For example, attempting to change the buffer with |:edit| will fail.
9481 Other commands which change a window's buffer such as |:cnext| will
9482 also skip any window with 'winfixbuf' enabled. However if a command
9483 has an "!" option, a window can be forced to switch buffers.
9484
laburnumT3f7855a2023-12-05 18:37:03 +01009485 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9486'winfixheight' 'wfh' boolean (default off)
9487 local to window |local-noglobal|
9488 Keep the window height when windows are opened or closed and
9489 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9490 |preview-window| and |quickfix-window|.
9491 The height may be changed anyway when running out of room.
9492
9493 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9494'winfixwidth' 'wfw' boolean (default off)
9495 local to window |local-noglobal|
9496 Keep the window width when windows are opened or closed and
9497 'equalalways' is set. Also for |CTRL-W_=|.
9498 The width may be changed anyway when running out of room.
9499
Bram Moolenaar071d4272004-06-13 20:20:40 +00009500 *'winheight'* *'wh'* *E591*
9501'winheight' 'wh' number (default 1)
9502 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009503 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009504 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009505 focus goes to a window that is smaller, its size is increased, at the
9506 cost of the height of other windows.
9507 Set 'winheight' to a small number for normal editing.
9508 Set it to 999 to make the current window fill most of the screen.
9509 Other windows will be only 'winminheight' high. This has the drawback
9510 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9511 to create only two windows, set the option after startup is done,
9512 using the |VimEnter| event: >
9513 au VimEnter * set winheight=999
9514< Minimum value is 1.
9515 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009516 height of the current window.
9517 'winheight' applies to the current window. Use 'winminheight' to set
9518 the minimal height for other windows.
9519
Bram Moolenaar071d4272004-06-13 20:20:40 +00009520 *'winminheight'* *'wmh'*
9521'winminheight' 'wmh' number (default 1)
9522 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009523 The minimal height of a window, when it's not the current window.
9524 This is a hard minimum, windows will never become smaller.
9525 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9526 status bar) if necessary. They will return to at least one line when
9527 they become active (since the cursor has to have somewhere to go.)
9528 Use 'winheight' to set the minimal height of the current window.
9529 This option is only checked when making a window smaller. Don't use a
9530 large number, it will cause errors when opening more than a few
9531 windows. A value of 0 to 3 is reasonable.
9532
9533 *'winminwidth'* *'wmw'*
9534'winminwidth' 'wmw' number (default 1)
9535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009536 The minimal width of a window, when it's not the current window.
9537 This is a hard minimum, windows will never become smaller.
9538 When set to zero, windows may be "squashed" to zero columns (i.e. just
9539 a vertical separator) if necessary. They will return to at least one
9540 line when they become active (since the cursor has to have somewhere
9541 to go.)
9542 Use 'winwidth' to set the minimal width of the current window.
9543 This option is only checked when making a window smaller. Don't use a
9544 large number, it will cause errors when opening more than a few
9545 windows. A value of 0 to 12 is reasonable.
9546
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009547 *'winptydll'*
9548'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9549 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009550 {only available when compiled with the |terminal|
9551 feature on MS-Windows}
9552 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009553 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009554 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009555 a fallback.
9556 Environment variables are expanded |:set_env|.
9557 This option cannot be set from a |modeline| or in the |sandbox|, for
9558 security reasons.
9559
Bram Moolenaar071d4272004-06-13 20:20:40 +00009560 *'winwidth'* *'wiw'* *E592*
9561'winwidth' 'wiw' number (default 20)
9562 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009563 Minimal number of columns for the current window. This is not a hard
9564 minimum, Vim will use fewer columns if there is not enough room. If
9565 the current window is smaller, its size is increased, at the cost of
9566 the width of other windows. Set it to 999 to make the current window
9567 always fill the screen. Set it to a small number for normal editing.
9568 The width is not adjusted after one of the commands to change the
9569 width of the current window.
9570 'winwidth' applies to the current window. Use 'winminwidth' to set
9571 the minimal width for other windows.
9572
9573 *'wrap'* *'nowrap'*
9574'wrap' boolean (default on)
9575 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009576 This option changes how text is displayed. It doesn't change the text
9577 in the buffer, see 'textwidth' for that.
9578 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009579 displaying continues on the next line. When off lines will not wrap
9580 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009581 moved to a part that is not shown, the screen will scroll
9582 horizontally.
9583 The line will be broken in the middle of a word if necessary. See
9584 'linebreak' to get the break at a word boundary.
9585 To make scrolling horizontally a bit more useful, try this: >
9586 :set sidescroll=5
9587 :set listchars+=precedes:<,extends:>
9588< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009589 This option can't be set from a |modeline| when the 'diff' option is
9590 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009591
9592 *'wrapmargin'* *'wm'*
9593'wrapmargin' 'wm' number (default 0)
9594 local to buffer
9595 Number of characters from the right window border where wrapping
9596 starts. When typing text beyond this limit, an <EOL> will be inserted
9597 and inserting continues on the next line.
9598 Options that add a margin, such as 'number' and 'foldcolumn', cause
9599 the text width to be further reduced. This is Vi compatible.
9600 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009601 This option is set to 0 when 'paste' is set and restored when 'paste'
9602 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009603 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009604
9605 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9606'wrapscan' 'ws' boolean (default on) *E384* *E385*
9607 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009608 Searches wrap around the end of the file. Also applies to |]s| and
9609 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009610
9611 *'write'* *'nowrite'*
9612'write' boolean (default on)
9613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009614 Allows writing files. When not set, writing a file is not allowed.
9615 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009616 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009617 argument. Filtering text is still possible, even though this requires
9618 writing a temporary file.
9619
9620 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9621'writeany' 'wa' boolean (default off)
9622 global
9623 Allows writing to any file with no need for "!" override.
9624
9625 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9626'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9627 otherwise)
9628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009629 Make a backup before overwriting a file. The backup is removed after
9630 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009631 also on.
9632 WARNING: Switching this option off means that when Vim fails to write
9633 your buffer correctly and then, for whatever reason, Vim exits, you
9634 lose both the original file and what you were writing. Only reset
9635 this option if your file system is almost full and it makes the write
9636 fail (and make sure not to exit Vim until the write was successful).
9637 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009638 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009639 Depending on 'backupcopy' the backup is a new file or the original
9640 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009641 NOTE: This option is set to the default value when 'compatible' is
9642 set.
9643
9644 *'writedelay'* *'wd'*
9645'writedelay' 'wd' number (default 0)
9646 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009647 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009648 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009649 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009650
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009651 *'xtermcodes'* *'noxtermcodes'*
9652'xtermcodes' boolean (default on)
9653 global
9654 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009655 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009656 key codes and number of colors from the terminal. This takes care of
9657 various configuration options of the terminal that cannot be obtained
9658 from the termlib/terminfo entry, see |xterm-codes|.
9659 A side effect may be that t_Co changes and Vim will redraw the
9660 display.
9661
9662
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009663 vim:tw=78:ts=8:noet:ft=help:norl: