blob: 8f57ac0f0d30a1b386f0b88c4bb7a12e2481d3d5 [file] [log] [blame]
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001*options.txt* For Vim version 9.0. Last change: 2023 Oct 23
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
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368:setl[ocal] {option}< Set the local value of {option} to its global value by
369 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000370
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100371:se[t] {option}< For |global-local| options: Remove the local value of
372 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373
374 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100375:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376 option without changing the local value.
377 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200378 With the "all" argument: display global values for all
379 local options.
380 Without argument: display global values for all local
381 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382
383For buffer-local and window-local options:
384 Command global value local value ~
385 :set option=value set set
386 :setlocal option=value - set
387:setglobal option=value set -
388 :set option? - display
389 :setlocal option? - display
390:setglobal option? display -
391
392
393Global options with a local value *global-local*
394
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000395Options are global when you mostly use one value for all buffers and windows.
396For some global options it's useful to sometimes have a different local value.
397You can set the local value with ":setlocal". That buffer or window will then
398use the local value, while other buffers and windows continue using the global
399value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400
401For example, you have two windows, both on C source code. They use the global
402'makeprg' option. If you do this in one of the two windows: >
403 :set makeprg=gmake
404then the other window will switch to the same value. There is no need to set
405the 'makeprg' option in the other C source window too.
406However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000407another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000408files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 :setlocal makeprg=perlmake
410You can switch back to using the global value by making the local value empty: >
411 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100412This only works for a string option. For a number or boolean option you need
413to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100415Note that for non-boolean and non-number options using "<" copies the global
416value to the local value, it doesn't switch back to using the global value
417(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000418 :set path<
419This will make the local value of 'path' empty, so that the global value is
420used. Thus it does the same as: >
421 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000422Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423":setlocal" on a global option might work differently then.
424
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000425 *option-value-function*
426Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000427'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000428a function name or a function reference or a lambda function. When using a
429lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000430>
431 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000432 set opfunc=function('MyOpFunc')
433 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000434 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000435
436Set to a script-local function: >
437 set opfunc=s:MyLocalFunc
438 set opfunc=<SID>MyLocalFunc
439In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
440the script: >
441 set opfunc=MyLocalFunc
442
443Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000444 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000445 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000446
447Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000448 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000449
450Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000451 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000452 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000453
454In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300455closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000456context of where it was defined.
457
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000458
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459Setting the filetype
460
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200461:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462 Set the 'filetype' option to {filetype}, but only if
463 not done yet in a sequence of (nested) autocommands.
464 This is short for: >
465 :if !did_filetype()
466 : setlocal filetype={filetype}
467 :endif
468< This command is used in a filetype.vim file to avoid
469 setting the 'filetype' option twice, causing different
470 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200471
472 When the optional FALLBACK argument is present, a
473 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100474 'filetype'. This is to be used for filetype
475 detections that are just a guess. |did_filetype()|
476 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200477
Bram Moolenaard58e9292011-02-09 17:07:58 +0100478 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
480:opt[ions] Open a window for viewing and setting all options.
481 Options are grouped by function.
482 Offers short help for each option. Hit <CR> on the
483 short help to open a help window with more help for
484 the option.
485 Modify the value of the option and hit <CR> on the
486 "set" line to set the new value. For window and
487 buffer specific options, the last accessed window is
488 used to set the option value in, unless this is a help
489 window, in which case the window below help window is
490 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100491 {not available when compiled without the |+eval|
492 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493
494 *$HOME*
495Using "~" is like using "$HOME", but it is only recognized at the start of an
496option and after a space or comma.
497
498On Unix systems "~user" can be used too. It is replaced by the home directory
499of user "user". Example: >
500 :set path=~mool/include,/usr/include,.
501
502On Unix systems the form "${HOME}" can be used too. The name between {} can
503contain non-id characters then. Note that if you want to use this for the
504"gf" command, you need to add the '{' and '}' characters to 'isfname'.
505
506NOTE: expanding environment variables and "~/" is only done with the ":set"
507command, not when assigning a value to an option with ":let".
508
Bram Moolenaarc572da52017-08-27 16:52:01 +0200509 *$HOME-windows*
510On MS-Windows, if $HOME is not defined as an environment variable, then
511at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200512If $HOMEDRIVE is not set then $USERPROFILE is used.
513
514This expanded value is not exported to the environment, this matters when
515running an external command: >
516 :echo system('set | findstr ^HOME=')
517and >
518 :echo luaeval('os.getenv("HOME")')
519should echo nothing (an empty string) despite exists('$HOME') being true.
520When setting $HOME to a non-empty string it will be exported to the
521subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200522
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
524Note the maximum length of an expanded option is limited. How much depends on
525the system, mostly it is something like 256 or 1024 characters.
526
527 *:fix* *:fixdel*
528:fix[del] Set the value of 't_kD':
529 't_kb' is 't_kD' becomes ~
530 CTRL-? CTRL-H
531 not CTRL-? CTRL-?
532
Bram Moolenaar82be4842021-01-11 19:40:15 +0100533 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534
535 If your delete key terminal code is wrong, but the
536 code for backspace is alright, you can put this in
537 your .vimrc: >
538 :fixdel
539< This works no matter what the actual code for
540 backspace is.
541
542 If the backspace key terminal code is wrong you can
543 use this: >
544 :if &term == "termname"
545 : set t_kb=^V<BS>
546 : fixdel
547 :endif
548< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000549 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 with your terminal name.
551
552 If your <Delete> key sends a strange key sequence (not
553 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
554 :if &term == "termname"
555 : set t_kD=^V<Delete>
556 :endif
557< Where "^V" is CTRL-V and "<Delete>" is the delete key
558 (don't type eight characters!). Replace "termname"
559 with your terminal name.
560
561 *Linux-backspace*
562 Note about Linux: By default the backspace key
563 produces CTRL-?, which is wrong. You can fix it by
564 putting this line in your rc.local: >
565 echo "keycode 14 = BackSpace" | loadkeys
566<
567 *NetBSD-backspace*
568 Note about NetBSD: If your backspace doesn't produce
569 the right code, try this: >
570 xmodmap -e "keycode 22 = BackSpace"
571< If this works, add this in your .Xmodmap file: >
572 keysym 22 = BackSpace
573< You need to restart for this to take effect.
574
575==============================================================================
5762. Automatically setting options *auto-setting*
577
578Besides changing options with the ":set" command, there are three alternatives
579to set options automatically for one or more files:
580
5811. When starting Vim initializations are read from various places. See
582 |initialization|. Most of them are performed for all editing sessions,
583 and some of them depend on the directory where Vim is started.
584 You can create an initialization file with |:mkvimrc|, |:mkview| and
585 |:mksession|.
5862. If you start editing a new file, the automatic commands are executed.
587 This can be used to set options for files matching a particular pattern and
588 many other things. See |autocommand|.
5893. If you start editing a new file, and the 'modeline' option is on, a
590 number of lines at the beginning and end of the file are checked for
591 modelines. This is explained here.
592
593 *modeline* *vim:* *vi:* *ex:* *E520*
594There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100595 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100597[text{white}] empty or any text followed by at least one blank
598 character (<Space> or <Tab>); "ex:" always requires at
599 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200600{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200601[white] optional white space
602{options} a list of option settings, separated with white space
603 or ':', where each part between ':' is the argument
604 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605
Bram Moolenaar14b69452013-06-29 23:05:20 +0200606Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000607 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200608 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
610The second form (this is compatible with some versions of Vi):
611
Bram Moolenaarade0d392020-01-21 22:33:58 +0100612 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaarade0d392020-01-21 22:33:58 +0100614[text{white}] empty or any text followed by at least one blank
615 character (<Space> or <Tab>); "ex:" always requires at
616 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200617{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
618[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200619se[t] the string "set " or "se " (note the space); When
620 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200621{options} a list of options, separated with white space, which
622 is the argument for a ":set" command
623: a colon
624[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625
Bram Moolenaar14b69452013-06-29 23:05:20 +0200626Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000627 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200628 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200630The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
631chance that a normal word like "lex:" is caught. There is one exception:
632"vi:" and "vim:" can also be at the start of the line (for compatibility with
633version 3.0). Using "ex:" at the start of the line will be ignored (this
634could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635
Hu Jialun9dcd3492021-08-28 20:42:50 +0200636If the modeline is disabled within a modeline, subsequent modelines will be
637ignored. This is to allow turning off modeline on a per-file basis. This is
638useful when a line looks like a modeline but isn't. For example, it would be
639good to start a YAML file containing strings like "vim:" with
640 # vim: nomodeline ~
641so as to avoid modeline misdetection. Following options on the same line
642after modeline deactivation, if any, are still evaluated (but you would
643normally not have any).
644
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 *modeline-local*
646The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000647buffer and window that contain the file. Although it's possible to set global
648options from a modeline, this is unusual. If you have two windows open and
649the files in it set the same global option to a different value, the result
650depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000652When editing a file that was already loaded, only the window-local options
653from the modeline are used. Thus if you manually changed a buffer-local
654option after opening the file, it won't be changed if you edit the same buffer
655in another window. But window-local options will be set.
656
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 *modeline-version*
658If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200659number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 vim{vers}: version {vers} or later
661 vim<{vers}: version before {vers}
662 vim={vers}: version {vers}
663 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100664{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
665For example, to use a modeline only for Vim 7.0:
666 /* vim700: set foldmethod=marker */ ~
667To use a modeline for Vim after version 7.2:
668 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669There can be no blanks between "vim" and the ":".
670
671
672The number of lines that are checked can be set with the 'modelines' option.
673If 'modeline' is off or 'modelines' is 0 no lines are checked.
674
675Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000676like:
677 /* vi:ts=4: */ ~
678will give an error message for the trailing "*/". This line is OK:
679 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681If an error is detected the rest of the line is skipped.
682
683If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000684backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100685 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
686This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
687before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200688 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000690might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200691can be set. For some options a flag is set, so that when the value is used
692the |sandbox| is effective. Some options can only be set from the modeline
693when 'modelineexpr' is set (the default is off).
694
695Still, there is always a small risk that a modeline causes trouble. E.g.,
696when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
697So disable modelines before editing untrusted text. The mail ftplugin does
698this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700Hint: If you would like to do something else than setting an option, you could
701define an autocommand that checks the file for a specific string. For
702example: >
703 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
704And define a function SetVar() that does something with the line containing
705"VAR".
706
707==============================================================================
7083. Options summary *option-summary*
709
710In the list below all the options are mentioned with their full name and with
711an abbreviation if there is one. Both forms may be used.
712
713In this document when a boolean option is "set" that means that ":set option"
714is entered. When an option is "reset", ":set nooption" is used.
715
716For some options there are two default values: The "Vim default", which is
717used when 'compatible' is not set, and the "Vi default", which is used when
718'compatible' is set.
719
720Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000721are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722different value in each window. For example the 'list' option can be set in
723one window and reset in another for the same text, giving both types of view
724at the same time. There are a few options that are specific to a certain
725file. These can have a different value for each file or buffer. For example
726the 'textwidth' option can be 78 for a normal text file and 0 for a C
727program.
728
729 global one option for all buffers and windows
730 local to window each window has its own copy of this option
731 local to buffer each buffer has its own copy of this option
732
733When creating a new window the option values from the currently active window
734are used as a default value for the window-specific options. For the
735buffer-specific options this depends on the 's' and 'S' flags in the
736'cpoptions' option. If 's' is included (which is the default) the values for
737buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000738first entered. If 'S' is present the options are copied each time the buffer
739is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740present, the options are copied from the currently active buffer when the
741buffer is created.
742
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000743Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000745Not all options are supported in all versions. This depends on the supported
746features and sometimes on the system. A remark about this is in curly braces
747below. When an option is not supported it may still be set without getting an
748error, this is called a hidden option. You can't get the value of a hidden
749option though, it is not stored.
750
751To test if option "foo" can be used with ":set" use something like this: >
752 if exists('&foo')
753This also returns true for a hidden option. To test if option "foo" is really
754supported use something like this: >
755 if exists('+foo')
756<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 *E355*
758A jump table for the options with a short description can be found at |Q_op|.
759
760 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100761'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 {only available when compiled with the |+rightleft|
764 feature}
765 The ASCII code for the first letter of the Hebrew alphabet. The
766 routine that maps the keyboard in Hebrew mode, both in Insert mode
767 (when hkmap is set) and on the command-line (when hitting CTRL-_)
768 outputs the Hebrew characters in the range [aleph..aleph+26].
769 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
770 See |rileft.txt|.
771
772 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
773'allowrevins' 'ari' boolean (default off)
774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 {only available when compiled with the |+rightleft|
776 feature}
777 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
778 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
779 into reverse Insert mode, and don't know how to get out. See
780 'revins'.
781 NOTE: This option is reset when 'compatible' is set.
782
783 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
784'altkeymap' 'akm' boolean (default off)
785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 {only available when compiled with the |+farsi|
787 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100788 This option was for using Farsi, which has been removed. See
789 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
791 *'ambiwidth'* *'ambw'*
792'ambiwidth' 'ambw' string (default: "single")
793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
795 Tells Vim what to do with characters with East Asian Width Class
796 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
797 letters, Cyrillic letters).
798
799 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000800 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 expected by most users.
802 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200803 *E834* *E835*
804 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100805 contains a character that would be double width. These errors may
806 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200807
808 The values are overruled for characters specified with
809 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810
811 There are a number of CJK fonts for which the width of glyphs for
812 those characters are solely based on how many octets they take in
813 legacy/traditional CJK encodings. In those encodings, Euro,
814 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000815 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000817 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 Vim is running inside a terminal (emulators) that uses a CJK font
819 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
820 this option should be set to "double" to match the width perceived
821 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100822 to be set to "double" under CJK MS-Windows when the system locale is
823 set to one of CJK locales. See Unicode Standard Annex #11
824 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100826 Vim may set this option automatically at startup time when Vim is
827 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200828 escape sequence to request cursor position report. The response can
829 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100830
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
832'antialias' 'anti' boolean (default: off)
833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200835 on macOS}
836 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
838 which can be easier to read at certain sizes on certain displays.
839 Setting this option can sometimes cause problems if 'guifont' is set
840 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100841 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
843 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
844'autochdir' 'acd' boolean (default off)
845 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200846 {only available when compiled with it, use
847 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000848 When on, Vim will change the current working directory whenever you
849 open a file, switch buffers, delete a buffer or open/close a window.
850 It will change to the directory containing the file which was opened
Bram Moolenaare8008642022-08-19 17:15:35 +0100851 or selected. When a buffer has no name it also has no directory, thus
852 the current directory won't change when navigating to it.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000853 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200855 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
856'autoshelldir' 'asd' boolean (default off)
857 global
858 When on, Vim will change the current working directory whenever you
859 change the directory of the shell running in a terminal window. You
860 need proper setting-up, so whenever the shell's pwd changes an OSC 7
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100861 escape sequence will be emitted. For example, on Linux, you can
862 source /etc/profile.d/vte.sh in your shell profile if you use bash or
863 zsh. For bash this should work (put it in a bash init file): >
864 if [[ -n "$VIM_TERMINAL" ]]; then
865 PROMPT_COMMAND='_vim_sync_PWD'
866 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100867 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100868 }
869 fi
870<
871 Or, in a zsh init file: >
872 if [[ -n "$VIM_TERMINAL" ]]; then
873 autoload -Uz add-zsh-hook
874 add-zsh-hook -Uz chpwd _vim_sync_PWD
875 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100876 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100877 }
878 fi
879<
880 In a fish init file: >
881 if test -n "$VIM_TERMINAL"
882 function _vim_sync_PWD --on-variable=PWD
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100883 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100884 end
885 end
886<
887 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000888 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200889
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
891'arabic' 'arab' boolean (default off)
892 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 {only available when compiled with the |+arabic|
894 feature}
895 This option can be set to start editing Arabic text.
896 Setting this option will:
897 - Set the 'rightleft' option, unless 'termbidi' is set.
898 - Set the 'arabicshape' option, unless 'termbidi' is set.
899 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
900 between typing English and Arabic key mapping.
901 - Set the 'delcombine' option
902 Note that 'encoding' must be "utf-8" for working with Arabic text.
903
904 Resetting this option will:
905 - Reset the 'rightleft' option.
906 - Disable the use of 'keymap' (without changing its value).
907 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200908 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100909 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 Also see |arabic.txt|.
911
912 *'arabicshape'* *'arshape'*
913 *'noarabicshape'* *'noarshape'*
914'arabicshape' 'arshape' boolean (default on)
915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 {only available when compiled with the |+arabic|
917 feature}
918 When on and 'termbidi' is off, the required visual character
919 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200920 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 one which encompasses:
922 a) the changing/morphing of characters based on their location
923 within a word (initial, medial, final and stand-alone).
924 b) the enabling of the ability to compose characters
925 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100926 When disabled the display shows each character's true stand-alone
927 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 Arabic is a complex language which requires other settings, for
929 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100930 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931
932 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
933'autoindent' 'ai' boolean (default off)
934 local to buffer
935 Copy indent from current line when starting a new line (typing <CR>
936 in Insert mode or when using the "o" or "O" command). If you do not
937 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000938 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
939 to another line has the same effect, unless the 'I' flag is included
940 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 When autoindent is on, formatting (with the "gq" command or when you
942 reach 'textwidth' in Insert mode) uses the indentation of the first
943 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 When 'smartindent' or 'cindent' is on the indent is changed in
945 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200946 The 'autoindent' option is reset when the 'paste' option is set and
947 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948
949 *'autoread'* *'ar'* *'noautoread'* *'noar'*
950'autoread' 'ar' boolean (default off)
951 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952 When a file has been detected to have been changed outside of Vim and
953 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200954 When the file has been deleted this is not done, so you have the text
955 from before it was deleted. When it appears again then it is read.
956 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 If this option has a local value, use this command to switch back to
958 using the global value: >
959 :set autoread<
960<
961 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
962'autowrite' 'aw' boolean (default off)
963 global
964 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000965 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000966 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
967 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000968 to another file.
969 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000970 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971 Note that for some commands the 'autowrite' option is not used, see
972 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200973 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200974 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100975 USE WITH CARE: If you make temporary changes to a buffer that you
976 don't want to be saved this option may cause it to be saved anyway.
977 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978
979 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
980'autowriteall' 'awa' boolean (default off)
981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
983 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
984 Setting this option also implies that Vim behaves like 'autowrite' has
985 been set.
986
987 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200988'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 When set to "dark", Vim will try to use colors that look good on a
991 dark background. When set to "light", Vim will try to use colors that
992 look good on a light background. Any other value is illegal.
993 Vim tries to set the default value according to the terminal used.
994 This will not always be correct.
995 Setting this option does not change the background color, it tells Vim
996 what the background color looks like. For changing the background
997 color, see |:hi-normal|.
998
999 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001000 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +00001001 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001002 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 setting 'background' will cause the color scheme to be reloaded. If
1004 the color scheme adjusts to the value of 'background' this will work.
1005 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001006 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007
1008 When setting 'background' to the default value with: >
1009 :set background&
1010< Vim will guess the value. In the GUI this should work correctly,
1011 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001012 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001013 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001015 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001016 color from the terminal. If the returned RGB value is dark/light and
1017 'background' is not dark/light, 'background' will be set and the
1018 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001019 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001020 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001021
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 When starting the GUI, the default value for 'background' will be
1023 "light". When the value is not set in the .gvimrc, and Vim detects
1024 that the background is actually quite dark, 'background' is set to
1025 "dark". But this happens only AFTER the .gvimrc file has been read
1026 (because the window needs to be opened to find the actual background
1027 color). To get around this, force the GUI window to be opened by
1028 putting a ":gui" command in the .gvimrc file, before where the value
1029 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001030
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001031 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001032 For other systems "dark" is used when 'term' is "linux",
1033 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1034 background. Otherwise the default is "light".
1035
Bram Moolenaarc572da52017-08-27 16:52:01 +02001036 The |:terminal| command and the |term_start()| function use the
1037 'background' value to decide whether the terminal window will start
1038 with a white or black background.
1039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 Normally this option would be set in the .vimrc file. Possibly
1041 depending on the terminal name. Example: >
1042 :if &term == "pcterm"
1043 : set background=dark
1044 :endif
1045< When this option is set, the default settings for the highlight groups
1046 will change. To use other settings, place ":highlight" commands AFTER
1047 the setting of the 'background' option.
1048 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1049 to select the colors for syntax highlighting. After changing this
1050 option, you must load syntax.vim again to see the result. This can be
1051 done with ":syntax on".
1052
1053 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001054'backspace' 'bs' string (default "", set to "indent,eol,start"
1055 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1058 mode. This is a list of items, separated by commas. Each item allows
1059 a way to backspace over something:
1060 value effect ~
1061 indent allow backspacing over autoindent
1062 eol allow backspacing over line breaks (join lines)
1063 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1064 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001065 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1066 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067
Bram Moolenaar46eea442022-03-30 10:51:39 +01001068 When the value is empty, Vi compatible backspacing is used, none of
1069 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070
1071 For backwards compatibility with version 5.4 and earlier:
1072 value effect ~
1073 0 same as ":set backspace=" (Vi compatible)
1074 1 same as ":set backspace=indent,eol"
1075 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001076 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077
1078 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1079 NOTE: This option is set to "" when 'compatible' is set.
1080
1081 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1082'backup' 'bk' boolean (default off)
1083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084 Make a backup before overwriting a file. Leave it around after the
1085 file has been successfully written. If you do not want to keep the
1086 backup file, but you do want a backup while the file is being
1087 written, reset this option and set the 'writebackup' option (this is
1088 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001089 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 |backup-table| for more explanations.
1091 When the 'backupskip' pattern matches, a backup is not made anyway.
1092 When 'patchmode' is set, the backup may be renamed to become the
1093 oldest version of a file.
1094 NOTE: This option is reset when 'compatible' is set.
1095
1096 *'backupcopy'* *'bkc'*
1097'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001098 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001100 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101
1102 The main values are:
1103 "yes" make a copy of the file and overwrite the original one
1104 "no" rename the file and write a new one
1105 "auto" one of the previous, what works best
1106
1107 Extra values that can be combined with the ones above are:
1108 "breaksymlink" always break symlinks when writing
1109 "breakhardlink" always break hardlinks when writing
1110
1111 Making a copy and overwriting the original file:
1112 - Takes extra time to copy the file.
1113 + When the file has special attributes, is a (hard/symbolic) link or
1114 has a resource fork, all this is preserved.
1115 - When the file is a link the backup will have the name of the link,
1116 not of the real file.
1117
1118 Renaming the file and writing a new one:
1119 + It's fast.
1120 - Sometimes not all attributes of the file can be copied to the new
1121 file.
1122 - When the file is a link the new file will not be a link.
1123
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001124 The "auto" value is the middle way: When Vim sees that renaming the
1125 file is possible without side effects (the attributes can be passed on
1126 and the file is not a link) that is used. When problems are expected,
1127 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128
1129 The "breaksymlink" and "breakhardlink" values can be used in
1130 combination with any of "yes", "no" and "auto". When included, they
1131 force Vim to always break either symbolic or hard links by doing
1132 exactly what the "no" option does, renaming the original file to
1133 become the backup and writing a new file in its place. This can be
1134 useful for example in source trees where all the files are symbolic or
1135 hard links and any changes should stay in the local source tree, not
1136 be propagated back to the original source.
1137 *crontab*
1138 One situation where "no" and "auto" will cause problems: A program
1139 that opens a file, invokes Vim to edit that file, and then tests if
1140 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001141 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 example.
1143
1144 When a copy is made, the original file is truncated and then filled
1145 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001146 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001147 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 group of the backup is set to the group of the original file. If this
1149 fails, the protection bits for the group are made the same as for
1150 others.
1151
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001152 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 the same attributes of the original file, and the newly written file
1154 is owned by the current user. When the file was a (hard/symbolic)
1155 link, the new file will not! That's why the "auto" value doesn't
1156 rename when the file is a link. The owner and group of the newly
1157 written file will be set to the same ones as the original file, but
1158 the system may refuse to do this. In that case the "auto" value will
1159 again not rename the file.
1160
Bram Moolenaar036986f2017-03-16 17:41:02 +01001161 NOTE: This option is set to the Vi default value when 'compatible' is
1162 set and to the Vim default value when 'compatible' is reset.
1163
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 *'backupdir'* *'bdir'*
1165'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001166 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 for Unix: ".,~/tmp,~/")
1168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 List of directories for the backup file, separated with commas.
1170 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001171 where this is possible. The directory must exist, Vim will not
1172 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001173 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174 impossible!). Writing may fail because of this.
1175 - A directory "." means to put the backup file in the same directory
1176 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001177 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1178 the backup file relative to where the edited file is. The leading
1179 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 ("." inside a directory name has no special meaning).
1181 - Spaces after the comma are ignored, other spaces are considered part
1182 of the directory name. To have a space at the start of a directory
1183 name, precede it with a backslash.
1184 - To include a comma in a directory name precede it with a backslash.
1185 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001186 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001187 the backup file name will be built from the complete path to the
1188 file with all path separators changed to percent '%' signs. This
1189 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001190 On Win32, it is also possible to end with "\\". However, When a
1191 separating comma is following, you must use "//", since "\\" will
1192 include the comma in the file name. Therefore it is recommended to
1193 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194 - Environment variables are expanded |:set_env|.
1195 - Careful with '\' characters, type one before a space, type two to
1196 get one in the option (see |option-backslash|), for example: >
1197 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1198< - For backwards compatibility with Vim version 3.0 a '>' at the start
1199 of the option is removed.
1200 See also 'backup' and 'writebackup' options.
1201 If you want to hide your backup files on Unix, consider this value: >
1202 :set backupdir=./.backup,~/.backup,.,/tmp
1203< You must create a ".backup" directory in each directory and in your
1204 home directory for this to work properly.
1205 The use of |:set+=| and |:set-=| is preferred when adding or removing
1206 directories from the list. This avoids problems when a future version
1207 uses another default.
1208 This option cannot be set from a |modeline| or in the |sandbox|, for
1209 security reasons.
1210
1211 *'backupext'* *'bex'* *E589*
1212'backupext' 'bex' string (default "~", for VMS: "_")
1213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 String which is appended to a file name to make the name of the
1215 backup file. The default is quite unusual, because this avoids
1216 accidentally overwriting existing files with a backup file. You might
1217 prefer using ".bak", but make sure that you don't have files with
1218 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001219 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001221 If you like to keep a lot of backups, you could use a BufWritePre
1222 autocommand to change 'backupext' just before writing the file to
1223 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001224 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001225< Use 'backupdir' to put the backup in a different directory.
1226
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001228'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1229 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1230 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 A list of file patterns. When one of the patterns matches with the
1233 name of the file which is written, no backup file is created. Both
1234 the specified file name and the full path name of the file are used.
1235 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1236 Watch out for special characters, see |option-backslash|.
1237 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001238 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001239
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001240 WARNING: Not having a backup file means that when Vim fails to write
1241 your buffer correctly and then, for whatever reason, Vim exits, you
1242 lose both the original file and what you were writing. Only disable
1243 backups if you don't care about losing the file.
1244
Bram Moolenaar02467872007-05-06 13:22:01 +00001245 Note that environment variables are not expanded. If you want to use
1246 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001247 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001248
1249< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001250 backup would be made by renaming the original file crontab won't see
1251 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252
1253 *'balloondelay'* *'bdlay'*
1254'balloondelay' 'bdlay' number (default: 600)
1255 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 {only available when compiled with the |+balloon_eval|
1257 feature}
1258 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1259
1260 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1261'ballooneval' 'beval' boolean (default off)
1262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001264 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001265 Switch on the |balloon-eval| functionality for the GUI.
1266
1267 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1268 *'nobevalterm'*
1269'balloonevalterm' 'bevalterm' boolean (default off)
1270 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001271 {only available when compiled with the
1272 |+balloon_eval_term| feature}
1273 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001275 *'balloonexpr'* *'bexpr'*
1276'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001277 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001278 {only available when compiled with the |+balloon_eval|
1279 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001280 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001281 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1282 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001283
1284 v:beval_bufnr number of the buffer in which balloon is going to show
1285 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001286 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001287 v:beval_lnum line number
1288 v:beval_col column number (byte index)
1289 v:beval_text word under or after the mouse pointer
1290
Bram Moolenaar54775062019-07-31 21:07:14 +02001291 Instead of showing a balloon, which is limited to plain text, consider
1292 using a popup window, see |popup_beval_example|. A popup window can
1293 use highlighting and show a border.
1294
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001295 The evaluation of the expression must not have side effects!
1296 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001297 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001298 return 'Cursor is at line ' .. v:beval_lnum ..
1299 \ ', column ' .. v:beval_col ..
1300 \ ' of file ' .. bufname(v:beval_bufnr) ..
1301 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001302 endfunction
1303 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001304 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001305<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001306 Also see |balloon_show()|, it can be used if the content of the balloon
1307 is to be fetched asynchronously. In that case evaluating
1308 'balloonexpr' should result in an empty string. If you get a balloon
1309 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001310
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001311 NOTE: The balloon is displayed only if the cursor is on a text
1312 character. If the result of evaluating 'balloonexpr' is not empty,
1313 Vim does not try to send a message to an external debugger (Netbeans
1314 or Sun Workshop).
1315
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001316 If the expression starts with s: or |<SID>|, then it is replaced with
1317 the script ID (|local-function|). Example: >
1318 set bexpr=s:MyBalloonExpr()
1319 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001320< Otherwise, the expression is evaluated in the context of the script
1321 where the option was set, thus script-local items are available.
1322
Bram Moolenaar30b65812012-07-12 22:01:11 +02001323 The expression will be evaluated in the |sandbox| when set from a
1324 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001325 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001326
1327 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001328 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001329
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001330 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001331 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001332< When they are supported "\n" characters will start a new line. If the
1333 expression evaluates to a |List| this is equal to using each List item
1334 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001335 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001336
Bram Moolenaar165bc692015-07-21 17:53:25 +02001337 *'belloff'* *'bo'*
1338'belloff' 'bo' string (default "")
1339 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001340 Specifies for which events the bell will not be rung. It is a comma
1341 separated list of items. For each item that is present, the bell
1342 will be silenced. This is most useful to specify specific events in
1343 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001344 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001345
1346 item meaning when present ~
1347 all All events.
1348 backspace When hitting <BS> or <Del> and deleting results in an
1349 error.
1350 cursor Fail to move around using the cursor keys or
1351 <PageUp>/<PageDown> in |Insert-mode|.
1352 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1353 |i_CTRL-X_CTRL-T|.
1354 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1355 |i_CTRL-E|.
1356 ctrlg Unknown Char after <C-G> in Insert mode.
1357 error Other Error occurred (e.g. try to join last line)
1358 (mostly used in |Normal-mode| or |Cmdline-mode|).
1359 esc hitting <Esc> in |Normal-mode|.
1360 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001361 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001362 insertmode Pressing <Esc> in 'insertmode'.
1363 lang Calling the beep module for Lua/Mzscheme/TCL.
1364 mess No output available for |g<|.
1365 showmatch Error occurred for 'showmatch' function.
1366 operator Empty region error |cpo-E|.
1367 register Unknown register after <C-R> in |Insert-mode|.
1368 shell Bell from shell output |:!|.
1369 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001370 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001371 wildmode More matches in |cmdline-completion| available
1372 (depends on the 'wildmode' setting).
1373
Bram Moolenaar036986f2017-03-16 17:41:02 +01001374 This is most useful to fine tune when in Insert mode the bell should
1375 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001376 indicate that an error occurred. It can be silenced by adding the
1377 "error" keyword.
1378
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1380'binary' 'bin' boolean (default off)
1381 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 This option should be set before editing a binary file. You can also
1383 use the |-b| Vim argument. When this option is switched on a few
1384 options will be changed (also when it already was on):
1385 'textwidth' will be set to 0
1386 'wrapmargin' will be set to 0
1387 'modeline' will be off
1388 'expandtab' will be off
1389 Also, 'fileformat' and 'fileformats' options will not be used, the
1390 file is read and written like 'fileformat' was "unix" (a single <NL>
1391 separates lines).
1392 The 'fileencoding' and 'fileencodings' options will not be used, the
1393 file is read without conversion.
1394 NOTE: When you start editing a(nother) file while the 'bin' option is
1395 on, settings from autocommands may change the settings again (e.g.,
1396 'textwidth'), causing trouble when editing. You might want to set
1397 'bin' again when the file has been loaded.
1398 The previous values of these options are remembered and restored when
1399 'bin' is switched from on to off. Each buffer has its own set of
1400 saved option values.
1401 To edit a file with 'binary' set you can use the |++bin| argument.
1402 This avoids you have to do ":set bin", which would have effect for all
1403 files you edit.
1404 When writing a file the <EOL> for the last line is only written if
1405 there was one in the original file (normally Vim appends an <EOL> to
1406 the last line if there is none; this would make the file longer). See
1407 the 'endofline' option.
1408
1409 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1410'bioskey' 'biosk' boolean (default on)
1411 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001412 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001413 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414
1415 *'bomb'* *'nobomb'*
1416'bomb' boolean (default off)
1417 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418 When writing a file and the following conditions are met, a BOM (Byte
1419 Order Mark) is prepended to the file:
1420 - this option is on
1421 - the 'binary' option is off
1422 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1423 endian variants.
1424 Some applications use the BOM to recognize the encoding of the file.
1425 Often used for UCS-2 files on MS-Windows. For other applications it
1426 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001427 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1429 check for the presence of the BOM is done and 'bomb' set accordingly.
1430 Unless 'binary' is set, it is removed from the first line, so that you
1431 don't see it when editing. When you don't change the options, the BOM
1432 will be restored when writing the file.
1433
1434 *'breakat'* *'brk'*
1435'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1436 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001437 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 feature}
1439 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001440 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1441 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001443 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001444'breakindent' 'bri' boolean (default off)
1445 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001446 {not available when compiled without the |+linebreak|
1447 feature}
1448 Every wrapped line will continue visually indented (same amount of
1449 space as the beginning of that line), thus preserving horizontal blocks
1450 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001451 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001452
1453 *'breakindentopt'* *'briopt'*
1454'breakindentopt' 'briopt' string (default empty)
1455 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001456 {not available when compiled without the |+linebreak|
1457 feature}
1458 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001459 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001460 min:{n} Minimum text width that will be kept after
1461 applying 'breakindent', even if the resulting
1462 text should normally be narrower. This prevents
1463 text indented almost to the right window border
1464 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001465 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001466 shift:{n} After applying 'breakindent', the wrapped line's
1467 beginning will be shifted by the given number of
1468 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001469 indentation (negative) or emphasizing the line
1470 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001471 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001472 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001473 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001474 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001475 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001476 numbered or bulleted list (using the
1477 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001478 list:-1 Uses the length of a match with 'formatlistpat'
1479 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001480 (default: 0)
1481 column:{n} Indent at column {n}. Will overrule the other
1482 sub-options. Note: an additional indent may be
1483 added for the 'showbreak' setting.
1484 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001485
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001487'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001489 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001491 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001492 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493 buffer Use the directory of the related buffer.
1494 current Use the current directory.
1495 {path} Use the specified directory
1496
1497 *'bufhidden'* *'bh'*
1498'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001499 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 This option specifies what happens when a buffer is no longer
1501 displayed in a window:
1502 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001503 hide hide the buffer (don't unload it), even if 'hidden' is
1504 not set
1505 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001506 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001507 delete delete the buffer from the buffer list, even if
1508 'hidden' is set; the |:hide| command will also delete
1509 the buffer, making it behave like |:bdelete|
1510 wipe wipe the buffer from the buffer list, even if
1511 'hidden' is set; the |:hide| command will also wipe
1512 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001514 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001515 are lost without a warning. Also, these values may break autocommands
1516 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 This option is used together with 'buftype' and 'swapfile' to specify
1518 special kinds of buffers. See |special-buffers|.
1519
1520 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1521'buflisted' 'bl' boolean (default: on)
1522 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001523 When this option is set, the buffer shows up in the buffer list. If
1524 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1525 This option is reset by Vim for buffers that are only used to remember
1526 a file name or marks. Vim sets it when starting to edit a buffer.
1527 But not when moving to a buffer with ":buffer".
1528
1529 *'buftype'* *'bt'* *E382*
1530'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001531 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 The value of this option specifies the type of a buffer:
1533 <empty> normal buffer
1534 nofile buffer which is not related to a file and will not be
1535 written
1536 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001537 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001538 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001540 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 help help buffer (you are not supposed to set this
1542 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001543 terminal buffer for a |terminal| (you are not supposed to set
1544 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001545 prompt buffer where only the last line can be edited, meant
1546 to be used by a plugin, see |prompt-buffer|
1547 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001548 popup buffer used in a popup window, see |popup|.
1549 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550
1551 This option is used together with 'bufhidden' and 'swapfile' to
1552 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001553 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554
1555 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001556 One such effect is that Vim will not check the timestamp of the file,
1557 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558
Bram Moolenaar280f1262006-01-30 00:14:18 +00001559 A "quickfix" buffer is only used for the error list and the location
1560 list. This value is set by the |:cwindow| and |:lwindow| commands and
1561 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562
1563 "nofile" and "nowrite" buffers are similar:
1564 both: The buffer is not to be written to disk, ":w" doesn't
1565 work (":w filename" does work though).
1566 both: The buffer is never considered to be |'modified'|.
1567 There is no warning when the changes will be lost, for
1568 example when you quit Vim.
1569 both: A swap file is only created when using too much memory
1570 (when 'swapfile' has been reset there is never a swap
1571 file).
1572 nofile only: The buffer name is fixed, it is not handled like a
1573 file name. It is not modified in response to a |:cd|
1574 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001575 both: When using ":e bufname" and already editing "bufname"
1576 the buffer is made empty and autocommands are
1577 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001578 *E676*
1579 "acwrite" implies that the buffer name is not related to a file, like
1580 "nofile", but it will be written. Thus, in contrast to "nofile" and
1581 "nowrite", ":w" does work and a modified buffer can't be abandoned
1582 without saving. For writing there must be matching |BufWriteCmd|,
1583 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584
1585 *'casemap'* *'cmp'*
1586'casemap' 'cmp' string (default: "internal,keepascii")
1587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 Specifies details about changing the case of letters. It may contain
1589 these words, separated by a comma:
1590 internal Use internal case mapping functions, the current
1591 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001592 matters when 'encoding' is a Unicode encoding,
1593 "latin1" or "iso-8859-15". When "internal" is
1594 omitted, the towupper() and towlower() system library
1595 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1597 case mapping, the current locale is not effective.
1598 This probably only matters for Turkish.
1599
Bram Moolenaar938ae282023-02-20 20:44:55 +00001600 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001601'cdhome' 'cdh' boolean (default: off)
1602 global
1603 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1604 current working directory to the |$HOME| directory like in Unix.
1605 When off, those commands just print the current directory name.
1606 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001607 This option cannot be set from a |modeline| or in the |sandbox|, for
1608 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001609 NOTE: This option is reset when 'compatible' is set.
1610
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 *'cdpath'* *'cd'* *E344* *E346*
1612'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001615 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1616 searched for has a relative path, not an absolute part starting with
1617 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 The 'cdpath' option's value has the same form and semantics as
1619 |'path'|. Also see |file-searching|.
1620 The default value is taken from $CDPATH, with a "," prepended to look
1621 in the current directory first.
1622 If the default value taken from $CDPATH is not what you want, include
1623 a modified version of the following command in your vimrc file to
1624 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001625 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626< This option cannot be set from a |modeline| or in the |sandbox|, for
1627 security reasons.
1628 (parts of 'cdpath' can be passed to the shell to expand file names).
1629
1630 *'cedit'*
1631'cedit' string (Vi default: "", Vim default: CTRL-F)
1632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 The key used in Command-line Mode to open the command-line window.
1634 The default is CTRL-F when 'compatible' is off.
1635 Only non-printable keys are allowed.
1636 The key can be specified as a single character, but it is difficult to
1637 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001638 :exe "set cedit=\<C-Y>"
1639 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640< |Nvi| also has this option, but it only uses the first character.
1641 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001642 NOTE: This option is set to the Vim default value when 'compatible'
1643 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644
1645 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1646'charconvert' 'ccv' string (default "")
1647 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001648 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 An expression that is used for character encoding conversion. It is
1650 evaluated when a file that is to be read or has been written has a
1651 different encoding from what is desired.
1652 'charconvert' is not used when the internal iconv() function is
1653 supported and is able to do the conversion. Using iconv() is
1654 preferred, because it is much faster.
1655 'charconvert' is not used when reading stdin |--|, because there is no
1656 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001657 The expression must return zero, false or an empty string for success,
1658 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 The possible encoding names encountered are in 'encoding'.
1660 Additionally, names given in 'fileencodings' and 'fileencoding' are
1661 used.
1662 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1663 is done internally by Vim, 'charconvert' is not used for this.
1664 'charconvert' is also used to convert the viminfo file, if the 'c'
1665 flag is present in 'viminfo'. Also used for Unicode conversion.
1666 Example: >
1667 set charconvert=CharConvert()
1668 fun CharConvert()
1669 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001670 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1671 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 return v:shell_error
1673 endfun
1674< The related Vim variables are:
1675 v:charconvert_from name of the current encoding
1676 v:charconvert_to name of the desired encoding
1677 v:fname_in name of the input file
1678 v:fname_out name of the output file
1679 Note that v:fname_in and v:fname_out will never be the same.
1680 Note that v:charconvert_from and v:charconvert_to may be different
1681 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001682
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001683 The advantage of using a function call without arguments is that it is
1684 faster, see |expr-option-function|.
1685
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 Encryption is not done by Vim when using 'charconvert'. If you want
1687 to encrypt the file after conversion, 'charconvert' should take care
1688 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001689
1690 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1691 replaced with the script ID (|local-function|). Example: >
1692 set charconvert=s:MyConvert()
1693 set charconvert=<SID>SomeConvert()
1694< Otherwise the expression is evaluated in the context of the script
1695 where the option was set, thus script-local items are available.
1696
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 This option cannot be set from a |modeline| or in the |sandbox|, for
1698 security reasons.
1699
1700 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1701'cindent' 'cin' boolean (default off)
1702 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001703 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 that trigger reindenting in insert mode and 'cinoptions' to set your
1705 preferred indent style.
1706 If 'indentexpr' is not empty, it overrules 'cindent'.
1707 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1708 the "=" operator indents using this algorithm rather than calling an
1709 external program.
1710 See |C-indenting|.
1711 When you don't like the way 'cindent' works, try the 'smartindent'
1712 option or 'indentexpr'.
1713 This option is not used when 'paste' is set.
1714 NOTE: This option is reset when 'compatible' is set.
1715
1716 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001717'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 A list of keys that, when typed in Insert mode, cause reindenting of
1720 the current line. Only used if 'cindent' is on and 'indentexpr' is
1721 empty.
1722 For the format of this option see |cinkeys-format|.
1723 See |C-indenting|.
1724
1725 *'cinoptions'* *'cino'*
1726'cinoptions' 'cino' string (default "")
1727 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1729 program. See |cinoptions-values| for the values of this option, and
1730 |C-indenting| for info on C indenting in general.
1731
1732
1733 *'cinwords'* *'cinw'*
1734'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1735 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736 These keywords start an extra indent in the next line when
1737 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1738 an appropriate place (inside {}).
1739 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1740 matter, include the keyword both the uppercase and lowercase:
1741 "if,If,IF".
1742
Tom Praschan3506cf32022-04-07 12:39:08 +01001743 *'cinscopedecls'* *'cinsd'*
1744'cinscopedecls' 'cinsd' string (default "public,protected,private")
1745 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001746 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1747 Useful e.g. for working with the Qt framework that defines additional
1748 scope declarations "signals", "public slots" and "private slots": >
1749 set cinscopedecls+=signals,public\ slots,private\ slots
1750
1751< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1753 for X-windows, "" otherwise)
1754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 {only in GUI versions or when the |+xterm_clipboard|
1756 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001757 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001758 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001759 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001760 prepend, e.g.: >
1761 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001762< When using the GUI see |'go-A'|.
1763 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001765 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 unnamed When included, Vim will use the clipboard register '*'
1767 for all yank, delete, change and put operations which
1768 would normally go to the unnamed register. When a
1769 register is explicitly specified, it will always be
1770 used regardless of whether "unnamed" is in 'clipboard'
1771 or not. The clipboard register can always be
1772 explicitly accessed using the "* notation. Also see
1773 |gui-clipboard|.
1774
Bram Moolenaar30b65812012-07-12 22:01:11 +02001775 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001776 unnamedplus A variant of the "unnamed" flag which uses the
1777 clipboard register '+' (|quoteplus|) instead of
1778 register '*' for all yank, delete, change and put
1779 operations which would normally go to the unnamed
1780 register. When "unnamed" is also included to the
1781 option, yank operations (but not delete, change or
1782 put) will additionally copy the text into register
1783 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001784 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001785 Availability can be checked with: >
1786 if has('unnamedplus')
1787<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001788 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 autoselect Works like the 'a' flag in 'guioptions': If present,
1790 then whenever Visual mode is started, or the Visual
1791 area extended, Vim tries to become the owner of the
1792 windowing system's global selection or put the
1793 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001794 register "*. See |'go-a'| and |quotestar| for details.
1795 When the GUI is active, the 'a' flag in 'guioptions'
1796 is used, when the GUI is not active, this "autoselect"
1797 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 Also applies to the modeless selection.
1799
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001800 *clipboard-autoselectplus*
1801 autoselectplus Like "autoselect" but using the + register instead of
1802 the * register. Compare to the 'P' flag in
1803 'guioptions'.
1804
1805 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 autoselectml Like "autoselect", but for the modeless selection
1807 only. Compare to the 'A' flag in 'guioptions'.
1808
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001809 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001810 html When the clipboard contains HTML, use this when
1811 pasting. When putting text on the clipboard, mark it
1812 as HTML. This works to copy rendered HTML from
1813 Firefox, paste it as raw HTML in Vim, select the HTML
1814 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001815 You probably want to add this only temporarily,
1816 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001817 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001818
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001819 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 exclude:{pattern}
1821 Defines a pattern that is matched against the name of
1822 the terminal 'term'. If there is a match, no
1823 connection will be made to the X server. This is
1824 useful in this situation:
1825 - Running Vim in a console.
1826 - $DISPLAY is set to start applications on another
1827 display.
1828 - You do not want to connect to the X server in the
1829 console, but do want this in a terminal emulator.
1830 To never connect to the X server use: >
1831 exclude:.*
1832< This has the same effect as using the |-X| argument.
1833 Note that when there is no connection to the X server
1834 the window title won't be restored and the clipboard
1835 cannot be accessed.
1836 The value of 'magic' is ignored, {pattern} is
1837 interpreted as if 'magic' was on.
1838 The rest of the option value will be used for
1839 {pattern}, this must be the last entry.
1840
1841 *'cmdheight'* *'ch'*
1842'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001843 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001844 Number of screen lines to use for the command-line. A larger value
1845 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001846 The value of this option is stored with the tab page, so that each tab
1847 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848
1849 *'cmdwinheight'* *'cwh'*
1850'cmdwinheight' 'cwh' number (default 7)
1851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 Number of screen lines to use for the command-line window. |cmdwin|
1853
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001854 *'colorcolumn'* *'cc'*
1855'colorcolumn' 'cc' string (default "")
1856 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001857 {not available when compiled without the |+syntax|
1858 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001859 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001860 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1861 text. Will make screen redrawing slower.
1862 The screen column can be an absolute number, or a number preceded with
1863 '+' or '-', which is added to or subtracted from 'textwidth'. >
1864
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001865 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001866 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1867 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1868<
1869 When 'textwidth' is zero then the items with '-' and '+' are not used.
1870 A maximum of 256 columns are highlighted.
1871
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 *'columns'* *'co'* *E594*
1873'columns' 'co' number (default 80 or terminal width)
1874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001876 initialization and does not have to be set by hand. Also see
1877 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 When Vim is running in the GUI or in a resizable window, setting this
1879 option will cause the window size to be changed. When you only want
1880 to use the size for the GUI, put the command in your |gvimrc| file.
1881 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001882 number of columns of the display, the display may be messed up. For
1883 the GUI it is always possible and Vim limits the number of columns to
1884 what fits on the screen. You can use this command to get the widest
1885 window possible: >
1886 :set columns=9999
1887< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888
1889 *'comments'* *'com'* *E524* *E525*
1890'comments' 'com' string (default
1891 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1892 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001893 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 |format-comments|. See |option-backslash| about using backslashes to
1895 insert a space.
1896
1897 *'commentstring'* *'cms'* *E537*
1898'commentstring' 'cms' string (default "/*%s*/")
1899 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 {not available when compiled without the |+folding|
1901 feature}
1902 A template for a comment. The "%s" in the value is replaced with the
1903 comment text. Currently only used to add markers for folding, see
1904 |fold-marker|.
1905
1906 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001907'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001908 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 This option has the effect of making Vim either more Vi-compatible, or
1911 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001912
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001914 other options are also changed as a side effect.
1915 NOTE: Setting or resetting this option can have a lot of unexpected
1916 effects: Mappings are interpreted in another way, undo behaves
1917 differently, etc. If you set this option in your vimrc file, you
1918 should probably put it at the very start.
1919
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 By default this option is on and the Vi defaults are used for the
1921 options. This default was chosen for those people who want to use Vim
1922 just like Vi, and don't even (want to) know about the 'compatible'
1923 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001924 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001925 this option is switched off, and all options that have not been
1926 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001927 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001928 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001929 happen for the system-wide vimrc or gvimrc file, nor for a file given
1930 with the |-u| argument). Also see |compatible-default| and
1931 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 You can also set this option with the "-C" argument, and reset it with
1933 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001934 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935
Bram Moolenaar214641f2017-03-05 17:04:09 +01001936 When this option is set, numerous other options are set to make Vim as
1937 Vi-compatible as possible. When this option is unset, various options
1938 are set to make Vim more useful. The table below lists all the
1939 options affected.
1940 The {?} column indicates when the options are affected:
1941 + Means that the option is set to the value given in {set value} when
1942 'compatible' is set.
1943 & Means that the option is set to the value given in {set value} when
1944 'compatible' is set AND is set to its Vim default value when
1945 'compatible' is unset.
1946 - Means the option is NOT changed when setting 'compatible' but IS
1947 set to its Vim default when 'compatible' is unset.
1948 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949
Bram Moolenaar036986f2017-03-16 17:41:02 +01001950 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001951
1952 'allowrevins' + off no CTRL-_ command
1953 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001954 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001955 'arabicshape' + on correct character shapes
1956 'backspace' + "" normal backspace
1957 'backup' + off no backup file
1958 'backupcopy' & Unix: "yes" backup file is a copy
1959 else: "auto" copy or rename backup file
1960 'balloonexpr' + "" text to show in evaluation balloon
1961 'breakindent' + off don't indent when wrapping lines
1962 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001963 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001964 'cindent' + off no C code indentation
1965 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1966 'copyindent' + off don't copy indent structure
1967 'cpoptions' & (all flags) Vi-compatible flags
1968 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001969 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001970 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001971 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001972 'cscopeverbose' + off see |cscopeverbose|
1973 'delcombine' + off unicode: delete whole char combination
1974 'digraph' + off no digraphs
1975 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001976 this also disables |modifyOtherKeys|
1977 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001978 'expandtab' + off tabs not expanded to spaces
1979 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001980 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001981 'formatexpr' + "" use 'formatprg' for auto-formatting
1982 'formatoptions' & "vt" Vi compatible formatting
1983 'gdefault' + off no default 'g' flag for ":s"
1984 'history' & 0 no commandline history
1985 'hkmap' + off no Hebrew keyboard mapping
1986 'hkmapp' + off no phonetic Hebrew keyboard mapping
1987 'hlsearch' + off no highlighting of search matches
1988 'incsearch' + off no incremental searching
1989 'indentexpr' + "" no indenting by expression
1990 'insertmode' + off do not start in Insert mode
1991 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001993 'joinspaces' + on insert 2 spaces after period
1994 'modeline' & off no modelines
1995 'more' & off no pauses in listings
1996 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1997 'numberwidth' & 8 min number of columns for line number
1998 'preserveindent'+ off don't preserve current indent structure
1999 when changing it
2000 'revins' + off no reverse insert
2001 'ruler' + off no ruler
2002 'scrolljump' + 1 no jump scroll
2003 'scrolloff' + 0 no scroll offset
2004 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2005 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002006 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002007 'showcmd' & off command characters not shown
2008 'showmode' & off current mode not shown
2009 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2010 'smartcase' + off no automatic ignore case switch
2011 'smartindent' + off no smart indentation
2012 'smarttab' + off no smart tab size
2013 'softtabstop' + 0 tabs are always 'tabstop' positions
2014 'startofline' + on goto startofline with some commands
2015 'tagcase' & "followic" 'ignorecase' when searching tags file
2016 'tagrelative' & off tag file names are not relative
2017 'termguicolors' + off don't use highlight-(guifg|guibg)
2018 'textauto' & off no automatic textmode detection
2019 'textwidth' + 0 no automatic line wrap
2020 'tildeop' + off tilde is not an operator
2021 'ttimeout' + off no terminal timeout
2022 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002023 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002024 'virtualedit' + "" cursor can only be placed on characters
2025 'whichwrap' & "" left-right movements don't wrap
2026 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002028 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029
2030 *'complete'* *'cpt'* *E535*
2031'complete' 'cpt' string (default: ".,w,b,u,t,i")
2032 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 This option specifies how keyword completion |ins-completion| works
2034 when CTRL-P or CTRL-N are used. It is also used for whole-line
2035 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002036 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002037 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 w scan buffers from other windows
2039 b scan other loaded buffers that are in the buffer list
2040 u scan the unloaded buffers that are in the buffer list
2041 U scan the buffers that are not in the buffer list
2042 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002043 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 k{dict} scan the file {dict}. Several "k" flags can be given,
2045 patterns are valid too. For example: >
2046 :set cpt=k/usr/dict/*,k~/spanish
2047< s scan the files given with the 'thesaurus' option
2048 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2049 are valid too.
2050 i scan current and included files
2051 d scan current and included files for defined name or macro
2052 |i_CTRL-X_CTRL-D|
2053 ] tag completion
2054 t same as "]"
2055
2056 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2057 not executed, this may lead to unexpected completions from some files
2058 (gzipped files for example). Unloaded buffers are not scanned for
2059 whole-line completion.
2060
2061 The default is ".,w,b,u,t,i", which means to scan:
2062 1. the current buffer
2063 2. buffers in other windows
2064 3. other loaded buffers
2065 4. unloaded buffers
2066 5. tags
2067 6. included files
2068
2069 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002070 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2071 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002073 *'completefunc'* *'cfu'*
2074'completefunc' 'cfu' string (default: empty)
2075 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002076 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002077 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002078 This option specifies a function to be used for Insert mode completion
2079 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002080 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002081 invoked and what it should return. The value can be the name of a
2082 function, a |lambda| or a |Funcref|. See |option-value-function| for
2083 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002084 This option cannot be set from a |modeline| or in the |sandbox|, for
2085 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002086
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002087 *'completeslash'* *'csl'*
2088'completeslash' 'csl' string (default: "")
2089 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002090 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002091 When this option is set it overrules 'shellslash' for completion:
2092 - When this option is set to "slash", a forward slash is used for path
2093 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002094 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002095 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002096 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002097 - When this option is empty, same character is used as for
2098 'shellslash'.
2099 For Insert mode completion the buffer-local value is used. For
2100 command line completion the global value is used.
2101
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002102 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002103'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002104 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002105 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002106 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002107
2108 menu Use a popup menu to show the possible completions. The
2109 menu is only shown when there is more than one match and
2110 sufficient colors are available. |ins-completion-menu|
2111
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002112 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002113 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002114 match, e.g., what file it comes from.
2115
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002116 longest Only insert the longest common text of the matches. If
2117 the menu is displayed you can use CTRL-L to add more
2118 characters. Whether case is ignored depends on the kind
2119 of completion. For buffer text the 'ignorecase' option is
2120 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002121
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002122 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002123 completion in the preview window. Only works in
2124 combination with "menu" or "menuone".
2125
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002126 popup Show extra information about the currently selected
2127 completion in a popup window. Only works in combination
2128 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002129 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002130 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002131
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002132 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002133 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002134 |CompleteChanged| autocommand to fetch the info and call
2135 |popup_show()| once the popup has been filled.
2136 See the example at |complete-popuphidden|.
2137 {only works when compiled with the |+textprop| feature}
2138
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002139 noinsert Do not insert any text for a match until the user selects
2140 a match from the menu. Only works in combination with
2141 "menu" or "menuone". No effect if "longest" is present.
2142
2143 noselect Do not select a match in the menu, force the user to
2144 select one from the menu. Only works in combination with
2145 "menu" or "menuone".
2146
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002147
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002148 *'completepopup'* *'cpp'*
2149'completepopup' 'cpp' string (default empty)
2150 global
2151 {not available when compiled without the |+textprop|
2152 or |+quickfix| feature}
2153 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002154 properties of the info popup when it is created. If an info popup
2155 window already exists it is closed, so that the option value is
2156 applied when it is created again.
2157 You can also use |popup_findinfo()| and then set properties for an
2158 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002159
2160
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002161 *'concealcursor'* *'cocu'*
2162'concealcursor' 'cocu' string (default: "")
2163 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002164 {not available when compiled without the |+conceal|
2165 feature}
2166 Sets the modes in which text in the cursor line can also be concealed.
2167 When the current mode is listed then concealing happens just like in
2168 other lines.
2169 n Normal mode
2170 v Visual mode
2171 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002172 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002173
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002174 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002175 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002176 are moving around text is concealed, but when starting to insert text
2177 or selecting a Visual area the concealed text is displayed, so that
2178 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002179 Keep in mind that the cursor position is not always where it's
2180 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002181
2182
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002183 *'conceallevel'* *'cole'*
2184'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002185 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002186 {not available when compiled without the |+conceal|
2187 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002188 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2189 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002190
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002191 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002192 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002193 1 Each block of concealed text is replaced with one
2194 character. If the syntax item does not have a custom
2195 replacement character defined (see |:syn-cchar|) the
2196 character defined in 'listchars' is used (default is a
2197 space).
2198 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002199 2 Concealed text is completely hidden unless it has a
2200 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002201 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002202 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002203
Bram Moolenaara7781e02010-07-19 20:13:22 +02002204 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002205 edit and copy the text. This can be changed with the 'concealcursor'
2206 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002207
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2209'confirm' 'cf' boolean (default off)
2210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 When 'confirm' is on, certain operations that would normally
2212 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2213 instead raise a |dialog| asking if you wish to save the current
2214 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2215 If 'confirm' is off you can still activate confirmation for one
2216 command only (this is most useful in mappings) with the |:confirm|
2217 command.
2218 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2219
2220 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2221'conskey' 'consk' boolean (default off)
2222 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002223 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224
2225 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2226'copyindent' 'ci' boolean (default off)
2227 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 Copy the structure of the existing lines indent when autoindenting a
2229 new line. Normally the new indent is reconstructed by a series of
2230 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2231 in which case only spaces are used). Enabling this option makes the
2232 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002233 existing line. 'expandtab' has no effect on these characters, a Tab
2234 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002236 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 Also see 'preserveindent'.
2238
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002239 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240'cpoptions' 'cpo' string (Vim default: "aABceFs",
2241 Vi default: all flags)
2242 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002244 this indicates Vi-compatible behavior. This is used for things where
2245 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 'cpoptions' stands for "compatible-options".
2247 Commas can be added for readability.
2248 To avoid problems with flags that are added in the future, use the
2249 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002250
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 NOTE: This option is set to the Vi default value when 'compatible' is
2252 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002253
2254 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2255 is saved, 'cpoptions' is set to the Vim default, and the saved value
2256 is restored at the end of the script. Changes to the value of
2257 'cpoptions' will be applied to the saved value, but keep in mind that
2258 removing a flag that is not present when 'cpoptions' is changed has no
2259 effect. In the |.vimrc| file the value is not restored, thus using
2260 `vim9script` in the |.vimrc| file results in using the Vim default.
2261
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002262 NOTE: This option is set to the POSIX default value at startup when
2263 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002264 variable exists |posix|. This means Vim tries to behave like the
2265 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266
2267 contains behavior ~
2268 *cpo-a*
2269 a When included, a ":read" command with a file name
2270 argument will set the alternate file name for the
2271 current window.
2272 *cpo-A*
2273 A When included, a ":write" command with a file name
2274 argument will set the alternate file name for the
2275 current window.
2276 *cpo-b*
2277 b "\|" in a ":map" command is recognized as the end of
2278 the map command. The '\' is included in the mapping,
2279 the text after the '|' is interpreted as the next
2280 command. Use a CTRL-V instead of a backslash to
2281 include the '|' in the mapping. Applies to all
2282 mapping, abbreviation, menu and autocmd commands.
2283 See also |map_bar|.
2284 *cpo-B*
2285 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002286 abbreviations, user commands and the "to" part of the
2287 menu commands. Remove this flag to be able to use a
2288 backslash like a CTRL-V. For example, the command
2289 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 'B' included: "\^[" (^[ is a real <Esc>)
2291 'B' excluded: "<Esc>" (5 characters)
2292 ('<' excluded in both cases)
2293 *cpo-c*
2294 c Searching continues at the end of any match at the
2295 cursor position, but not further than the start of the
2296 next line. When not present searching continues
2297 one character from the cursor position. With 'c'
2298 "abababababab" only gets three matches when repeating
2299 "/abab", without 'c' there are five matches.
2300 *cpo-C*
2301 C Do not concatenate sourced lines that start with a
2302 backslash. See |line-continuation|.
2303 *cpo-d*
2304 d Using "./" in the 'tags' option doesn't mean to use
2305 the tags file relative to the current file, but the
2306 tags file in the current directory.
2307 *cpo-D*
2308 D Can't use CTRL-K to enter a digraph after Normal mode
2309 commands with a character argument, like |r|, |f| and
2310 |t|.
2311 *cpo-e*
2312 e When executing a register with ":@r", always add a
2313 <CR> to the last line, also when the register is not
2314 linewise. If this flag is not present, the register
2315 is not linewise and the last line does not end in a
2316 <CR>, then the last line is put on the command-line
2317 and can be edited before hitting <CR>.
2318 *cpo-E*
2319 E It is an error when using "y", "d", "c", "g~", "gu" or
2320 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002321 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 This makes "y0" fail in the first column.
2323 *cpo-f*
2324 f When included, a ":read" command with a file name
2325 argument will set the file name for the current buffer,
2326 if the current buffer doesn't have a file name yet.
2327 *cpo-F*
2328 F When included, a ":write" command with a file name
2329 argument will set the file name for the current
2330 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002331 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 *cpo-g*
2333 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002334 *cpo-H*
2335 H When using "I" on a line with only blanks, insert
2336 before the last blank. Without this flag insert after
2337 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 *cpo-i*
2339 i When included, interrupting the reading of a file will
2340 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002341 *cpo-I*
2342 I When moving the cursor up or down just after inserting
2343 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344 *cpo-j*
2345 j When joining lines, only add two spaces after a '.',
2346 not after '!' or '?'. Also see 'joinspaces'.
2347 *cpo-J*
2348 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002349 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 white space.
2351 *cpo-k*
2352 k Disable the recognition of raw key codes in
2353 mappings, abbreviations, and the "to" part of menu
2354 commands. For example, if <Key> sends ^[OA (where ^[
2355 is <Esc>), the command ":map X ^[OA" results in X
2356 being mapped to:
2357 'k' included: "^[OA" (3 characters)
2358 'k' excluded: "<Key>" (one key code)
2359 Also see the '<' flag below.
2360 *cpo-K*
2361 K Don't wait for a key code to complete when it is
2362 halfway a mapping. This breaks mapping <F1><F1> when
2363 only part of the second <F1> has been read. It
2364 enables cancelling the mapping by typing <F1><Esc>.
2365 *cpo-l*
2366 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002367 literally, only "\]", "\^", "\-" and "\\" are special.
2368 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2370 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002371 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 *cpo-L*
2373 L When the 'list' option is set, 'wrapmargin',
2374 'textwidth', 'softtabstop' and Virtual Replace mode
2375 (see |gR|) count a <Tab> as two characters, instead of
2376 the normal behavior of a <Tab>.
2377 *cpo-m*
2378 m When included, a showmatch will always wait half a
2379 second. When not included, a showmatch will wait half
2380 a second or until a character is typed. |'showmatch'|
2381 *cpo-M*
2382 M When excluded, "%" matching will take backslashes into
2383 account. Thus in "( \( )" and "\( ( \)" the outer
2384 parenthesis match. When included "%" ignores
2385 backslashes, which is Vi compatible.
2386 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002387 n When included, the column used for 'number' and
2388 'relativenumber' will also be used for text of wrapped
2389 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 *cpo-o*
2391 o Line offset to search command is not remembered for
2392 next search.
2393 *cpo-O*
2394 O Don't complain if a file is being overwritten, even
2395 when it didn't exist when editing it. This is a
2396 protection against a file unexpectedly created by
2397 someone else. Vi didn't complain about this.
2398 *cpo-p*
2399 p Vi compatible Lisp indenting. When not present, a
2400 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002401 *cpo-P*
2402 P When included, a ":write" command that appends to a
2403 file will set the file name for the current buffer, if
2404 the current buffer doesn't have a file name yet and
2405 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002406 *cpo-q*
2407 q When joining multiple lines leave the cursor at the
2408 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 *cpo-r*
2410 r Redo ("." command) uses "/" to repeat a search
2411 command, instead of the actually used search string.
2412 *cpo-R*
2413 R Remove marks from filtered lines. Without this flag
2414 marks are kept like |:keepmarks| was used.
2415 *cpo-s*
2416 s Set buffer options when entering the buffer for the
2417 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002418 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 set when the buffer is created.
2420 *cpo-S*
2421 S Set buffer options always when entering a buffer
2422 (except 'readonly', 'fileformat', 'filetype' and
2423 'syntax'). This is the (most) Vi compatible setting.
2424 The options are set to the values in the current
2425 buffer. When you change an option and go to another
2426 buffer, the value is copied. Effectively makes the
2427 buffer options global to all buffers.
2428
2429 's' 'S' copy buffer options
2430 no no when buffer created
2431 yes no when buffer first entered (default)
2432 X yes each time when buffer entered (vi comp.)
2433 *cpo-t*
2434 t Search pattern for the tag command is remembered for
2435 "n" command. Otherwise Vim only puts the pattern in
2436 the history for search pattern, but doesn't change the
2437 last used search pattern.
2438 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002439 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 *cpo-v*
2441 v Backspaced characters remain visible on the screen in
2442 Insert mode. Without this flag the characters are
2443 erased from the screen right away. With this flag the
2444 screen newly typed text overwrites backspaced
2445 characters.
2446 *cpo-w*
2447 w When using "cw" on a blank character, only change one
2448 character and not all blanks until the start of the
2449 next word.
2450 *cpo-W*
2451 W Don't overwrite a readonly file. When omitted, ":w!"
2452 overwrites a readonly file, if possible.
2453 *cpo-x*
2454 x <Esc> on the command-line executes the command-line.
2455 The default in Vim is to abandon the command-line,
2456 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002457 *cpo-X*
2458 X When using a count with "R" the replaced text is
2459 deleted only once. Also when repeating "R" with "."
2460 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002462 y A yank command can be redone with ".". Think twice if
2463 you really want to use this, it may break some
2464 plugins, since most people expect "." to only repeat a
2465 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002466 *cpo-Z*
2467 Z When using "w!" while the 'readonly' option is set,
2468 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 *cpo-!*
2470 ! When redoing a filter command, use the last used
2471 external command, whatever it was. Otherwise the last
2472 used -filter- command is used.
2473 *cpo-$*
2474 $ When making a change to one line, don't redisplay the
2475 line, but put a '$' at the end of the changed text.
2476 The changed text will be overwritten when you type the
2477 new text. The line is redisplayed if you type any
2478 command that moves the cursor from the insertion
2479 point.
2480 *cpo-%*
2481 % Vi-compatible matching is done for the "%" command.
2482 Does not recognize "#if", "#endif", etc.
2483 Does not recognize "/*" and "*/".
2484 Parens inside single and double quotes are also
2485 counted, causing a string that contains a paren to
2486 disturb the matching. For example, in a line like
2487 "if (strcmp("foo(", s))" the first paren does not
2488 match the last one. When this flag is not included,
2489 parens inside single and double quotes are treated
2490 specially. When matching a paren outside of quotes,
2491 everything inside quotes is ignored. When matching a
2492 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002493 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002494 This flag is also used for other features, such as
2495 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002496 *cpo--*
2497 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002498 it would go above the first line or below the last
2499 line. Without it the cursor moves to the first or
2500 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002501 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002502 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002503 *cpo-+*
2504 + When included, a ":write file" command will reset the
2505 'modified' flag of the buffer, even though the buffer
2506 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002507 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 * Use ":*" in the same way as ":@". When not included,
2509 ":*" is an alias for ":'<,'>", select the Visual area.
2510 *cpo-<*
2511 < Disable the recognition of special key codes in |<>|
2512 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002513 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 ":map X <Tab>" results in X being mapped to:
2515 '<' included: "<Tab>" (5 characters)
2516 '<' excluded: "^I" (^I is a real <Tab>)
2517 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002518 *cpo->*
2519 > When appending to a register, put a line break before
2520 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002521 *cpo-;*
2522 ; When using |,| or |;| to repeat the last |t| search
2523 and the cursor is right in front of the searched
2524 character, the cursor won't move. When not included,
2525 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002526 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002527
2528 POSIX flags. These are not included in the Vi default value, except
2529 when $VIM_POSIX was set on startup. |posix|
2530
2531 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002532 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002533 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002534 *cpo-&*
2535 & When ":preserve" was used keep the swap file when
2536 exiting normally while this buffer is still loaded.
2537 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002538 *cpo-\*
2539 \ Backslash in a [] range in a search pattern is taken
2540 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002541 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2542 '\' excluded: "/[ \-]" finds <Space> and '-'
2543 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002544 *cpo-/*
2545 / When "%" is used as the replacement string in a |:s|
2546 command, use the previous replacement string. |:s%|
2547 *cpo-{*
2548 { The |{| and |}| commands also stop at a "{" character
2549 at the start of a line.
2550 *cpo-.*
2551 . The ":chdir" and ":cd" commands fail if the current
2552 buffer is modified, unless ! is used. Vim doesn't
2553 need this, since it remembers the full path of an
2554 opened file.
2555 *cpo-bar*
2556 | The value of the $LINES and $COLUMNS environment
2557 variables overrule the terminal size values obtained
2558 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002559
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002561 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002562'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002563 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002564 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002565 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002566 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002567 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002568 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002569 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002570 blowfish Blowfish method. Medium strong encryption but it has
2571 an implementation flaw. Requires Vim 7.3 or later,
2572 files can NOT be read by Vim 7.2 and older. This adds
2573 a "seed" to the file, every time you write the file
2574 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002575 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002576 *blowfish2*
2577 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002578 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002579 and older. This adds a "seed" to the file, every time
2580 you write the file the encrypted bytes will be
2581 different. The whole undo file is encrypted, not just
2582 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002583 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002584 *E1197* *E1198* *E1199* *E1200* *E1201*
2585 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2586 Code. Medium strong till strong encryption.
2587 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002588 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002589 It adds a seed and a message authentication code (MAC)
2590 to the file. This needs at least a Vim 8.2.3022 to
2591 read the encrypted file.
2592 Encryption of swap files is not supported, therefore
2593 no swap file will be used when xchacha20 encryption is
2594 enabled.
2595 Encryption of undo files is not yet supported,
2596 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002597 CAREFUL: Files written with this method might have to
2598 be read back with the same version of Vim if the
2599 binary format changes later.
2600 Obsolete, please do no longer use.
2601 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2602 stores the key derivation parameters together with the
2603 encrypted file. Should work better in case the
2604 parameters in the libsodium library ever change.
2605 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002606 might have to be read back with the same version of
2607 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002608
Christian Brabandtaae58342023-04-23 17:50:22 +01002609 You should use "blowfish2", also to re-encrypt older files. The
2610 "xchacha20" method provides better encryption, but it does not work
2611 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002612
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002613 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002614 to the detected method of the file being read. Thus if you write it
2615 without changing 'cryptmethod' the same method will be used.
2616 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002617 explicitly write it, you don't get a warning unless there are other
2618 modifications. Also see |:X|.
2619
2620 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002621 the value "blowfish2". When setting the local value to an empty
2622 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002623
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002624 When a new encryption method is added in a later version of Vim, and
2625 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002626 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002627
2628
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 *'cscopepathcomp'* *'cspc'*
2630'cscopepathcomp' 'cspc' number (default 0)
2631 global
2632 {not available when compiled without the |+cscope|
2633 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 Determines how many components of the path to show in a list of tags.
2635 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002636 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637
2638 *'cscopeprg'* *'csprg'*
2639'cscopeprg' 'csprg' string (default "cscope")
2640 global
2641 {not available when compiled without the |+cscope|
2642 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 Specifies the command to execute cscope. See |cscopeprg|.
2644 This option cannot be set from a |modeline| or in the |sandbox|, for
2645 security reasons.
2646
2647 *'cscopequickfix'* *'csqf'*
2648'cscopequickfix' 'csqf' string (default "")
2649 global
2650 {not available when compiled without the |+cscope|
2651 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 Specifies whether to use quickfix window to show cscope results.
2653 See |cscopequickfix|.
2654
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002655 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002656'cscoperelative' 'csre' boolean (default off)
2657 global
2658 {not available when compiled without the |+cscope|
2659 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002660 In the absence of a prefix (-P) for cscope. setting this option enables
2661 to use the basename of cscope.out path as the prefix.
2662 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002663 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002664
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2666'cscopetag' 'cst' boolean (default off)
2667 global
2668 {not available when compiled without the |+cscope|
2669 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 Use cscope for tag commands. See |cscope-options|.
2671 NOTE: This option is reset when 'compatible' is set.
2672
2673 *'cscopetagorder'* *'csto'*
2674'cscopetagorder' 'csto' number (default 0)
2675 global
2676 {not available when compiled without the |+cscope|
2677 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 Determines the order in which ":cstag" performs a search. See
2679 |cscopetagorder|.
2680 NOTE: This option is set to 0 when 'compatible' is set.
2681
2682 *'cscopeverbose'* *'csverb'*
2683 *'nocscopeverbose'* *'nocsverb'*
2684'cscopeverbose' 'csverb' boolean (default off)
2685 global
2686 {not available when compiled without the |+cscope|
2687 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 Give messages when adding a cscope database. See |cscopeverbose|.
2689 NOTE: This option is reset when 'compatible' is set.
2690
Bram Moolenaar860cae12010-06-05 23:22:07 +02002691 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2692'cursorbind' 'crb' boolean (default off)
2693 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002694 When this option is set, as the cursor in the current
2695 window moves other cursorbound windows (windows that also have
2696 this option set) move their cursors to the corresponding line and
2697 column. This option is useful for viewing the
2698 differences between two versions of a file (see 'diff'); in diff mode,
2699 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002700 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002701
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002702
2703 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2704'cursorcolumn' 'cuc' boolean (default off)
2705 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002706 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002707 feature}
2708 Highlight the screen column of the cursor with CursorColumn
2709 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2710 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002711 If you only want the highlighting in the current window you can use
2712 these autocommands: >
2713 au WinLeave * set nocursorline nocursorcolumn
2714 au WinEnter * set cursorline cursorcolumn
2715<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002716
2717 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2718'cursorline' 'cul' boolean (default off)
2719 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002720 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002721 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002722 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2723 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002724 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002725 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002726
2727
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002728 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002729'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002730 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002731 {not available when compiled without the |+syntax|
2732 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002733 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002734 Valid values:
2735 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002736 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002737 "screenline" Highlight only the screen line of the cursor with
2738 CursorLine |hl-CursorLine|.
2739 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002740 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002741
2742 Special value:
2743 "both" Alias for the values "line,number".
2744
2745 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002746
2747
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 *'debug'*
2749'debug' string (default "")
2750 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002751 These values can be used:
2752 msg Error messages that would otherwise be omitted will be given
2753 anyway.
2754 throw Error messages that would otherwise be omitted will be given
2755 anyway and also throw an exception and set |v:errmsg|.
2756 beep A message will be given when otherwise only a beep would be
2757 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002758 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002759 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2760 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761
2762 *'define'* *'def'*
2763'define' 'def' string (default "^\s*#\s*define")
2764 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002765 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 pattern, just like for the "/" command. This option is used for the
2767 commands like "[i" and "[d" |include-search|. The 'isident' option is
2768 used to recognize the defined name after the match:
2769 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2770 See |option-backslash| about inserting backslashes to include a space
2771 or backslash.
2772 The default value is for C programs. For C++ this value would be
2773 useful, to include const type declarations: >
2774 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002775< You can also use "\ze" just before the name and continue the pattern
2776 to check what is following. E.g. for Javascript, if a function is
2777 defined with "func_name = function(args)": >
2778 ^\s*\ze\i\+\s*=\s*function(
2779< If the function is defined with "func_name : function() {...": >
2780 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002782 To avoid that use `:let` with a single quote string: >
2783 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002784<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785
2786 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2787'delcombine' 'deco' boolean (default off)
2788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 If editing Unicode and this option is set, backspace and Normal mode
2790 "x" delete each combining character on its own. When it is off (the
2791 default) the character along with its combining characters are
2792 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002793 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794
2795 This is useful for Arabic, Hebrew and many other languages where one
2796 may have combining characters overtop of base characters, and want
2797 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002798 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799
2800 *'dictionary'* *'dict'*
2801'dictionary' 'dict' string (default "")
2802 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803 List of file names, separated by commas, that are used to lookup words
2804 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2805 contain a list of words. This can be one word per line, or several
2806 words per line, separated by non-keyword characters (white space is
2807 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002808
2809 When this option is empty or an entry "spell" is present, and spell
2810 checking is enabled, words in the word lists for the currently active
2811 'spelllang' are used. See |spell|.
2812
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002813 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 after a comma are ignored, otherwise spaces are included in the file
2815 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002816 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 Where to find a list of words?
2818 - On FreeBSD, there is the file "/usr/share/dict/words".
2819 - In the Simtel archive, look in the "msdos/linguist" directory.
2820 - In "miscfiles" of the GNU collection.
2821 The use of |:set+=| and |:set-=| is preferred when adding or removing
2822 directories from the list. This avoids problems when a future version
2823 uses another default.
2824 Backticks cannot be used in this option for security reasons.
2825
2826 *'diff'* *'nodiff'*
2827'diff' boolean (default off)
2828 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 {not available when compiled without the |+diff|
2830 feature}
2831 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002832 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833
2834 *'dex'* *'diffexpr'*
2835'diffexpr' 'dex' string (default "")
2836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 {not available when compiled without the |+diff|
2838 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002839 Expression which is evaluated to obtain a diff file (either ed-style
2840 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 This option cannot be set from a |modeline| or in the |sandbox|, for
2842 security reasons.
2843
2844 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002845'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 {not available when compiled without the |+diff|
2848 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002849 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 All are optional. Items must be separated by a comma.
2851
2852 filler Show filler lines, to keep the text
2853 synchronized with a window that has inserted
2854 lines at the same position. Mostly useful
2855 when windows are side-by-side and 'scrollbind'
2856 is set.
2857
2858 context:{n} Use a context of {n} lines between a change
2859 and a fold that contains unchanged lines.
2860 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002861 When using zero the context is actually one,
2862 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002863 for a deleted line. Set it to a very large
2864 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 See |fold-diff|.
2866
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002867 iblank Ignore changes where lines are all blank. Adds
2868 the "-B" flag to the "diff" command if
2869 'diffexpr' is empty. Check the documentation
2870 of the "diff" command for what this does
2871 exactly.
2872 NOTE: the diff windows will get out of sync,
2873 because no differences between blank lines are
2874 taken into account.
2875
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 icase Ignore changes in case of text. "a" and "A"
2877 are considered the same. Adds the "-i" flag
2878 to the "diff" command if 'diffexpr' is empty.
2879
2880 iwhite Ignore changes in amount of white space. Adds
2881 the "-b" flag to the "diff" command if
2882 'diffexpr' is empty. Check the documentation
2883 of the "diff" command for what this does
2884 exactly. It should ignore adding trailing
2885 white space, but not leading white space.
2886
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002887 iwhiteall Ignore all white space changes. Adds
2888 the "-w" flag to the "diff" command if
2889 'diffexpr' is empty. Check the documentation
2890 of the "diff" command for what this does
2891 exactly.
2892
2893 iwhiteeol Ignore white space changes at end of line.
2894 Adds the "-Z" flag to the "diff" command if
2895 'diffexpr' is empty. Check the documentation
2896 of the "diff" command for what this does
2897 exactly.
2898
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002899 horizontal Start diff mode with horizontal splits (unless
2900 explicitly specified otherwise).
2901
2902 vertical Start diff mode with vertical splits (unless
2903 explicitly specified otherwise).
2904
Bram Moolenaarc8234772019-11-10 21:00:27 +01002905 closeoff When a window is closed where 'diff' is set
2906 and there is only one window remaining in the
2907 same tab page with 'diff' set, execute
2908 `:diffoff` in that window. This undoes a
2909 `:diffsplit` command.
2910
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002911 hiddenoff Do not use diff mode for a buffer when it
2912 becomes hidden.
2913
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002914 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2915 starting diff mode. Without this 2 is used.
2916
Bram Moolenaar4223d432021-02-10 13:18:17 +01002917 followwrap Follow the 'wrap' option and leave as it is.
2918
Bram Moolenaare828b762018-09-10 17:51:58 +02002919 internal Use the internal diff library. This is
2920 ignored when 'diffexpr' is set. *E960*
2921 When running out of memory when writing a
2922 buffer this item will be ignored for diffs
2923 involving that buffer. Set the 'verbose'
2924 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925
Bram Moolenaare828b762018-09-10 17:51:58 +02002926 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002927 Use the indent heuristic for the internal
2928 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002929
2930 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002931 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002932 algorithms are:
2933 myers the default algorithm
2934 minimal spend extra time to generate the
2935 smallest possible diff
2936 patience patience diff algorithm
2937 histogram histogram diff algorithm
2938
2939 Examples: >
2940 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002942 :set diffopt=internal,filler,foldcolumn:3
2943 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944<
2945 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2946'digraph' 'dg' boolean (default off)
2947 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 {not available when compiled without the |+digraphs|
2949 feature}
2950 Enable the entering of digraphs in Insert mode with {char1} <BS>
2951 {char2}. See |digraphs|.
2952 NOTE: This option is reset when 'compatible' is set.
2953
2954 *'directory'* *'dir'*
2955'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002956 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 for Unix: ".,~/tmp,/var/tmp,/tmp")
2958 global
2959 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002960 Recommended value: ".,~/vimswap//" - this will put the swap file next
2961 to the edited file if possible, and in your personal swap directory
2962 otherwise. Make sure "~/vimswap//" is only readable for you.
2963
2964 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 - The swap file will be created in the first directory where this is
2966 possible.
2967 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002968 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 - A directory "." means to put the swap file in the same directory as
2970 the edited file. On Unix, a dot is prepended to the file name, so
2971 it doesn't show in a directory listing. On MS-Windows the "hidden"
2972 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002973 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2974 the swap file relative to where the edited file is. The leading "."
2975 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002976 - For Unix and Win32, if a directory ends in two path separators "//",
2977 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002978 with all path separators replaced by percent '%' signs (including
2979 the colon following the drive letter on Win32). This will ensure
2980 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002981 On Win32, it is also possible to end with "\\". However, When a
2982 separating comma is following, you must use "//", since "\\" will
2983 include the comma in the file name. Therefore it is recommended to
2984 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 - Spaces after the comma are ignored, other spaces are considered part
2986 of the directory name. To have a space at the start of a directory
2987 name, precede it with a backslash.
2988 - To include a comma in a directory name precede it with a backslash.
2989 - A directory name may end in an ':' or '/'.
2990 - Environment variables are expanded |:set_env|.
2991 - Careful with '\' characters, type one before a space, type two to
2992 get one in the option (see |option-backslash|), for example: >
2993 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2994< - For backwards compatibility with Vim version 3.0 a '>' at the start
2995 of the option is removed.
2996 Using "." first in the list is recommended. This means that editing
2997 the same file twice will result in a warning. Using "/tmp" on Unix is
2998 discouraged: When the system crashes you lose the swap file.
2999 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003000 choice than "/tmp". But others on the computer may be able to see the
3001 files, and it can contain a lot of files, your swap files get lost in
3002 the crowd. That is why a "tmp" directory in your home directory is
3003 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 The use of |:set+=| and |:set-=| is preferred when adding or removing
3005 directories from the list. This avoids problems when a future version
3006 uses another default.
3007 This option cannot be set from a |modeline| or in the |sandbox|, for
3008 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009
3010 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003011'display' 'dy' string (default "", set to "truncate" in
3012 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003014 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 flags:
3016 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003017 in a window will be displayed. "@@@" is put in the
3018 last columns of the last screen line to indicate the
3019 rest of the line is not displayed.
3020 truncate Like "lastline", but "@@@" is displayed in the first
3021 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 uhex Show unprintable characters hexadecimal as <xx>
3023 instead of using ^C and ~C.
3024
Bram Moolenaard0796902016-09-16 20:02:31 +02003025 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003026 doesn't fit is replaced with "@" lines.
3027
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003028 The "@" character can be changed by setting the "lastline" item in
3029 'fillchars'. The character is highlighted with |hl-NonText|.
3030
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 *'eadirection'* *'ead'*
3032'eadirection' 'ead' string (default "both")
3033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 Tells when the 'equalalways' option applies:
3035 ver vertically, width of windows is not affected
3036 hor horizontally, height of windows is not affected
3037 both width and height of windows is affected
3038
3039 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3040'edcompatible' 'ed' boolean (default off)
3041 global
3042 Makes the 'g' and 'c' flags of the ":substitute" command to be
3043 toggled each time the flag is given. See |complex-change|. See
3044 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003045 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003046 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047
Bram Moolenaar03413f42016-04-12 21:07:15 +02003048 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003049'emoji' 'emo' boolean (default: on)
3050 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003051 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003052 This excludes "text emoji" characters, which are normally displayed as
3053 single width. Unfortunately there is no good specification for this
3054 and it has been determined on trial-and-error basis. Use the
3055 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003056
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003058'encoding' 'enc' string (default for MS-Windows: "utf-8",
3059 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 Sets the character encoding used inside Vim. It applies to text in
3062 the buffers, registers, Strings in expressions, text stored in the
3063 viminfo file, etc. It sets the kind of characters which Vim can work
3064 with. See |encoding-names| for the possible values.
3065
3066 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003067 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003069 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070
Bram Moolenaar865242e2010-07-14 21:12:05 +02003071 This option cannot be set from a |modeline|. It would most likely
3072 corrupt the text.
3073
Bram Moolenaar3df01732017-02-17 22:47:16 +01003074 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3075 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 'encoding', "utf-8" is the natural choice for the environment and
3077 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003078 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 versions, and to avoid changing the encoding of newly created files
3080 without your knowledge (in case 'fileencodings' is empty).
3081
3082 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003083 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 iconv() or as specified with 'charconvert'.
3085
Bram Moolenaar207f0092020-08-30 17:20:20 +02003086 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003087 can use: >
3088 if has("multi_byte_encoding")
3089<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 Normally 'encoding' will be equal to your current locale. This will
3091 be the default if Vim recognizes your environment settings. If
3092 'encoding' is not set to the current locale, 'termencoding' must be
3093 set to convert typed and displayed text. See |encoding-table|.
3094
3095 When you set this option, it fires the |EncodingChanged| autocommand
3096 event so that you can set up fonts if necessary.
3097
3098 When the option is set, the value is converted to lowercase. Thus
3099 you can set it with uppercase values too. Underscores are translated
3100 to '-' signs.
3101 When the encoding is recognized, it is changed to the standard name.
3102 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3103 "iso-8859-2" and "utf8" becomes "utf-8".
3104
3105 Note: "latin1" is also used when the encoding could not be detected.
3106 This only works when editing files in the same encoding! When the
3107 actual character set is not latin1, make sure 'fileencoding' and
3108 'fileencodings' are empty. When conversion is needed, switch to using
3109 utf-8.
3110
3111 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3112 You don't notice this while editing, but it does matter for the
3113 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3114 setting 'encoding' to one of these values instead of utf-8 only has
3115 effect for encoding used for files when 'fileencoding' is empty.
3116
Bram Moolenaar661b1822005-07-28 22:36:45 +00003117 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3118 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003120 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003121'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003123 Indicates that a CTRL-Z character was found at the end of the file
3124 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003126 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003127 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003128 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003129
3130 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3131'endofline' 'eol' boolean (default on)
3132 local to buffer
3133 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003134 is on, or 'fixeol' option is off, no <EOL> will be written for the
3135 last line in the file. This option is automatically set or reset when
3136 starting to edit a new file, depending on whether file has an <EOL>
3137 for the last line in the file. Normally you don't have to set or
3138 reset this option.
3139 When 'binary' is off and 'fixeol' is on the value is not used when
3140 writing the file. When 'binary' is on or 'fixeol' is off it is used
3141 to remember the presence of a <EOL> for the last line in the file, so
3142 that when you write the file the situation from the original file can
3143 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003144 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145
3146 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3147'equalalways' 'ea' boolean (default on)
3148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003150 splitting or closing a window. This also happens the moment the
3151 option is switched on. When off, splitting a window will reduce the
3152 size of the current window and leave the other windows the same. When
3153 closing a window the extra lines are given to the window next to it
3154 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 When mixing vertically and horizontally split windows, a minimal size
3156 is computed and some windows may be larger if there is room. The
3157 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003158 Changing the height and width of a window can be avoided by setting
3159 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003160 If a window size is specified when creating a new window sizes are
3161 currently not equalized (it's complicated, but may be implemented in
3162 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163
3164 *'equalprg'* *'ep'*
3165'equalprg' 'ep' string (default "")
3166 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003168 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003169 or 'indentexpr'. When Vim was compiled without internal formatting,
3170 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003171 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 about including spaces and backslashes.
3173 This option cannot be set from a |modeline| or in the |sandbox|, for
3174 security reasons.
3175
3176 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3177'errorbells' 'eb' boolean (default off)
3178 global
3179 Ring the bell (beep or screen flash) for error messages. This only
3180 makes a difference for error messages, the bell will be used always
3181 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003182 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003183 screen flash or do nothing. See 'belloff' to finetune when to ring the
3184 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185
3186 *'errorfile'* *'ef'*
3187'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3188 others: "errors.err")
3189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 {not available when compiled without the |+quickfix|
3191 feature}
3192 Name of the errorfile for the QuickFix mode (see |:cf|).
3193 When the "-q" command-line argument is used, 'errorfile' is set to the
3194 following argument. See |-q|.
3195 NOT used for the ":make" command. See 'makeef' for that.
3196 Environment variables are expanded |:set_env|.
3197 See |option-backslash| about including spaces and backslashes.
3198 This option cannot be set from a |modeline| or in the |sandbox|, for
3199 security reasons.
3200
3201 *'errorformat'* *'efm'*
3202'errorformat' 'efm' string (default is very long)
3203 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 {not available when compiled without the |+quickfix|
3205 feature}
3206 Scanf-like description of the format for the lines in the error file
3207 (see |errorformat|).
3208
3209 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3210'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 Function keys that start with an <Esc> are recognized in Insert
3213 mode. When this option is off, the cursor and function keys cannot be
3214 used in Insert mode if they start with an <Esc>. The advantage of
3215 this is that the single <Esc> is recognized immediately, instead of
3216 after one second. Instead of resetting this option, you might want to
3217 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3218 when 'esckeys' is off, you can still map anything, but the cursor keys
3219 won't work by default.
3220 NOTE: This option is set to the Vi default value when 'compatible' is
3221 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003222 NOTE: when this option is off then the |modifyOtherKeys| and
3223 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3224 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225
3226 *'eventignore'* *'ei'*
3227'eventignore' 'ei' string (default "")
3228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003230 When set to "all" or when "all" is one of the items, all autocommand
3231 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003232 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 :set ei=WinEnter,WinLeave
3234<
3235 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3236'expandtab' 'et' boolean (default off)
3237 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003239 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3241 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003242 This option is reset when the 'paste' option is set and restored when
3243 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 NOTE: This option is reset when 'compatible' is set.
3245
3246 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3247'exrc' 'ex' boolean (default off)
3248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003250 directory.
3251
3252 Setting this option is a potential security leak. E.g., consider
3253 unpacking a package or fetching files from github, a .vimrc in there
3254 might be a trojan horse. BETTER NOT SET THIS OPTION!
3255 Instead, define an autocommand in your .vimrc to set options for a
3256 matching directory.
3257
3258 If you do switch this option on you should also consider setting the
3259 'secure' option (see |initialization|).
3260 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 This option cannot be set from a |modeline| or in the |sandbox|, for
3262 security reasons.
3263
3264 *'fileencoding'* *'fenc'* *E213*
3265'fileencoding' 'fenc' string (default: "")
3266 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003268
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003270 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 When 'fileencoding' is empty, the same value as 'encoding' will be
3272 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003273 No error will be given when the value is set, only when it is used,
3274 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003275 Conversion will also be done when 'encoding' and 'fileencoding' are
3276 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3277 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003279 'encoding' is "utf-8" or another Unicode encoding, conversion
3280 is most likely done in a way that the reverse conversion
3281 results in the same text. When 'encoding' is not "utf-8" some
3282 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003283
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 See 'encoding' for the possible values. Additionally, values may be
3285 specified that can be handled by the converter, see
3286 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003287
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 When reading a file 'fileencoding' will be set from 'fileencodings'.
3289 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003290 'fileencoding', use the |++enc| argument. One exception: when
3291 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003292 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003293
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3295 When the option is set, the value is converted to lowercase. Thus
3296 you can set it with uppercase values too. '_' characters are
3297 replaced with '-'. If a name is recognized from the list for
3298 'encoding', it is replaced by the standard name. For example
3299 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003300
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 When this option is set, after starting to edit a file, the 'modified'
3302 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003303
3304 Keep in mind that changing 'fenc' from a modeline happens
3305 AFTER the text has been read, thus it applies to when the file will be
3306 written. If you do set 'fenc' in a modeline, you might want to set
3307 'nomodified' to avoid not being able to ":q".
3308
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 This option can not be changed when 'modifiable' is off.
3310
3311 *'fe'*
3312 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003313 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 old short name was 'fe', which is no longer used.
3315
3316 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003317'fileencodings' 'fencs' string (default: "ucs-bom",
3318 "ucs-bom,utf-8,default,latin1" when
3319 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 This is a list of character encodings considered when starting to edit
3322 an existing file. When a file is read, Vim tries to use the first
3323 mentioned character encoding. If an error is detected, the next one
3324 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003325 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 an empty string, which means the value of 'encoding' is used.
3327 WARNING: Conversion can cause loss of information! When
3328 'encoding' is "utf-8" (or one of the other Unicode variants)
3329 conversion is most likely done in a way that the reverse
3330 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003331 "utf-8" some non-ASCII characters may be lost! You can use
3332 the |++bad| argument to specify what is done with characters
3333 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 For an empty file or a file with only ASCII characters most encodings
3335 will work and the first entry of 'fileencodings' will be used (except
3336 "ucs-bom", which requires the BOM to be present). If you prefer
3337 another encoding use an BufReadPost autocommand event to test if your
3338 preferred encoding is to be used. Example: >
3339 au BufReadPost * if search('\S', 'w') == 0 |
3340 \ set fenc=iso-2022-jp | endif
3341< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3342 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003343 When the |++enc| argument is used then the value of 'fileencodings' is
3344 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003345 Note that 'fileencodings' is not used for a new file, the global value
3346 of 'fileencoding' is used instead. You can set it with: >
3347 :setglobal fenc=iso-8859-2
3348< This means that a non-existing file may get a different encoding than
3349 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 The special value "ucs-bom" can be used to check for a Unicode BOM
3351 (Byte Order Mark) at the start of the file. It must not be preceded
3352 by "utf-8" or another Unicode encoding for this to work properly.
3353 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3354 because Vim cannot detect an error, thus the encoding is always
3355 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003356 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003357 environment. On MS-Windows this is the system encoding. Otherwise
3358 this is the default value for 'encoding'. It is useful when
3359 'encoding' is set to "utf-8" and your environment uses a non-latin1
3360 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003361 When 'encoding' is "utf-8" and a file contains an illegal byte
3362 sequence it won't be recognized as UTF-8. You can use the |8g8|
3363 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 WRONG VALUES: WHAT'S WRONG:
3365 latin1,utf-8 "latin1" will always be used
3366 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3367 file
3368 cp1250,latin1 "cp1250" will always be used
3369 If 'fileencodings' is empty, 'fileencoding' is not modified.
3370 See 'fileencoding' for the possible values.
3371 Setting this option does not have an effect until the next time a file
3372 is read.
3373
3374 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003375'fileformat' 'ff' string (MS-Windows default: "dos",
3376 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 This gives the <EOL> of the current buffer, which is used for
3379 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003380 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 unix <NL>
3382 mac <CR>
3383 When "dos" is used, CTRL-Z at the end of a file is ignored.
3384 See |file-formats| and |file-read|.
3385 For the character encoding of the file see 'fileencoding'.
3386 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003387 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 This option is set automatically when starting to edit a file and
3389 'fileformats' is not empty and 'binary' is off.
3390 When this option is set, after starting to edit a file, the 'modified'
3391 option is set, because the file would be different when written.
3392 This option can not be changed when 'modifiable' is off.
3393 For backwards compatibility: When this option is set to "dos",
3394 'textmode' is set, otherwise 'textmode' is reset.
3395
3396 *'fileformats'* *'ffs'*
3397'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003398 Vim+Vi MS-Windows: "dos,unix",
3399 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 Vi Cygwin: "unix,dos",
3401 Vi others: "")
3402 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 This gives the end-of-line (<EOL>) formats that will be tried when
3404 starting to edit a new buffer and when reading a file into an existing
3405 buffer:
3406 - When empty, the format defined with 'fileformat' will be used
3407 always. It is not set automatically.
3408 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003409 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 'fileformats' name will be used when a file is read into an existing
3411 buffer, no matter what 'fileformat' for that buffer is set to.
3412 - When more than one name is present, separated by commas, automatic
3413 <EOL> detection will be done when reading a file. When starting to
3414 edit a file, a check is done for the <EOL>:
3415 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3416 'fileformat' is set to "dos".
3417 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003418 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003420 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3421 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003422 This means that "mac" is only chosen when:
3423 "unix" is not present or no <NL> is found in the file, and
3424 "dos" is not present or no <CR><NL> is found in the file.
3425 Except: if "unix" was chosen, but there is a <CR> before
3426 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003427 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 4. If 'fileformat' is still not set, the first name from
3429 'fileformats' is used.
3430 When reading a file into an existing buffer, the same is done, but
3431 this happens like 'fileformat' has been set appropriately for that
3432 file only, the option is not changed.
3433 When 'binary' is set, the value of 'fileformats' is not used.
3434
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003435 When Vim starts up with an empty buffer the first item is used. You
3436 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003437
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3439 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3440 done:
3441 - When 'fileformats' is empty, there is no automatic detection. Dos
3442 format will be used.
3443 - When 'fileformats' is set to one or more names, automatic detection
3444 is done. This is based on the first <NL> in the file: If there is a
3445 <CR> in front of it, Dos format is used, otherwise Unix format is
3446 used.
3447 Also see |file-formats|.
3448 For backwards compatibility: When this option is set to an empty
3449 string or one format (no comma is included), 'textauto' is reset,
3450 otherwise 'textauto' is set.
3451 NOTE: This option is set to the Vi default value when 'compatible' is
3452 set and to the Vim default value when 'compatible' is reset.
3453
Bram Moolenaarbf884932013-04-05 22:26:15 +02003454 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3455'fileignorecase' 'fic' boolean (default on for systems where case in file
3456 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003457 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003458 When set case is ignored when using file names and directories.
3459 See 'wildignorecase' for only ignoring case when doing completion.
3460
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 *'filetype'* *'ft'*
3462'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003463 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 When this option is set, the FileType autocommand event is triggered.
3465 All autocommands that match with the value of this option will be
3466 executed. Thus the value of 'filetype' is used in place of the file
3467 name.
3468 Otherwise this option does not always reflect the current file type.
3469 This option is normally set when the file type is detected. To enable
3470 this use the ":filetype on" command. |:filetype|
3471 Setting this option to a different value is most useful in a modeline,
3472 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003473 Example, for in an IDL file:
3474 /* vim: set filetype=idl : */ ~
3475 |FileType| |filetypes|
3476 When a dot appears in the value then this separates two filetype
3477 names. Example:
3478 /* vim: set filetype=c.doxygen : */ ~
3479 This will use the "c" filetype first, then the "doxygen" filetype.
3480 This works both for filetype plugins and for syntax files. More than
3481 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 This option is not copied to another buffer, independent of the 's' or
3483 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003484 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485
3486 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003487'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003488 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003489 {not available when compiled without the |+folding|
3490 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003491 Characters to fill the statuslines, vertical separators and special
3492 lines in the window.
3493 It is a comma-separated list of items. Each item has a name, a colon
3494 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003496 item name default Used for ~
3497 stl ' ' or '^' statusline of the current window
3498 stlnc ' ' or '=' statusline of the non-current windows
3499 vert '|' vertical separators |:vsplit|
3500 fold '-' filling 'foldtext'
3501 foldopen '-' mark the beginning of a fold
3502 foldclose '+' show a closed fold
3503 foldsep '|' open fold middle character
3504 diff '-' deleted lines of the 'diff' option
3505 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003506 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003508 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003509 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 otherwise.
3511
3512 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003513 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514< This is similar to the default, except that these characters will also
3515 be used when there is highlighting.
3516
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003517 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3518 single-byte and multibyte characters are supported. But double-width
3519 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003520
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003522 item name highlight group ~
3523 stl StatusLine |hl-StatusLine|
3524 stlnc StatusLineNC |hl-StatusLineNC|
3525 vert VertSplit |hl-VertSplit|
3526 fold Folded |hl-Folded|
3527 diff DiffDelete |hl-DiffDelete|
3528 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003529 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003531 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3532'fixendofline' 'fixeol' boolean (default on)
3533 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003534 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003535 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003536 preserve the situation from the original file.
3537 When the 'binary' option is set the value of this option doesn't
3538 matter.
3539 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003540 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003541
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003543'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 {only available when compiled with the |+rightleft|
3546 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003547 This option was for using Farsi, which has been removed. See
3548 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549
3550 *'foldclose'* *'fcl'*
3551'foldclose' 'fcl' string (default "")
3552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 {not available when compiled without the |+folding|
3554 feature}
3555 When set to "all", a fold is closed when the cursor isn't in it and
3556 its level is higher than 'foldlevel'. Useful if you want folds to
3557 automatically close when moving out of them.
3558
3559 *'foldcolumn'* *'fdc'*
3560'foldcolumn' 'fdc' number (default 0)
3561 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 {not available when compiled without the |+folding|
3563 feature}
3564 When non-zero, a column with the specified width is shown at the side
3565 of the window which indicates open and closed folds. The maximum
3566 value is 12.
3567 See |folding|.
3568
3569 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3570'foldenable' 'fen' boolean (default on)
3571 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 {not available when compiled without the |+folding|
3573 feature}
3574 When off, all folds are open. This option can be used to quickly
3575 switch between showing all text unfolded and viewing the text with
3576 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003577 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 'foldenable' is off.
3579 This option is set by commands that create a new fold or close a fold.
3580 See |folding|.
3581
3582 *'foldexpr'* *'fde'*
3583'foldexpr' 'fde' string (default: "0")
3584 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003586 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003588 for each line to obtain its fold level. The context is set to the
3589 script where 'foldexpr' was set, script-local items can be accessed.
3590 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003591
Bram Moolenaar30b65812012-07-12 22:01:11 +02003592 The expression will be evaluated in the |sandbox| if set from a
3593 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003594 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003595 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003596
3597 It is not allowed to change text or jump to another window while
3598 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599
3600 *'foldignore'* *'fdi'*
3601'foldignore' 'fdi' string (default: "#")
3602 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 {not available when compiled without the |+folding|
3604 feature}
3605 Used only when 'foldmethod' is "indent". Lines starting with
3606 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003607 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 The default "#" works well for C programs. See |fold-indent|.
3609
3610 *'foldlevel'* *'fdl'*
3611'foldlevel' 'fdl' number (default: 0)
3612 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 {not available when compiled without the |+folding|
3614 feature}
3615 Sets the fold level: Folds with a higher level will be closed.
3616 Setting this option to zero will close all folds. Higher numbers will
3617 close fewer folds.
3618 This option is set by commands like |zm|, |zM| and |zR|.
3619 See |fold-foldlevel|.
3620
3621 *'foldlevelstart'* *'fdls'*
3622'foldlevelstart' 'fdls' number (default: -1)
3623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 {not available when compiled without the |+folding|
3625 feature}
3626 Sets 'foldlevel' when starting to edit another buffer in a window.
3627 Useful to always start editing with all folds closed (value zero),
3628 some folds closed (one) or no folds closed (99).
3629 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003630 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 ignores this option and closes all folds.
3632 It is also done before BufReadPre autocommands, to allow an autocmd to
3633 overrule the 'foldlevel' value for specific files.
3634 When the value is negative, it is not used.
3635
3636 *'foldmarker'* *'fmr'* *E536*
3637'foldmarker' 'fmr' string (default: "{{{,}}}")
3638 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 {not available when compiled without the |+folding|
3640 feature}
3641 The start and end marker used when 'foldmethod' is "marker". There
3642 must be one comma, which separates the start and end marker. The
3643 marker is a literal string (a regular expression would be too slow).
3644 See |fold-marker|.
3645
3646 *'foldmethod'* *'fdm'*
3647'foldmethod' 'fdm' string (default: "manual")
3648 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 {not available when compiled without the |+folding|
3650 feature}
3651 The kind of folding used for the current window. Possible values:
3652 |fold-manual| manual Folds are created manually.
3653 |fold-indent| indent Lines with equal indent form a fold.
3654 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3655 |fold-marker| marker Markers are used to specify folds.
3656 |fold-syntax| syntax Syntax highlighting items specify folds.
3657 |fold-diff| diff Fold text that is not changed.
3658
3659 *'foldminlines'* *'fml'*
3660'foldminlines' 'fml' number (default: 1)
3661 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 {not available when compiled without the |+folding|
3663 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003664 Sets the number of screen lines above which a fold can be displayed
3665 closed. Also for manually closed folds. With the default value of
3666 one a fold can only be closed if it takes up two or more screen lines.
3667 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003668 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 "zc" to close a fold, which is displayed open because it's smaller
3670 than 'foldminlines', a following "zc" may close a containing fold.
3671
3672 *'foldnestmax'* *'fdn'*
3673'foldnestmax' 'fdn' number (default: 20)
3674 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 {not available when compiled without the |+folding|
3676 feature}
3677 Sets the maximum nesting of folds for the "indent" and "syntax"
3678 methods. This avoids that too many folds will be created. Using more
3679 than 20 doesn't work, because the internal limit is 20.
3680
3681 *'foldopen'* *'fdo'*
3682'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3683 search,tag,undo")
3684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 {not available when compiled without the |+folding|
3686 feature}
3687 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003688 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003690 NOTE: When the command is part of a mapping this option is not used.
3691 Add the |zv| command to the mapping to get the same effect.
3692 (rationale: the mapping may want to control opening folds itself)
3693
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 item commands ~
3695 all any
3696 block "(", "{", "[[", "[{", etc.
3697 hor horizontal movements: "l", "w", "fx", etc.
3698 insert any command in Insert mode
3699 jump far jumps: "G", "gg", etc.
3700 mark jumping to a mark: "'m", CTRL-O, etc.
3701 percent "%"
3702 quickfix ":cn", ":crew", ":make", etc.
3703 search search for a pattern: "/", "n", "*", "gd", etc.
3704 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003705 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 tag jumping to a tag: ":ta", CTRL-T, etc.
3707 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 When a movement command is used for an operator (e.g., "dl" or "y%")
3709 this option is not used. This means the operator will include the
3710 whole closed fold.
3711 Note that vertical movements are not here, because it would make it
3712 very difficult to move onto a closed fold.
3713 In insert mode the folds containing the cursor will always be open
3714 when text is inserted.
3715 To close folds you can re-apply 'foldlevel' with the |zx| command or
3716 set the 'foldclose' option to "all".
3717
3718 *'foldtext'* *'fdt'*
3719'foldtext' 'fdt' string (default: "foldtext()")
3720 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 {not available when compiled without the |+folding|
3722 feature}
3723 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003724 fold. The context is set to the script where 'foldexpr' was set,
3725 script-local items can be accessed. See |fold-foldtext| for the
3726 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727
Bram Moolenaar30b65812012-07-12 22:01:11 +02003728 The expression will be evaluated in the |sandbox| if set from a
3729 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003730 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003731
3732 It is not allowed to change text or jump to another window while
3733 evaluating 'foldtext' |textlock|.
3734
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003735 *'formatexpr'* *'fex'*
3736'formatexpr' 'fex' string (default "")
3737 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003738 {not available when compiled without the |+eval|
3739 feature}
3740 Expression which is evaluated to format a range of lines for the |gq|
3741 operator or automatic formatting (see 'formatoptions'). When this
3742 option is empty 'formatprg' is used.
3743
3744 The |v:lnum| variable holds the first line to be formatted.
3745 The |v:count| variable holds the number of lines to be formatted.
3746 The |v:char| variable holds the character that is going to be
3747 inserted if the expression is being evaluated due to
3748 automatic formatting. This can be empty. Don't insert
3749 it yet!
3750
3751 Example: >
3752 :set formatexpr=mylang#Format()
3753< This will invoke the mylang#Format() function in the
3754 autoload/mylang.vim file in 'runtimepath'. |autoload|
3755
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003756 The advantage of using a function call without arguments is that it is
3757 faster, see |expr-option-function|.
3758
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003759 The expression is also evaluated when 'textwidth' is set and adding
3760 text beyond that limit. This happens under the same conditions as
3761 when internal formatting is used. Make sure the cursor is kept in the
3762 same spot relative to the text then! The |mode()| function will
3763 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003764
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003765 When the expression evaluates to non-zero Vim will fall back to using
3766 the internal format mechanism.
3767
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003768 If the expression starts with s: or |<SID>|, then it is replaced with
3769 the script ID (|local-function|). Example: >
3770 set formatexpr=s:MyFormatExpr()
3771 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003772< Otherwise, the expression is evaluated in the context of the script
3773 where the option was set, thus script-local items are available.
3774
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003775 The expression will be evaluated in the |sandbox| when set from a
3776 modeline, see |sandbox-option|. That stops the option from working,
3777 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003778 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003779 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003780
Bram Moolenaar86b68352004-12-27 21:59:20 +00003781 *'formatlistpat'* *'flp'*
3782'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3783 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003784 A pattern that is used to recognize a list header. This is used for
3785 the "n" flag in 'formatoptions'.
3786 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003787 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003788 while still checking more characters. There must be a character
3789 following the pattern, when it matches the whole line it is handled
3790 like there is no match.
3791 The default recognizes a number, followed by an optional punctuation
3792 character and white space.
3793
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003794 *'formatoptions'* *'fo'*
3795'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3796 local to buffer
3797 This is a sequence of letters which describes how automatic
3798 formatting is to be done. See |fo-table|. When the 'paste' option is
3799 on, no formatting is done (like 'formatoptions' is empty). Commas can
3800 be inserted for readability.
3801 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.
Bram Moolenaar21020352017-06-13 17:21:04 +02003852 DEPRECATED: Setting this option may break plugins that are not aware
3853 of this option. Also, many users get confused that adding the /g flag
3854 has the opposite effect of that it normally does.
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
4016 {only for GTK GUI}
4017 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
4753
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004755'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 A list of keys that, when typed in Insert mode, cause reindenting of
4758 the current line. Only happens if 'indentexpr' isn't empty.
4759 The format is identical to 'cinkeys', see |indentkeys-format|.
4760 See |C-indenting| and |indent-expression|.
4761
4762 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4763'infercase' 'inf' boolean (default off)
4764 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004766 'ignorecase' is also on, the case of the match is adjusted depending
4767 on the typed text. If the typed text contains a lowercase letter
4768 where the match has an upper case letter, the completed part is made
4769 lowercase. If the typed text has no lowercase letters and the match
4770 has a lowercase letter where the typed text has an uppercase letter,
4771 and there is a letter before it, the completed part is made uppercase.
4772 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773
4774 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4775'insertmode' 'im' boolean (default off)
4776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 Makes Vim work in a way that Insert mode is the default mode. Useful
4778 if you want to use Vim as a modeless editor. Used for |evim|.
4779 These Insert mode commands will be useful:
4780 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004781 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 this is a mapping, it is executed as if 'insertmode' was off.
4783 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004785 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4786 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787
4788 These items change when 'insertmode' is set:
4789 - when starting to edit of a file, Vim goes to Insert mode.
4790 - <Esc> in Insert mode is a no-op and beeps.
4791 - <Esc> in Normal mode makes Vim go to Insert mode.
4792 - CTRL-L in Insert mode is a command, it is not inserted.
4793 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4794 However, when <Esc> is used inside a mapping, it behaves like
4795 'insertmode' was not set. This was done to be able to use the same
4796 mappings with 'insertmode' set or not set.
4797 When executing commands with |:normal| 'insertmode' is not used.
4798
4799 NOTE: This option is reset when 'compatible' is set.
4800
4801 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004802'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4804 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4805 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4806 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4807 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 The characters specified by this option are included in file names and
4810 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004811 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 Multi-byte characters 256 and above are always included, only the
4813 characters up to 255 are specified with this option.
4814 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004815 Think twice before adding white space to this option. Although a
4816 space may appear inside a file name, the effect will be that Vim
4817 doesn't know where a file name starts or ends when doing completion.
4818 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819
4820 Note that on systems using a backslash as path separator, Vim tries to
4821 do its best to make it work as you would expect. That is a bit
4822 tricky, since Vi originally used the backslash to escape special
4823 characters. Vim will not remove a backslash in front of a normal file
4824 name character on these systems, but it will on Unix and alikes. The
4825 '&' and '^' are not included by default, because these are special for
4826 cmd.exe.
4827
4828 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004829 Each part can be a single character number or a range. A range is two
4830 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 decimal number between 0 and 255 or the ASCII character itself (does
4832 not work for digits). Example:
4833 "_,-,128-140,#-43" (include '_' and '-' and the range
4834 128 to 140 and '#' to 43)
4835 If a part starts with '^', the following character number or range
4836 will be excluded from the option. The option is interpreted from left
4837 to right. Put the excluded character after the range where it is
4838 included. To include '^' itself use it as the last character of the
4839 option or the end of a range. Example:
4840 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4841 If the character is '@', all characters where isalpha() returns TRUE
4842 are included. Normally these are the characters a to z and A to Z,
4843 plus accented characters. To include '@' itself use "@-@". Examples:
4844 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004845 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 "a-z,A-Z,@-@" All letters plus the '@' character.
4847 A comma can be included by using it where a character number is
4848 expected. Example:
4849 "48-57,,,_" Digits, comma and underscore.
4850 A comma can be excluded by prepending a '^'. Example:
4851 " -~,^,,9" All characters from space to '~', excluding
4852 comma, plus <Tab>.
4853 See |option-backslash| about including spaces and backslashes.
4854
4855 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004856'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 "@,48-57,_,128-167,224-235"
4858 otherwise: "@,48-57,_,192-255")
4859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 The characters given by this option are included in identifiers.
4861 Identifiers are used in recognizing environment variables and after a
4862 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004863 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004864 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004866 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4868
4869 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004870'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 "@,48-57,_,128-167,224-235"
4872 otherwise: "@,48-57,_,192-255"
4873 Vi default: "@,48-57,_")
4874 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004876 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004877 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004878 characters above 255 check the "word" character class (any character
4879 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004880 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 For a help file it is set to all non-blank printable characters except
4882 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4883 command).
4884 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004885 This option also influences syntax highlighting, unless the syntax
4886 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 NOTE: This option is set to the Vi default value when 'compatible' is
4888 set and to the Vim default value when 'compatible' is reset.
4889
4890 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004891'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 "@,~-255"; otherwise: "@,161-255")
4893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 The characters given by this option are displayed directly on the
4895 screen. It is also used for "\p" in a |pattern|. The characters from
4896 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4897 even when they are not included in 'isprint' or excluded. See
4898 'isfname' for a description of the format of this option.
4899
4900 Non-printable characters are displayed with two characters:
4901 0 - 31 "^@" - "^_"
4902 32 - 126 always single characters
4903 127 "^?"
4904 128 - 159 "~@" - "~_"
4905 160 - 254 "| " - "|~"
4906 255 "~?"
4907 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4908 displayed as <xx>, with the hexadecimal value of the byte.
4909 When 'display' contains "uhex" all unprintable characters are
4910 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004911 The SpecialKey highlighting will be used for unprintable characters.
4912 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913
4914 Multi-byte characters 256 and above are always included, only the
4915 characters up to 255 are specified with this option. When a character
4916 is printable but it is not available in the current font, a
4917 replacement character will be shown.
4918 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4919 There is no option to specify these characters.
4920
4921 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4922'joinspaces' 'js' boolean (default on)
4923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 Insert two spaces after a '.', '?' and '!' with a join command.
4925 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4926 Otherwise only one space is inserted.
4927 NOTE: This option is set when 'compatible' is set.
4928
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004929 *'jumpoptions'* *'jop'*
4930'jumpoptions' 'jop' string (default "")
4931 global
4932 List of words that change the behavior of the |jumplist|.
4933 stack Make the jumplist behave like the tagstack.
4934 Relative location of entries in the jumplist is
4935 preserved at the cost of discarding subsequent entries
4936 when navigating backwards in the jumplist and then
4937 jumping to a location. |jumplist-stack|
4938
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 *'key'*
4940'key' string (default "")
4941 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004942 {only available when compiled with the |+cryptv|
4943 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004945 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 Careful: Do not set the key value by hand, someone might see the typed
4947 key. Use the |:X| command. But you can make 'key' empty: >
4948 :set key=
4949< It is not possible to get the value of this option with ":set key" or
4950 "echo &key". This is to avoid showing it to someone who shouldn't
4951 know. It also means you cannot see it yourself once you have set it,
4952 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004953 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4954 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004955 You can use "&key" in an expression to detect whether encryption is
4956 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957
4958 *'keymap'* *'kmp'* *E544*
4959'keymap' 'kmp' string (default "")
4960 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 {only available when compiled with the |+keymap|
4962 feature}
4963 Name of a keyboard mapping. See |mbyte-keymap|.
4964 Setting this option to a valid keymap name has the side effect of
4965 setting 'iminsert' to one, so that the keymap becomes effective.
4966 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004967 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968
4969 *'keymodel'* *'km'*
4970'keymodel' 'km' string (default "")
4971 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004972 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 can do. These values can be used:
4974 startsel Using a shifted special key starts selection (either
4975 Select mode or Visual mode, depending on "key" being
4976 present in 'selectmode').
4977 stopsel Using a not-shifted special key stops selection.
4978 Special keys in this context are the cursor keys, <End>, <Home>,
4979 <PageUp> and <PageDown>.
4980 The 'keymodel' option is set by the |:behave| command.
4981
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004982 *'keyprotocol'* *'kpc'*
4983'keyprotocol' 'kpc' string (default: see below)
4984 global
4985 Specifies what keyboard protocol to use depending on the value of
4986 'term'. The supported keyboard protocols names are:
4987 none whatever the terminal uses
4988 mok2 modifyOtherKeys level 2, as supported by xterm
4989 kitty Kitty keyboard protocol, as supported by Kitty
4990
Bram Moolenaara87749e2022-11-30 10:23:17 +00004991 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004992 a pattern that is matched against the 'term' option, a colon and the
4993 protocol name to be used. To illustrate this, the default value would
4994 be set with: >
4995 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
4996
4997< This means that when 'term' contains "kitty, "foot" or "wezterm"
4998 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00004999 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005000
5001 The first match is used, thus if you want to have "kitty" use the
5002 kitty protocol, but "badkitty" not, then you should match "badkitty"
5003 first and use the "none" value: >
5004 set keyprotocol=badkitty:none,kitty:kitty
5005<
5006 The option is used after 'term' has been changed. First the termcap
5007 entries are set, possibly using the builtin list, see |builtin-terms|.
5008 Then this option is inspected and if there is a match and a protocol
5009 is specified the following happens:
5010 none Nothing, the regular t_TE and t_TI values remain
5011
5012 mok2 The t_TE value is changed to:
5013 CSI >4;m disables modifyOtherKeys
5014 The t_TI value is changed to:
5015 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005016 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005017
5018 kitty The t_TE value is changed to:
5019 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005020 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005021 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005022 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005023 CSI ?u request kitty keyboard protocol state
5024 CSI >c request the termresponse
5025
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005026 If you notice problems, such as characters being displayed that
5027 disappear after `CTRL-L`, you might want to try making this option
5028 empty. Then set the 'term' option to have it take effect: >
5029 set keyprotocol=
5030 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005031<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005032
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 *'keywordprg'* *'kp'*
5034'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005035 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 Program to use for the |K| command. Environment variables are
5038 expanded |:set_env|. ":help" may be used to access the Vim internal
5039 help. (Note that previously setting the global option to the empty
5040 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005041 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005042 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005043 When "man", "man -s" or an Ex command is used, Vim will automatically
5044 translate a count for the "K" command and pass it as the first
5045 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 See |option-backslash| about including spaces and backslashes.
5047 Example: >
5048 :set keywordprg=man\ -s
5049< This option cannot be set from a |modeline| or in the |sandbox|, for
5050 security reasons.
5051
5052 *'langmap'* *'lmap'* *E357* *E358*
5053'langmap' 'lmap' string (default "")
5054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 {only available when compiled with the |+langmap|
5056 feature}
5057 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005058 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005059 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 care of translating these special characters to the original meaning
5061 of the key. This means you don't have to change the keyboard mode to
5062 be able to execute Normal mode commands.
5063 This is the opposite of the 'keymap' option, where characters are
5064 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005065 Also consider setting 'langremap' to off, to prevent 'langmap' from
5066 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005067 This option cannot be set from a |modeline| or in the |sandbox|, for
5068 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005070 Example (for Greek, in UTF-8): *greek* >
5071 :set langmap=ΑA,ΒB,ΨC,ΔD,ΕE,ΦF,ΓG,ΗH,ΙI,ΞJ,ΚK,ΛL,ΜM,ΝN,ΟO,ΠP,QQ,ΡR,ΣS,ΤT,ΘU,ΩV,WW,ΧX,ΥY,ΖZ,αa,βb,ψc,δd,εe,φf,γg,ηh,ιi,ξj,κk,λl,μm,νn,οo,πp,qq,ρr,σs,τt,θu,ωv,ςw,χx,υy,ζz
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072< Example (exchanges meaning of z and y for commands): >
5073 :set langmap=zy,yz,ZY,YZ
5074<
5075 The 'langmap' option is a list of parts, separated with commas. Each
5076 part can be in one of two forms:
5077 1. A list of pairs. Each pair is a "from" character immediately
5078 followed by the "to" character. Examples: "aA", "aAbBcC".
5079 2. A list of "from" characters, a semi-colon and a list of "to"
5080 characters. Example: "abc;ABC"
5081 Example: "aA,fgh;FGH,cCdDeE"
5082 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005083 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084
5085 This will allow you to activate vim actions without having to switch
5086 back and forth between the languages. Your language characters will
5087 be understood as normal vim English characters (according to the
5088 langmap mappings) in the following cases:
5089 o Normal/Visual mode (commands, buffer/register names, user mappings)
5090 o Insert/Replace Mode: Register names after CTRL-R
5091 o Insert/Replace Mode: Mappings
5092 Characters entered in Command-line mode will NOT be affected by
5093 this option. Note that this option can be changed at any time
5094 allowing to switch between mappings for different languages/encodings.
5095 Use a mapping to avoid having to type it each time!
5096
5097 *'langmenu'* *'lm'*
5098'langmenu' 'lm' string (default "")
5099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 {only available when compiled with the |+menu| and
5101 |+multi_lang| features}
5102 Language to use for menu translation. Tells which file is loaded
5103 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005104 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105< (without the spaces). For example, to always use the Dutch menus, no
5106 matter what $LANG is set to: >
5107 :set langmenu=nl_NL.ISO_8859-1
5108< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005109 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 If your $LANG is set to a non-English language but you do want to use
5111 the English menus: >
5112 :set langmenu=none
5113< This option must be set before loading menus, switching on filetype
5114 detection or syntax highlighting. Once the menus are defined setting
5115 this option has no effect. But you could do this: >
5116 :source $VIMRUNTIME/delmenu.vim
5117 :set langmenu=de_DE.ISO_8859-1
5118 :source $VIMRUNTIME/menu.vim
5119< Warning: This deletes all menus that you defined yourself!
5120
Bram Moolenaard94464e2015-11-02 15:28:18 +01005121 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005122'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005123 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005124 {only available when compiled with the |+langmap|
5125 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005126 This is just like 'langremap' but with the value inverted. It only
5127 exists for backwards compatibility. When setting 'langremap' then
5128 'langnoremap' is set to the inverted value, and the other way around.
5129
5130 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005131'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005132 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005133 {only available when compiled with the |+langmap|
5134 feature}
5135 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005136 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005137 'langmap' disables some of your mappings, try resetting this option.
5138 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005139 that works for you to avoid mappings to break.
5140
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 *'laststatus'* *'ls'*
5142'laststatus' 'ls' number (default 1)
5143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 The value of this option influences when the last window will have a
5145 status line:
5146 0: never
5147 1: only if there are at least two windows
5148 2: always
5149 The screen looks nicer with a status line if you have several
5150 windows, but it takes another screen line. |status-line|
5151
5152 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5153'lazyredraw' 'lz' boolean (default off)
5154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 When this option is set, the screen will not be redrawn while
5156 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005157 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005159 This may occasionally cause display errors. It is only meant to be set
5160 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005161 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162
5163 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5164'linebreak' 'lbr' boolean (default off)
5165 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005166 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005168 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 than at the last character that fits on the screen. Unlike
5170 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005171 it only affects the way the file is displayed, not its contents.
5172 If 'breakindent' is set, line is visually indented. Then, the value
5173 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005174 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 Note that <Tab> characters after an <EOL> are mostly not displayed
5176 with the right amount of white space.
5177
5178 *'lines'* *E593*
5179'lines' number (default 24 or terminal height)
5180 global
5181 Number of lines of the Vim window.
5182 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005183 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 When Vim is running in the GUI or in a resizable window, setting this
5185 option will cause the window size to be changed. When you only want
5186 to use the size for the GUI, put the command in your |gvimrc| file.
5187 Vim limits the number of lines to what fits on the screen. You can
5188 use this command to get the tallest window possible: >
5189 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005190< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005191 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 When you set this option and Vim is unable to change the physical
5193 number of lines of the display, the display may be messed up.
5194
5195 *'linespace'* *'lsp'*
5196'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 {only in the GUI}
5199 Number of pixel lines inserted between characters. Useful if the font
5200 uses the full character cell height, making lines touch each other.
5201 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005202 With some fonts there can be too much room between lines (to have
5203 space for ascents and descents). Then it makes sense to set
5204 'linespace' to a negative value. This may cause display problems
5205 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206
5207 *'lisp'* *'nolisp'*
5208'lisp' boolean (default off)
5209 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 Lisp mode: When <Enter> is typed in insert mode set the indent for
5211 the next line to Lisp standards (well, sort of). Also happens with
5212 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5213 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5214 better. Also see 'lispwords'.
5215 The '-' character is included in keyword characters. Redefines the
5216 "=" operator to use this same indentation algorithm rather than
5217 calling an external program if 'equalprg' is empty.
5218 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005220 *'lispoptions'* *'lop'*
5221'lispoptions' 'lop' string (default "")
5222 local to buffer
5223 Comma-separated list of items that influence the Lisp indenting when
5224 enabled with the |'lisp'| option. Currently only one item is
5225 supported:
5226 expr:1 use 'indentexpr' for Lisp indenting when it is set
5227 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5228 Note that when using 'indentexpr' the `=` operator indents all the
5229 lines, otherwise the first line is not indented (Vi-compatible).
5230
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 *'lispwords'* *'lw'*
5232'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005233 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005234 Comma-separated list of words that influence the Lisp indenting when
5235 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236
5237 *'list'* *'nolist'*
5238'list' boolean (default off)
5239 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005240 List mode: By default show tabs as CTRL-I is displayed, display $
5241 after end of line. Useful to see the difference between tabs and
5242 spaces and for trailing blanks. Further changed by the 'listchars'
5243 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005244
5245 The cursor is displayed at the start of the space a Tab character
5246 occupies, not at the end as usual in Normal mode. To get this cursor
5247 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005248 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005249<
5250 Note that list mode will also affect formatting (set with 'textwidth'
5251 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 changing the way tabs are displayed.
5253
5254 *'listchars'* *'lcs'*
5255'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005256 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005257 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005258 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005259 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 eol:c Character to show at the end of each line. When
5261 omitted, there is no extra character at the end of the
5262 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005263 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005264 tab:xy[z] Two or three characters to be used to show a tab.
5265 The third character is optional.
5266
5267 tab:xy The 'x' is always used, then 'y' as many times as will
5268 fit. Thus "tab:>-" displays:
5269 >
5270 >-
5271 >--
5272 etc.
5273
5274 tab:xyz The 'z' is always used, then 'x' is prepended, and
5275 then 'y' is used as many times as will fit. Thus
5276 "tab:<->" displays:
5277 >
5278 <>
5279 <->
5280 <-->
5281 etc.
5282
5283 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005284 *lcs-space*
5285 space:c Character to show for a space. When omitted, spaces
5286 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005287 *lcs-multispace*
5288 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005289 One or more characters to use cyclically to show for
5290 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005291 setting, except for single spaces. When omitted, the
5292 "space" setting is used. For example,
5293 `:set listchars=multispace:---+` shows ten consecutive
5294 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005295 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005296 *lcs-lead*
5297 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005298 leading spaces are blank. Overrides the "space" and
5299 "multispace" settings for leading spaces. You can
5300 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005301 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005302< *lcs-leadmultispace*
5303 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005304 Like the |lcs-multispace| value, but for leading
5305 spaces only. Also overrides |lcs-lead| for leading
5306 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005307 `:set listchars=leadmultispace:---+` shows ten
5308 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005309 ---+---+--XXX ~
5310 Where "XXX" denotes the first non-blank characters in
5311 the line.
5312 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005313 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005314 trailing spaces are blank. Overrides the "space" and
5315 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005316 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317 extends:c Character to show in the last column, when 'wrap' is
5318 off and the line continues beyond the right of the
5319 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005320 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005321 precedes:c Character to show in the first visible column of the
5322 physical line, when there is text preceding the
5323 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005324 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005325 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005326 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005327 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005328 nbsp:c Character to show for a non-breakable space character
5329 (0xA0 (160 decimal) and U+202F). Left blank when
5330 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005332 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005334 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005336 Each character can be specified as hex: >
5337 set listchars=eol:\\x24
5338 set listchars=eol:\\u21b5
5339 set listchars=eol:\\U000021b5
5340< Note that a double backslash is used. The number of hex characters
5341 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5342
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 Examples: >
5344 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005345 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 :set lcs=extends:>,precedes:<
5347< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005348 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5349 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005350 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351
5352 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5353'loadplugins' 'lpl' boolean (default on)
5354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 When on the plugin scripts are loaded when starting up |load-plugins|.
5356 This option can be reset in your |vimrc| file to disable the loading
5357 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005358 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5359 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360
Bram Moolenaard94464e2015-11-02 15:28:18 +01005361 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005362'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005363 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005364 {only available when compiled with the |+lua/dyn|
5365 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005366 Specifies the name of the Lua shared library. The default is
5367 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005368 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005369 This option cannot be set from a |modeline| or in the |sandbox|, for
5370 security reasons.
5371
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005372 *'macatsui'* *'nomacatsui'*
5373'macatsui' boolean (default on)
5374 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005375 {not supported}
5376 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005377
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 *'magic'* *'nomagic'*
5379'magic' boolean (default on)
5380 global
5381 Changes the special characters that can be used in search patterns.
5382 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005383 WARNING: Switching this option off most likely breaks plugins! That
5384 is because many patterns assume it's on and will fail when it's off.
5385 Only switch it off when working with old Vi scripts. In any other
5386 situation write patterns that work when 'magic' is on. Include "\M"
5387 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005388 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5389 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390
5391 *'makeef'* *'mef'*
5392'makeef' 'mef' string (default: "")
5393 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 {not available when compiled without the |+quickfix|
5395 feature}
5396 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5397 and the |:grep| command.
5398 When it is empty, an internally generated temp file will be used.
5399 When "##" is included, it is replaced by a number to make the name
5400 unique. This makes sure that the ":make" command doesn't overwrite an
5401 existing file.
5402 NOT used for the ":cf" command. See 'errorfile' for that.
5403 Environment variables are expanded |:set_env|.
5404 See |option-backslash| about including spaces and backslashes.
5405 This option cannot be set from a |modeline| or in the |sandbox|, for
5406 security reasons.
5407
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005408 *'makeencoding'* *'menc'*
5409'makeencoding' 'menc' string (default "")
5410 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005411 Encoding used for reading the output of external commands. When empty,
5412 encoding is not converted.
5413 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5414 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5415 and `:laddfile`.
5416
5417 This would be mostly useful when you use MS-Windows and set 'encoding'
5418 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5419 'makeencoding' to "char" has the same effect as setting to the system
5420 locale encoding. Example: >
5421 :set encoding=utf-8
5422 :set makeencoding=char " system locale is used
5423<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 *'makeprg'* *'mp'*
5425'makeprg' 'mp' string (default "make", VMS: "MMS")
5426 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005427 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005428 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5429 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005430 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005431 Environment variables are expanded |:set_env|. See |option-backslash|
5432 about including spaces and backslashes.
5433 Note that a '|' must be escaped twice: once for ":set" and once for
5434 the interpretation of a command. When you use a filter called
5435 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 :set makeprg=gmake\ \\\|\ myfilter
5437< The placeholder "$*" can be given (even multiple times) to specify
5438 where the arguments will be included, for example: >
5439 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5440< This option cannot be set from a |modeline| or in the |sandbox|, for
5441 security reasons.
5442
5443 *'matchpairs'* *'mps'*
5444'matchpairs' 'mps' string (default "(:),{:},[:]")
5445 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005447 other.
5448 Only character pairs are allowed that are different, thus you cannot
5449 jump between two double quotes.
5450 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005451 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005452 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 :set mps+=<:>
5454
5455< A more exotic example, to jump between the '=' and ';' in an
5456 assignment, useful for languages like C and Java: >
5457 :au FileType c,cpp,java set mps+==:;
5458
5459< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005460 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
5462 *'matchtime'* *'mat'*
5463'matchtime' 'mat' number (default 5)
5464 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 Tenths of a second to show the matching paren, when 'showmatch' is
5466 set. Note that this is not in milliseconds, like other options that
5467 set a time. This is to be compatible with Nvi.
5468
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005469 *'maxcombine'* *'mco'*
5470'maxcombine' 'mco' number (default 2)
5471 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005472 The maximum number of combining characters supported for displaying.
5473 Only used when 'encoding' is "utf-8".
5474 The default is OK for most languages. Hebrew may require 4.
5475 Maximum value is 6.
5476 Even when this option is set to 2 you can still edit text with more
5477 combining characters, you just can't see them. Use |g8| or |ga|.
5478 See |mbyte-combining|.
5479
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 *'maxfuncdepth'* *'mfd'*
5481'maxfuncdepth' 'mfd' number (default 100)
5482 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005483 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005484 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 Maximum depth of function calls for user functions. This normally
5486 catches endless recursion. When using a recursive function with
5487 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5488 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005489 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005490 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 See also |:function|.
Christian Brabandt47510f32023-10-15 09:56:16 +02005492 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493
5494 *'maxmapdepth'* *'mmd'* *E223*
5495'maxmapdepth' 'mmd' number (default 1000)
5496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 Maximum number of times a mapping is done without resulting in a
5498 character to be used. This normally catches endless mappings, like
5499 ":map x y" with ":map y x". It still does not catch ":map g wg",
5500 because the 'w' is used before the next mapping is done. See also
5501 |key-mapping|.
5502
5503 *'maxmem'* *'mm'*
5504'maxmem' 'mm' number (default between 256 to 5120 (system
5505 dependent) or half the amount of memory
5506 available)
5507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5509 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005510 other memory to be freed.
5511 The maximum usable value is about 2000000. Use this to work without a
5512 limit.
5513 The value is ignored when 'swapfile' is off.
5514 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005516 *'maxmempattern'* *'mmp'*
5517'maxmempattern' 'mmp' number (default 1000)
5518 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005519 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005520 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005521 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005522 When Vim runs into the limit it gives an error message and mostly
5523 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005524 Running into the limit often means that the pattern is very
5525 inefficient or too complex. This may already happen with the pattern
5526 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005527 Might also happen on redraw, when syntax rules try to match a complex
5528 text structure.
5529 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5530 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005531
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 *'maxmemtot'* *'mmt'*
5533'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5534 dependent) or half the amount of memory
5535 available)
5536 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005537 Maximum amount of memory in Kbyte to use for all buffers together.
5538 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005539 without a limit.
5540 On 64 bit machines higher values might work. But hey, do you really
5541 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005542 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005543 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005544 Buffers with 'swapfile' off still count to the total amount of memory
5545 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005546 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547
5548 *'menuitems'* *'mis'*
5549'menuitems' 'mis' number (default 25)
5550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 {not available when compiled without the |+menu|
5552 feature}
5553 Maximum number of items to use in a menu. Used for menus that are
5554 generated from a list of items, e.g., the Buffers menu. Changing this
5555 option has no direct effect, the menu must be refreshed first.
5556
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005557 *'mkspellmem'* *'msm'*
5558'mkspellmem' 'msm' string (default "460000,2000,500")
5559 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005560 {not available when compiled without the |+syntax|
5561 feature}
5562 Parameters for |:mkspell|. This tunes when to start compressing the
5563 word tree. Compression can be slow when there are many words, but
5564 it's needed to avoid running out of memory. The amount of memory used
5565 per word depends very much on how similar the words are, that's why
5566 this tuning is complicated.
5567
5568 There are three numbers, separated by commas:
5569 {start},{inc},{added}
5570
5571 For most languages the uncompressed word tree fits in memory. {start}
5572 gives the amount of memory in Kbyte that can be used before any
5573 compression is done. It should be a bit smaller than the amount of
5574 memory that is available to Vim.
5575
5576 When going over the {start} limit the {inc} number specifies the
5577 amount of memory in Kbyte that can be allocated before another
5578 compression is done. A low number means compression is done after
5579 less words are added, which is slow. A high number means more memory
5580 will be allocated.
5581
5582 After doing compression, {added} times 1024 words can be added before
5583 the {inc} limit is ignored and compression is done when any extra
5584 amount of memory is needed. A low number means there is a smaller
5585 chance of hitting the {inc} limit, less memory is used but it's
5586 slower.
5587
5588 The languages for which these numbers are important are Italian and
5589 Hungarian. The default works for when you have about 512 Mbyte. If
5590 you have 1 Gbyte you could use: >
5591 :set mkspellmem=900000,3000,800
5592< If you have less than 512 Mbyte |:mkspell| may fail for some
5593 languages, no matter what you set 'mkspellmem' to.
5594
dkearns8ebdbc92023-10-29 06:26:19 +11005595 This option cannot be set from a |modeline| or in the |sandbox|, for
5596 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005597
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005599'modeline' 'ml' boolean (Vim default: on (off for root),
5600 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005602 If 'modeline' is on 'modelines' gives the number of lines that is
5603 checked for set commands. If 'modeline' is off or 'modelines' is zero
5604 no lines are checked. See |modeline|.
5605
5606 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5607'modelineexpr' 'mle' boolean (default: off)
5608 global
5609 When on allow some options that are an expression to be set in the
5610 modeline. Check the option for whether it is affected by
5611 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005612 This option cannot be set from a |modeline| or in the |sandbox|, for
5613 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005614
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 *'modelines'* *'mls'*
5616'modelines' 'mls' number (default 5)
5617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 If 'modeline' is on 'modelines' gives the number of lines that is
5619 checked for set commands. If 'modeline' is off or 'modelines' is zero
5620 no lines are checked. See |modeline|.
5621 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5622 set and to the Vim default value when 'compatible' is reset.
5623
5624 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005625 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626'modifiable' 'ma' boolean (default on)
5627 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 When off the buffer contents cannot be changed. The 'fileformat' and
5629 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005630 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631
5632 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5633'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005634 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 When on, the buffer is considered to be modified. This option is set
5636 when:
5637 1. A change was made to the text since it was last written. Using the
5638 |undo| command to go back to the original text will reset the
5639 option. But undoing changes that were made before writing the
5640 buffer will set the option again, since the text is different from
5641 when it was written.
5642 2. 'fileformat' or 'fileencoding' is different from its original
5643 value. The original value is set when the buffer is read or
5644 written. A ":set nomodified" command also resets the original
5645 values to the current values and the 'modified' option will be
5646 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005647 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005648 This option is not set when a change is made to the buffer as the
5649 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5650 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5651 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5653 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005654 Note that the text may actually be the same, e.g. 'modified' is set
5655 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656
5657 *'more'* *'nomore'*
5658'more' boolean (Vim default: on, Vi default: off)
5659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660 When on, listings pause when the whole screen is filled. You will get
5661 the |more-prompt|. When this option is off there are no pauses, the
5662 listing continues until finished.
5663 NOTE: This option is set to the Vi default value when 'compatible' is
5664 set and to the Vim default value when 'compatible' is reset.
5665
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005666 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005667'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005668 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005670 Enable the use of the mouse. Works for most terminals (xterm, Win32
5671 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5672 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5673 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005674 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 v Visual mode
5676 i Insert mode
5677 c Command-line mode
5678 h all previous modes when editing a help file
5679 a all previous modes
5680 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005681 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005683< If your terminal can't overrule the mouse events going to the
5684 application, use: >
5685 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005686< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005687 back to Vim using the mouse events.
5688 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5689 "xterm".
5690
5691 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 modeless selection. This doesn't move the text cursor.
5693
5694 See |mouse-using|. Also see |'clipboard'|.
5695
5696 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005697 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 the mouse buttons can still be used by keeping the shift key pressed.
5699 Also see the 'clipboard' option.
5700
5701 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5702'mousefocus' 'mousef' boolean (default off)
5703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 {only works in the GUI}
5705 The window that the mouse pointer is on is automatically activated.
5706 When changing the window layout or window focus in another way, the
5707 mouse pointer is moved to the window with keyboard focus. Off is the
5708 default because it makes using the pull down menus a little goofy, as
5709 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005710 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005711 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712
5713 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5714'mousehide' 'mh' boolean (default on)
5715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 {only works in the GUI}
5717 When on, the mouse pointer is hidden when characters are typed.
5718 The mouse pointer is restored when the mouse is moved.
5719
5720 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005721'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 Sets the model to use for the mouse. The name mostly specifies what
5724 the right mouse button is used for:
5725 extend Right mouse button extends a selection. This works
5726 like in an xterm.
5727 popup Right mouse button pops up a menu. The shifted left
5728 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005729 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 popup_setpos Like "popup", but the cursor will be moved to the
5731 position where the mouse was clicked, and thus the
5732 selected operation will act upon the clicked object.
5733 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005734 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 course, that right clicking outside a selection will
5736 end Visual mode.
5737 Overview of what button does what for each model:
5738 mouse extend popup(_setpos) ~
5739 left click place cursor place cursor
5740 left drag start selection start selection
5741 shift-left search word extend selection
5742 right click extend selection popup menu (place cursor)
5743 right drag extend selection -
5744 middle click paste paste
5745
5746 In the "popup" model the right mouse button produces a pop-up menu.
5747 You need to define this first, see |popup-menu|.
5748
5749 Note that you can further refine the meaning of buttons with mappings.
5750 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5751 selection (because that's handled in the GUI code directly).
5752
5753 The 'mousemodel' option is set by the |:behave| command.
5754
h_east59858792023-10-25 22:47:05 +09005755 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005756'mousemoveevent' 'mousemev' boolean (default off)
5757 global
5758 {only works in the GUI}
5759 When on, mouse move events are delivered to the input queue and are
5760 available for mapping. The default, off, avoids the mouse movement
5761 overhead except when needed. See |gui-mouse-mapping|.
5762 Warning: Setting this option can make pending mappings to be aborted
5763 when the mouse is moved.
5764 Currently only works in the GUI, may be made to work in a terminal
5765 later.
5766
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005768'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5769 vs:leftright,vd:lrsizing,m:no,
5770 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 {only available when compiled with the |+mouseshape|
5773 feature}
5774 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005775 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776 like used for 'guicursor'. Each part consist of a mode/location-list
5777 and an argument-list:
5778 mode-list:shape,mode-list:shape,..
5779 The mode-list is a dash separated list of these modes/locations:
5780 In a normal window: ~
5781 n Normal mode
5782 v Visual mode
5783 ve Visual mode with 'selection' "exclusive" (same as 'v',
5784 if not specified)
5785 o Operator-pending mode
5786 i Insert mode
5787 r Replace mode
5788
5789 Others: ~
5790 c appending to the command-line
5791 ci inserting in the command-line
5792 cr replacing in the command-line
5793 m at the 'Hit ENTER' or 'More' prompts
5794 ml idem, but cursor in the last line
5795 e any mode, pointer below last window
5796 s any mode, pointer on a status line
5797 sd any mode, while dragging a status line
5798 vs any mode, pointer on a vertical separator line
5799 vd any mode, while dragging a vertical separator line
5800 a everywhere
5801
5802 The shape is one of the following:
5803 avail name looks like ~
5804 w x arrow Normal mouse pointer
5805 w x blank no pointer at all (use with care!)
5806 w x beam I-beam
5807 w x updown up-down sizing arrows
5808 w x leftright left-right sizing arrows
5809 w x busy The system's usual busy pointer
5810 w x no The system's usual 'no input' pointer
5811 x udsizing indicates up-down resizing
5812 x lrsizing indicates left-right resizing
5813 x crosshair like a big thin +
5814 x hand1 black hand
5815 x hand2 white hand
5816 x pencil what you write with
5817 x question big ?
5818 x rightup-arrow arrow pointing right-up
5819 w x up-arrow arrow pointing up
5820 x <number> any X11 pointer number (see X11/cursorfont.h)
5821
5822 The "avail" column contains a 'w' if the shape is available for Win32,
5823 x for X11.
5824 Any modes not specified or shapes not available use the normal mouse
5825 pointer.
5826
5827 Example: >
5828 :set mouseshape=s:udsizing,m:no
5829< will make the mouse turn to a sizing arrow over the status lines and
5830 indicate no input when the hit-enter prompt is displayed (since
5831 clicking the mouse has no effect in this state.)
5832
5833 *'mousetime'* *'mouset'*
5834'mousetime' 'mouset' number (default 500)
5835 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005836 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 time in msec between two mouse clicks for the second click to be
5838 recognized as a multi click.
5839
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005840 *'mzschemedll'*
5841'mzschemedll' string (default depends on the build)
5842 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005843 {only available when compiled with the |+mzscheme/dyn|
5844 feature}
5845 Specifies the name of the MzScheme shared library. The default is
5846 DYNAMIC_MZSCH_DLL which was specified at compile time.
5847 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005848 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005849 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005850 This option cannot be set from a |modeline| or in the |sandbox|, for
5851 security reasons.
5852
5853 *'mzschemegcdll'*
5854'mzschemegcdll' string (default depends on the build)
5855 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005856 {only available when compiled with the |+mzscheme/dyn|
5857 feature}
5858 Specifies the name of the MzScheme GC shared library. The default is
5859 DYNAMIC_MZGC_DLL which was specified at compile time.
5860 The value can be equal to 'mzschemedll' if it includes the GC code.
5861 Environment variables are expanded |:set_env|.
5862 This option cannot be set from a |modeline| or in the |sandbox|, for
5863 security reasons.
5864
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005865 *'mzquantum'* *'mzq'*
5866'mzquantum' 'mzq' number (default 100)
5867 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005868 {not available when compiled without the |+mzscheme|
5869 feature}
5870 The number of milliseconds between polls for MzScheme threads.
5871 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005872 NOTE: This option is set to the Vim default value when 'compatible'
5873 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005874
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005876'nrformats' 'nf' string (default "bin,octal,hex",
5877 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 This defines what bases Vim will consider for numbers when using the
5880 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5881 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005882 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005884 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005885 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005887 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888 considered to be hexadecimal. Example: Using CTRL-X on
5889 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005890 bin If included, numbers starting with "0b" or "0B" will be
5891 considered to be binary. Example: Using CTRL-X on
5892 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005893 unsigned If included, numbers are recognized as unsigned. Thus a
5894 leading dash or negative sign won't be considered as part of
5895 the number. Examples:
5896 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5897 (without "unsigned" it would become "9-2021").
5898 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5899 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005900 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5901 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 Numbers which simply begin with a digit in the range 1-9 are always
5903 considered decimal. This also happens for numbers that are not
5904 recognized as octal or hex.
5905
5906 *'number'* *'nu'* *'nonumber'* *'nonu'*
5907'number' 'nu' boolean (default off)
5908 local to window
5909 Print the line number in front of each line. When the 'n' option is
5910 excluded from 'cpoptions' a wrapped line will not use the column of
5911 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005912 The 'numberwidth' option can be used to set the room used for the line
5913 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 When a long, wrapped line doesn't start with the first character, '-'
5915 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005916 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5917 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005918 *number_relativenumber*
5919 The 'relativenumber' option changes the displayed number to be
5920 relative to the cursor. Together with 'number' there are these
5921 four combinations (cursor in line 3):
5922
Bram Moolenaar3848e002016-03-19 18:42:29 +01005923 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005924 'nornu' 'nornu' 'rnu' 'rnu'
5925
5926 |apple | 1 apple | 2 apple | 2 apple
5927 |pear | 2 pear | 1 pear | 1 pear
5928 |nobody | 3 nobody | 0 nobody |3 nobody
5929 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005931 *'numberwidth'* *'nuw'*
5932'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5933 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005934 {only available when compiled with the |+linebreak|
5935 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005936 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005937 when the 'number' or 'relativenumber' option is set or printing lines
5938 with a line number. Since one space is always between the number and
5939 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005940 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005941 fit the highest line number in the buffer respectively the number of
5942 rows in the window, depending on whether 'number' or 'relativenumber'
5943 is set. Thus with the Vim default of 4 there is room for a line number
5944 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005945 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005946 NOTE: This option is set to the Vi default value when 'compatible' is
5947 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005948
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005949 *'omnifunc'* *'ofu'*
5950'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005951 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005952 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005953 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005954 This option specifies a function to be used for Insert mode omni
5955 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005956 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005957 invoked and what it should return. The value can be the name of a
5958 function, a |lambda| or a |Funcref|. See |option-value-function| for
5959 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005960 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005961 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005962 This option cannot be set from a |modeline| or in the |sandbox|, for
5963 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005964
5965
Bram Moolenaar02467872007-05-06 13:22:01 +00005966 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005967'opendevice' 'odev' boolean (default off)
5968 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005969 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005970 Enable reading and writing from devices. This may get Vim stuck on a
5971 device that can be opened but doesn't actually do the I/O. Therefore
5972 it is off by default.
5973 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5974 result in editing a device.
5975
5976
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005977 *'operatorfunc'* *'opfunc'*
5978'operatorfunc' 'opfunc' string (default: empty)
5979 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005980 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005981 See |:map-operator| for more info and an example. The value can be
5982 the name of a function, a |lambda| or a |Funcref|. See
5983 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005984
5985 This option cannot be set from a |modeline| or in the |sandbox|, for
5986 security reasons.
5987
5988
Bram Moolenaar251e1912011-06-19 05:09:16 +02005989 *'osfiletype'* *'oft'*
5990'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005992 This option was supported on RISC OS, which has been removed.
5993
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005995 *'packpath'* *'pp'*
5996'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005997 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11005998 This option cannot be set from a |modeline| or in the |sandbox|, for
5999 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006000
6001
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006003'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 global
6005 Specifies the nroff macros that separate paragraphs. These are pairs
6006 of two letters (see |object-motions|).
6007
6008 *'paste'* *'nopaste'*
6009'paste' boolean (default off)
6010 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006011 Put Vim in Paste mode. This is useful if you want to cut or copy
6012 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 unexpected effects.
6014 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006015 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016 knows about pasting and will mostly do the right thing without 'paste'
6017 being set. The same is true for a terminal where Vim handles the
6018 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006019 This option is reset when starting the GUI. Thus if you set it in
6020 your .vimrc it will work in a terminal, but not in the GUI. Setting
6021 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6022 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 When the 'paste' option is switched on (also when it was already on):
6024 - mapping in Insert mode and Command-line mode is disabled
6025 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006027 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006028 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 - 'revins' is reset
6030 - 'ruler' is reset
6031 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006032 - 'smarttab' is reset
6033 - 'softtabstop' is set to 0
6034 - 'textwidth' is set to 0
6035 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006036 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006039 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006040 - 'indentexpr'
6041 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006042 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043 NOTE: When you start editing another file while the 'paste' option is
6044 on, settings from the modelines or autocommands may change the
6045 settings again, causing trouble when pasting text. You might want to
6046 set the 'paste' option again.
6047 When the 'paste' option is reset the mentioned options are restored to
6048 the value before the moment 'paste' was switched from off to on.
6049 Resetting 'paste' before ever setting it does not have any effect.
6050 Since mapping doesn't work while 'paste' is active, you need to use
6051 the 'pastetoggle' option to toggle the 'paste' option with some key.
6052
6053 *'pastetoggle'* *'pt'*
6054'pastetoggle' 'pt' string (default "")
6055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 When non-empty, specifies the key sequence that toggles the 'paste'
6057 option. This is like specifying a mapping: >
6058 :map {keys} :set invpaste<CR>
6059< Where {keys} is the value of 'pastetoggle'.
6060 The difference is that it will work even when 'paste' is set.
6061 'pastetoggle' works in Insert mode and Normal mode, but not in
6062 Command-line mode.
6063 Mappings are checked first, thus overrule 'pastetoggle'. However,
6064 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6065 this: >
6066 :map <F10> :set paste<CR>
6067 :map <F11> :set nopaste<CR>
6068 :imap <F10> <C-O>:set paste<CR>
6069 :imap <F11> <nop>
6070 :set pastetoggle=<F11>
6071< This will make <F10> start paste mode and <F11> stop paste mode.
6072 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6073 mode everything is inserted literally, except the 'pastetoggle' key
6074 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006075 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076
6077 *'pex'* *'patchexpr'*
6078'patchexpr' 'pex' string (default "")
6079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006080 {not available when compiled without the |+diff|
6081 feature}
6082 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006083 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006084 This option cannot be set from a |modeline| or in the |sandbox|, for
6085 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086
Bram Moolenaardbc28022014-07-26 13:40:44 +02006087 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088'patchmode' 'pm' string (default "")
6089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090 When non-empty the oldest version of a file is kept. This can be used
6091 to keep the original version of a file if you are changing files in a
6092 source distribution. Only the first time that a file is written a
6093 copy of the original file will be kept. The name of the copy is the
6094 name of the original file with the string in the 'patchmode' option
6095 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006096 ".orig" or ".org". 'backupdir' must not be empty for this to work
6097 (Detail: The backup file is renamed to the patchmode file after the
6098 new file has been successfully written, that's why it must be possible
6099 to write a backup file). If there was no file to be backed up, an
6100 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 When the 'backupskip' pattern matches, a patchmode file is not made.
6102 Using 'patchmode' for compressed files appends the extension at the
6103 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6104 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006105 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006107 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 other systems: ".,,")
6110 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006112 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6113 provided that the file being searched for has a relative path (not
6114 starting with "/", "./" or "../"). The directories in the 'path'
6115 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 - Use commas to separate directory names: >
6117 :set path=.,/usr/local/include,/usr/include
6118< - Spaces can also be used to separate directory names (for backwards
6119 compatibility with version 3.0). To have a space in a directory
6120 name, precede it with an extra backslash, and escape the space: >
6121 :set path=.,/dir/with\\\ space
6122< - To include a comma in a directory name precede it with an extra
6123 backslash: >
6124 :set path=.,/dir/with\\,comma
6125< - To search relative to the directory of the current file, use: >
6126 :set path=.
6127< - To search in the current directory use an empty string between two
6128 commas: >
6129 :set path=,,
6130< - A directory name may end in a ':' or '/'.
6131 - Environment variables are expanded |:set_env|.
6132 - When using |netrw.vim| URLs can be used. For example, adding
6133 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006134 - Search upwards and downwards in a directory tree using "*", "**" and
6135 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 - Careful with '\' characters, type two to get one in the option: >
6137 :set path=.,c:\\include
6138< Or just use '/' instead: >
6139 :set path=.,c:/include
6140< Don't forget "." or files won't even be found in the same directory as
6141 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006142 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 it is something like 256 or 1024 characters.
6144 You can check if all the include files are found, using the value of
6145 'path', see |:checkpath|.
6146 The use of |:set+=| and |:set-=| is preferred when adding or removing
6147 directories from the list. This avoids problems when a future version
6148 uses another default. To remove the current directory use: >
6149 :set path-=
6150< To add the current directory use: >
6151 :set path+=
6152< To use an environment variable, you probably need to replace the
6153 separator. Here is an example to append $INCL, in which directory
6154 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006155 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156< Replace the ';' with a ':' or whatever separator is used. Note that
6157 this doesn't work when $INCL contains a comma or white space.
6158
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006159 *'perldll'*
6160'perldll' string (default depends on the build)
6161 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006162 {only available when compiled with the |+perl/dyn|
6163 feature}
6164 Specifies the name of the Perl shared library. The default is
6165 DYNAMIC_PERL_DLL, which was specified at compile time.
6166 Environment variables are expanded |:set_env|.
6167 This option cannot be set from a |modeline| or in the |sandbox|, for
6168 security reasons.
6169
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6171'preserveindent' 'pi' boolean (default off)
6172 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173 When changing the indent of the current line, preserve as much of the
6174 indent structure as possible. Normally the indent is replaced by a
6175 series of tabs followed by spaces as required (unless |'expandtab'| is
6176 enabled, in which case only spaces are used). Enabling this option
6177 means the indent will preserve as many existing characters as possible
6178 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006179 'expandtab' does not apply to the preserved white space, a Tab remains
6180 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 NOTE: When using ">>" multiple times the resulting indent is a mix of
6182 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006183 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 Also see 'copyindent'.
6185 Use |:retab| to clean up white space.
6186
6187 *'previewheight'* *'pvh'*
6188'previewheight' 'pvh' number (default 12)
6189 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006190 {not available when compiled without the |+quickfix|
6191 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006193 commands. Used for |CTRL-W_}| when no count is given. Not used when
6194 'previewpopup' is set.
6195
6196 *'previewpopup'* *'pvp'*
6197'previewpopup' 'pvp' string (default empty)
6198 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006199 {not available when compiled without the |+textprop|
6200 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006201 When not empty a popup window is used for commands that would open a
6202 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006203 Not used for the insert completion info, add "popup" to
6204 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205
6206 *'previewwindow'* *'nopreviewwindow'*
6207 *'pvw'* *'nopvw'* *E590*
6208'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006209 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006210 {not available when compiled without the |+quickfix|
6211 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006212 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 set. It's normally not set directly, but by using one of the commands
6214 |:ptag|, |:pedit|, etc.
6215
6216 *'printdevice'* *'pdev'*
6217'printdevice' 'pdev' string (default empty)
6218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 {only available when compiled with the |+printer|
6220 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006221 The name of the printer to be used for |:hardcopy|.
6222 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006223 This option cannot be set from a |modeline| or in the |sandbox|, for
6224 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225
Bram Moolenaar8299df92004-07-10 09:47:34 +00006226 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006227'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 {only available when compiled with the |+printer|
6230 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006231 Sets the character encoding used when printing.
6232 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233
6234 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006235'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 {only available when compiled with the |+printer|
6238 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006239 Expression used to print the PostScript produced with |:hardcopy|.
6240 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006241 This option cannot be set from a |modeline| or in the |sandbox|, for
6242 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243
Bram Moolenaar8299df92004-07-10 09:47:34 +00006244 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245'printfont' 'pfn' string (default "courier")
6246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 {only available when compiled with the |+printer|
6248 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006249 The name of the font that will be used for |:hardcopy|.
6250 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251
6252 *'printheader'* *'pheader'*
6253'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6254 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 {only available when compiled with the |+printer|
6256 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006257 The format of the header produced in |:hardcopy| output.
6258 See |pheader-option|.
6259
6260 *'printmbcharset'* *'pmbcs'*
6261'printmbcharset' 'pmbcs' string (default "")
6262 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006263 {only available when compiled with the |+printer|
6264 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006265 The CJK character set to be used for CJK output from |:hardcopy|.
6266 See |pmbcs-option|.
6267
6268 *'printmbfont'* *'pmbfn'*
6269'printmbfont' 'pmbfn' string (default "")
6270 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006271 {only available when compiled with the |+printer|
6272 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006273 List of font names to be used for CJK output from |:hardcopy|.
6274 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275
6276 *'printoptions'* *'popt'*
6277'printoptions' 'popt' string (default "")
6278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006280 List of items that control the format of the output of |:hardcopy|.
6281 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006283 *'prompt'* *'noprompt'*
6284'prompt' boolean (default on)
6285 global
6286 When on a ":" prompt is used in Ex mode.
6287
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006288 *'pumheight'* *'ph'*
6289'pumheight' 'ph' number (default 0)
6290 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006291 Determines the maximum number of items to show in the popup menu for
6292 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006293 |ins-completion-menu|.
6294
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006295 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006296'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006297 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006298 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006299 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006300
Bram Moolenaard94464e2015-11-02 15:28:18 +01006301 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006302'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006303 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006304 {only available when compiled with the |+python/dyn|
6305 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006306 Specifies the name of the Python 2.x shared library. The default is
6307 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006308 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006309 This option cannot be set from a |modeline| or in the |sandbox|, for
6310 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006311
Bram Moolenaar94073162018-01-31 21:49:05 +01006312 *'pythonhome'*
6313'pythonhome' string (default "")
6314 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006315 {only available when compiled with the |+python/dyn|
6316 feature}
6317 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6318 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6319 which was specified at compile time, will be used for the Python 2.x
6320 home directory.
6321 Environment variables are expanded |:set_env|.
6322 This option cannot be set from a |modeline| or in the |sandbox|, for
6323 security reasons.
6324
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006325 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006326'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006327 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006328 {only available when compiled with the |+python3/dyn|
6329 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006330 Specifies the name of the Python 3 shared library. The default is
6331 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006332 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006333 This option cannot be set from a |modeline| or in the |sandbox|, for
6334 security reasons.
6335
Bram Moolenaar94073162018-01-31 21:49:05 +01006336 *'pythonthreehome'*
6337'pythonthreehome' string (default "")
6338 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006339 {only available when compiled with the |+python3/dyn|
6340 feature}
6341 Specifies the name of the Python 3 home directory. When
6342 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6343 PYTHON3_HOME, which was specified at compile time, will be used for
6344 the Python 3 home directory.
6345 Environment variables are expanded |:set_env|.
6346 This option cannot be set from a |modeline| or in the |sandbox|, for
6347 security reasons.
6348
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006349 *'pyxversion'* *'pyx'*
6350'pyxversion' 'pyx' number (default depends on the build)
6351 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006352 {only available when compiled with the |+python| or
6353 the |+python3| feature}
6354 Specifies the python version used for pyx* functions and commands
6355 |python_x|. The default value is as follows:
6356
6357 Compiled with Default ~
6358 |+python| and |+python3| 0
6359 only |+python| 2
6360 only |+python3| 3
6361
6362 Available values are 0, 2 and 3.
6363 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6364 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6365 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6366 to 2 if Python 2 is available.
6367 See also: |has-pythonx|
6368
6369 If Vim is compiled with only |+python| or |+python3| setting
6370 'pyxversion' has no effect. The pyx* functions and commands are
6371 always the same as the compiled version.
6372
6373 This option cannot be set from a |modeline| or in the |sandbox|, for
6374 security reasons.
6375
Bram Moolenaar858ba062020-05-31 23:11:59 +02006376 *'quickfixtextfunc'* *'qftf'*
6377'quickfixtextfunc' 'qftf' string (default "")
6378 global
6379 {only available when compiled with the |+quickfix|
6380 feature}
6381 This option specifies a function to be used to get the text to display
6382 in the quickfix and location list windows. This can be used to
6383 customize the information displayed in the quickfix or location window
6384 for each entry in the corresponding quickfix or location list. See
6385 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006386 function and an example. The value can be the name of a function, a
6387 |lambda| or a |Funcref|. See |option-value-function| for more
6388 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006389
6390 This option cannot be set from a |modeline| or in the |sandbox|, for
6391 security reasons.
6392
Bram Moolenaar677ee682005-01-27 14:41:15 +00006393 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006394'quoteescape' 'qe' string (default "\")
6395 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006396 The characters that are used to escape quotes in a string. Used for
6397 objects like a', a" and a` |a'|.
6398 When one of the characters in this option is found inside a string,
6399 the following character will be skipped. The default value makes the
6400 text "foo\"bar\\" considered to be one string.
6401
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6403'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006404 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 If on, writes fail unless you use a '!'. Protects you from
6406 accidentally overwriting a file. Default on when Vim is started
6407 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006408 When using ":w!" the 'readonly' option is reset for the current
6409 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006410 When using the ":view" command the 'readonly' option is set for the
6411 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006412 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006414 *'redrawtime'* *'rdt'*
6415'redrawtime' 'rdt' number (default 2000)
6416 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006417 {only available when compiled with the |+reltime|
6418 feature}
6419 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006420 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006421 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006422 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006423 matches will be highlighted.
6424 For syntax highlighting the time applies per window. When over the
6425 limit syntax highlighting is disabled until |CTRL-L| is used.
6426 This is used to avoid that Vim hangs when using a very complicated
6427 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006428
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006429 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006430'regexpengine' 're' number (default 0)
6431 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006432 This selects the default regexp engine. |two-engines|
6433 The possible values are:
6434 0 automatic selection
6435 1 old engine
6436 2 NFA engine
6437 Note that when using the NFA engine and the pattern contains something
6438 that is not supported the pattern will not match. This is only useful
6439 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006440 Using automatic selection enables Vim to switch the engine, if the
6441 default engine becomes too costly. E.g., when the NFA engine uses too
6442 many states. This should prevent Vim from hanging on a combination of
6443 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006444
Bram Moolenaar64486672010-05-16 15:46:46 +02006445 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6446'relativenumber' 'rnu' boolean (default off)
6447 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006448 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006449 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006450 precede some vertical motion commands (e.g. j k + -) with, without
6451 having to calculate it yourself. Especially useful in combination with
6452 other commands (e.g. y d c < > gq gw =).
6453 When the 'n' option is excluded from 'cpoptions' a wrapped
6454 line will not use the column of line numbers (this is the default when
6455 'compatible' isn't set).
6456 The 'numberwidth' option can be used to set the room used for the line
6457 number.
6458 When a long, wrapped line doesn't start with the first character, '-'
6459 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006460 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6461 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006462
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006463 The number in front of the cursor line also depends on the value of
6464 'number', see |number_relativenumber| for all combinations of the two
6465 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006466
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 *'remap'* *'noremap'*
6468'remap' boolean (default on)
6469 global
6470 Allows for mappings to work recursively. If you do not want this for
6471 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006472 NOTE: To avoid portability problems with Vim scripts, always keep
6473 this option at the default "on". Only switch it off when working with
6474 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006476 *'renderoptions'* *'rop'*
6477'renderoptions' 'rop' string (default: empty)
6478 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006479 {only available when compiled with GUI and DIRECTX on
6480 MS-Windows}
6481 Select a text renderer and set its options. The options depend on the
6482 renderer.
6483
6484 Syntax: >
6485 set rop=type:{renderer}(,{name}:{value})*
6486<
6487 Currently, only one optional renderer is available.
6488
6489 render behavior ~
6490 directx Vim will draw text using DirectX (DirectWrite). It makes
6491 drawn glyphs more beautiful than default GDI.
6492 It requires 'encoding' is "utf-8", and only works on
6493 MS-Windows Vista or newer version.
6494
6495 Options:
6496 name meaning type value ~
6497 gamma gamma float 1.0 - 2.2 (maybe)
6498 contrast enhancedContrast float (unknown)
6499 level clearTypeLevel float (unknown)
6500 geom pixelGeometry int 0 - 2 (see below)
6501 renmode renderingMode int 0 - 6 (see below)
6502 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006503 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006504
Bram Moolenaar92467d32017-12-05 13:22:16 +01006505 See this URL for detail (except for scrlines):
6506 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006507
6508 For geom: structure of a device pixel.
6509 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6510 1 - DWRITE_PIXEL_GEOMETRY_RGB
6511 2 - DWRITE_PIXEL_GEOMETRY_BGR
6512
6513 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006514 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006515
6516 For renmode: method of rendering glyphs.
6517 0 - DWRITE_RENDERING_MODE_DEFAULT
6518 1 - DWRITE_RENDERING_MODE_ALIASED
6519 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6520 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6521 4 - DWRITE_RENDERING_MODE_NATURAL
6522 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6523 6 - DWRITE_RENDERING_MODE_OUTLINE
6524
6525 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006526 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006527
6528 For taamode: antialiasing mode used for drawing text.
6529 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6530 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6531 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6532 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6533
6534 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006535 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6536
Bram Moolenaara338adc2018-01-31 20:51:47 +01006537 For scrlines:
6538 This was used for optimizing scrolling behavior, however this
6539 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006540
6541 Example: >
6542 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006543 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006544 set rop=type:directx
6545<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006546 If select a raster font (Courier, Terminal or FixedSys which
6547 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006548 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006549
6550 NOTE: It is known that some fonts and options combination
6551 causes trouble on drawing glyphs.
6552
Bram Moolenaar92467d32017-12-05 13:22:16 +01006553 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006554 special made fonts (True-Type fonts which includes only
6555 bitmap glyphs).
6556 - 'taamode:3' will not work with some vector fonts.
6557
6558 NOTE: With this option, you can display colored emoji
6559 (emoticon) in Windows 8.1 or later. To display colored emoji,
6560 there are some conditions which you should notice.
6561
6562 - If your font includes non-colored emoji already, it will
6563 be used.
6564 - If your font doesn't have emoji, the system chooses an
6565 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6566 will be used.
6567 - When this alternative font didn't have fixed width glyph,
6568 emoji might be rendered beyond the bounding box of drawing
6569 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006570
6571 Other render types are currently not supported.
6572
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 *'report'*
6574'report' number (default 2)
6575 global
6576 Threshold for reporting number of lines changed. When the number of
6577 changed lines is more than 'report' a message will be given for most
6578 ":" commands. If you want it always, set 'report' to 0.
6579 For the ":substitute" command the number of substitutions is used
6580 instead of the number of lines.
6581
6582 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6583'restorescreen' 'rs' boolean (default on)
6584 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006585 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 When set, the screen contents is restored when exiting Vim. This also
6587 happens when executing external commands.
6588
6589 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6590 options in your .vimrc. To disable restoring:
6591 set t_ti= t_te=
6592 To enable restoring (for an xterm):
6593 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6594 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6595
6596 *'revins'* *'ri'* *'norevins'* *'nori'*
6597'revins' 'ri' boolean (default off)
6598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 {only available when compiled with the |+rightleft|
6600 feature}
6601 Inserting characters in Insert mode will work backwards. See "typing
6602 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6603 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006604 NOTE: This option is reset when 'compatible' is set.
6605 This option is reset when 'paste' is set and restored when 'paste' is
6606 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607
6608 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6609'rightleft' 'rl' boolean (default off)
6610 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 {only available when compiled with the |+rightleft|
6612 feature}
6613 When on, display orientation becomes right-to-left, i.e., characters
6614 that are stored in the file appear from the right to the left.
6615 Using this option, it is possible to edit files for languages that
6616 are written from the right to the left such as Hebrew and Arabic.
6617 This option is per window, so it is possible to edit mixed files
6618 simultaneously, or to view the same file in both ways (this is
6619 useful whenever you have a mixed text file with both right-to-left
6620 and left-to-right strings so that both sets are displayed properly
6621 in different windows). Also see |rileft.txt|.
6622
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006623 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624'rightleftcmd' 'rlc' string (default "search")
6625 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 {only available when compiled with the |+rightleft|
6627 feature}
6628 Each word in this option enables the command line editing to work in
6629 right-to-left mode for a group of commands:
6630
6631 search "/" and "?" commands
6632
6633 This is useful for languages such as Hebrew, Arabic and Farsi.
6634 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6635
Bram Moolenaard94464e2015-11-02 15:28:18 +01006636 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006637'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006638 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006639 {only available when compiled with the |+ruby/dyn|
6640 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006641 Specifies the name of the Ruby shared library. The default is
6642 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006643 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006644 This option cannot be set from a |modeline| or in the |sandbox|, for
6645 security reasons.
6646
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006648'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006651 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 text in the file is shown on the far right:
6653 Top first line is visible
6654 Bot last line is visible
6655 All first and last line are visible
6656 45% relative position in the file
6657 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006658 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006659 ruler is shown there. Otherwise it is shown in the last line of the
6660 screen. If the statusline is given by 'statusline' (i.e. not empty),
6661 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006663 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 the text column (byte number) and the screen column are shown,
6665 separated with a dash.
6666 For an empty line "0-1" is shown.
6667 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006668 This option is reset when 'paste' is set and restored when 'paste' is
6669 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 If you don't want to see the ruler all the time but want to know where
6671 you are, use "g CTRL-G" |g_CTRL-G|.
6672 NOTE: This option is reset when 'compatible' is set.
6673
6674 *'rulerformat'* *'ruf'*
6675'rulerformat' 'ruf' string (default empty)
6676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 {not available when compiled without the |+statusline|
6678 feature}
6679 When this option is not empty, it determines the content of the ruler
6680 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006681 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006682 This option cannot be set in a modeline when 'modelineexpr' is off.
6683
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 The default ruler width is 17 characters. To make the ruler 15
6685 characters wide, put "%15(" at the start and "%)" at the end.
6686 Example: >
6687 :set rulerformat=%15(%c%V\ %p%%%)
6688<
6689 *'runtimepath'* *'rtp'* *vimfiles*
6690'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006691 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 $VIM/vimfiles,
6693 $VIMRUNTIME,
6694 $VIM/vimfiles/after,
6695 $HOME/.vim/after"
6696 Amiga: "home:vimfiles,
6697 $VIM/vimfiles,
6698 $VIMRUNTIME,
6699 $VIM/vimfiles/after,
6700 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006701 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 $VIM/vimfiles,
6703 $VIMRUNTIME,
6704 $VIM/vimfiles/after,
6705 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006706 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 $VIMRUNTIME,
6708 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006709 Haiku: "$BE_USER_SETTINGS/vim,
6710 $VIM/vimfiles,
6711 $VIMRUNTIME,
6712 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006713 $BE_USER_SETTINGS/vim/after"
6714 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 $VIM/vimfiles,
6716 $VIMRUNTIME,
6717 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006718 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 This is a list of directories which will be searched for runtime
6721 files:
6722 filetype.vim filetypes by file name |new-filetype|
6723 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006724 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 colors/ color scheme files |:colorscheme|
6726 compiler/ compiler files |:compiler|
6727 doc/ documentation |write-local-help|
6728 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006729 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 indent/ indent scripts |indent-expression|
6731 keymap/ key mapping files |mbyte-keymap|
6732 lang/ menu translations |:menutrans|
6733 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006734 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 plugin/ plugin scripts |write-plugin|
6736 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006737 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 syntax/ syntax files |mysyntaxfile|
6739 tutor/ files for vimtutor |tutor|
6740
6741 And any other file searched for with the |:runtime| command.
6742
6743 The defaults for most systems are setup to search five locations:
6744 1. In your home directory, for your personal preferences.
6745 2. In a system-wide Vim directory, for preferences from the system
6746 administrator.
6747 3. In $VIMRUNTIME, for files distributed with Vim.
6748 *after-directory*
6749 4. In the "after" directory in the system-wide Vim directory. This is
6750 for the system administrator to overrule or add to the distributed
6751 defaults (rarely needed)
6752 5. In the "after" directory in your home directory. This is for
6753 personal preferences to overrule or add to the distributed defaults
6754 or system-wide settings (rarely needed).
6755
Bram Moolenaard0796902016-09-16 20:02:31 +02006756 More entries are added when using |packages|. If it gets very long
6757 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6758 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006759
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6761 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006762 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 wildcards.
6764 See |:runtime|.
6765 Example: >
6766 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6767< This will use the directory "~/vimruntime" first (containing your
6768 personal Vim runtime files), then "/mygroup/vim" (shared between a
6769 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6770 files).
6771 You probably should always include $VIMRUNTIME somewhere, to use the
6772 distributed runtime files. You can put a directory before $VIMRUNTIME
6773 to find files which replace a distributed runtime files. You can put
6774 a directory after $VIMRUNTIME to find files which add to distributed
6775 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006776 When Vim is started with |--clean| the home directory entries are not
6777 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 This option cannot be set from a |modeline| or in the |sandbox|, for
6779 security reasons.
6780
6781 *'scroll'* *'scr'*
6782'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006783 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6785 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006786 changes. This may happen when enabling the |status-line| or
6787 'tabline' option after setting the 'scroll' option.
6788 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006789 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006790 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791
6792 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6793'scrollbind' 'scb' boolean (default off)
6794 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006795 See also |scroll-binding|. When this option is set, scrolling the
6796 current window also scrolls other scrollbind windows (windows that
6797 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 differences between two versions of a file, see 'diff'.
6799 See |'scrollopt'| for options that determine how this option should be
6800 interpreted.
6801 This option is mostly reset when splitting a window to edit another
6802 file. This means that ":split | edit file" results in two windows
6803 with scroll-binding, but ":split file" does not.
6804
Bram Moolenaarae20f342019-11-05 21:09:23 +01006805 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6806'scrollfocus' 'scf' boolean (default off)
6807 global
6808 {only for MS-Windows GUI}
6809 When using the scroll wheel and this option is set, the window under
6810 the mouse pointer is scrolled. With this option off the current
6811 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006812 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006813
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 *'scrolljump'* *'sj'*
6815'scrolljump' 'sj' number (default 1)
6816 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 Minimal number of lines to scroll when the cursor gets off the
6818 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6819 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006820 When set to a negative number from -1 to -100 this is used as the
6821 percentage of the window height. Thus -50 scrolls half the window
6822 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 NOTE: This option is set to 1 when 'compatible' is set.
6824
6825 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006826'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006827 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 Minimal number of screen lines to keep above and below the cursor.
6829 This will make some context visible around where you are working. If
6830 you set it to a very large value (999) the cursor line will always be
6831 in the middle of the window (except at the start or end of the file or
6832 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006833 After using the local value, go back the global value with one of
6834 these two: >
6835 setlocal scrolloff<
6836 setlocal scrolloff=-1
6837< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 NOTE: This option is set to 0 when 'compatible' is set.
6839
6840 *'scrollopt'* *'sbo'*
6841'scrollopt' 'sbo' string (default "ver,jump")
6842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006844 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6845 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 The following words are available:
6847 ver Bind vertical scrolling for 'scrollbind' windows
6848 hor Bind horizontal scrolling for 'scrollbind' windows
6849 jump Applies to the offset between two windows for vertical
6850 scrolling. This offset is the difference in the first
6851 displayed line of the bound windows. When moving
6852 around in a window, another 'scrollbind' window may
6853 reach a position before the start or after the end of
6854 the buffer. The offset is not changed though, when
6855 moving back the 'scrollbind' window will try to scroll
6856 to the desired position when possible.
6857 When now making that window the current one, two
6858 things can be done with the relative offset:
6859 1. When "jump" is not included, the relative offset is
6860 adjusted for the scroll position in the new current
6861 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006862 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 2. When "jump" is included, the other windows are
6864 scrolled to keep the same relative offset. When
6865 going back to the other window, it still uses the
6866 same relative offset.
6867 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006868 When 'diff' mode is active there always is vertical scroll binding,
6869 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870
6871 *'sections'* *'sect'*
6872'sections' 'sect' string (default "SHNHH HUnhsh")
6873 global
6874 Specifies the nroff macros that separate sections. These are pairs of
6875 two letters (See |object-motions|). The default makes a section start
6876 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6877
6878 *'secure'* *'nosecure'* *E523*
6879'secure' boolean (default off)
6880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 When on, ":autocmd", shell and write commands are not allowed in
6882 ".vimrc" and ".exrc" in the current directory and map commands are
6883 displayed. Switch it off only if you know that you will not run into
6884 problems, or when the 'exrc' option is off. On Unix this option is
6885 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006886 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 'secure' at the end of your ~/.vimrc then.
6888 This option cannot be set from a |modeline| or in the |sandbox|, for
6889 security reasons.
6890
6891 *'selection'* *'sel'*
6892'selection' 'sel' string (default "inclusive")
6893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 This option defines the behavior of the selection. It is only used
6895 in Visual and Select mode.
6896 Possible values:
6897 value past line inclusive ~
6898 old no yes
6899 inclusive yes yes
6900 exclusive yes no
6901 "past line" means that the cursor is allowed to be positioned one
6902 character past the line.
6903 "inclusive" means that the last character of the selection is included
6904 in an operation. For example, when "x" is used to delete the
6905 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006906 When "old" is used and 'virtualedit' allows the cursor to move past
6907 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 Note that when "exclusive" is used and selecting from the end
6909 backwards, you cannot include the last character of a line, when
6910 starting in Normal mode and 'virtualedit' empty.
6911
6912 The 'selection' option is set by the |:behave| command.
6913
6914 *'selectmode'* *'slm'*
6915'selectmode' 'slm' string (default "")
6916 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006917 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 Select mode instead of Visual mode, when a selection is started.
6919 Possible values:
6920 mouse when using the mouse
6921 key when using shifted special keys
6922 cmd when using "v", "V" or CTRL-V
6923 See |Select-mode|.
6924 The 'selectmode' option is set by the |:behave| command.
6925
6926 *'sessionoptions'* *'ssop'*
6927'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006928 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006930 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 feature}
6932 Changes the effect of the |:mksession| command. It is a comma
6933 separated list of words. Each word enables saving and restoring
6934 something:
6935 word save and restore ~
6936 blank empty windows
6937 buffers hidden and unloaded buffers, not just those in windows
6938 curdir the current directory
6939 folds manually created folds, opened/closed folds and local
6940 fold options
6941 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006942 and contain at least one lowercase letter. Only
6943 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 help the help window
6945 localoptions options and mappings local to a window or buffer (not
6946 global values for local options)
6947 options all options and mappings (also global values for local
6948 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006949 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 resize size of the Vim window: 'lines' and 'columns'
6951 sesdir the directory in which the session file is located
6952 will become the current directory (useful with
6953 projects accessed over a network from different
6954 systems)
6955 slash backslashes in file names replaced with forward
6956 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006957 tabpages all tab pages; without this only the current tab page
6958 is restored, so that you can make a session for each
6959 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006960 terminal include terminal windows where the command can be
6961 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 unix with Unix end-of-line format (single <NL>), even when
6963 on Windows or DOS
6964 winpos position of the whole Vim window
6965 winsize window sizes
6966
6967 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006968 When neither "curdir" nor "sesdir" is included, file names are stored
6969 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006970 If you leave out "options" many things won't work well after restoring
6971 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 "slash" and "unix" are useful on Windows when sharing session files
6973 with Unix. The Unix version of Vim cannot source dos format scripts,
6974 but the Windows version of Vim can source unix format scripts.
6975
6976 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006977'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 global
6979 Name of the shell to use for ! and :! commands. When changing the
6980 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6981 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006982 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 See |option-backslash| about including spaces and backslashes.
6984 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006985
Bram Moolenaara2baa732022-02-04 16:09:54 +00006986 In |restricted-mode| shell commands will not be possible. This mode
6987 is used if the value of $SHELL ends in "false" or "nologin".
6988
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006989 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006990 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6992< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006993 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006995 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006997 Example with escaped space (Vim will do this when initializing the
6998 option from $SHELL): >
6999 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007000< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007001 backslashes are consumed by `:set`.
7002
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 Under MS-Windows, when the executable ends in ".com" it must be
7004 included. Thus setting the shell to "command.com" or "4dos.com"
7005 works, but "command" and "4dos" do not work for all commands (e.g.,
7006 filtering).
7007 For unknown reasons, when using "4dos.com" the current directory is
7008 changed to "C:\". To avoid this set 'shell' like this: >
7009 :set shell=command.com\ /c\ 4dos
7010< This option cannot be set from a |modeline| or in the |sandbox|, for
7011 security reasons.
7012
7013 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007014'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007015 Win32, when 'shell' contains "powershell":
7016 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007017 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007020 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7021 For MS-Windows, the default is set according to the value of 'shell',
7022 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007023 On Unix it can have more than one flag. Each white space separated
7024 part is passed as an argument to the shell command.
7025 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007026 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 This option cannot be set from a |modeline| or in the |sandbox|, for
7028 security reasons.
7029
7030 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007031'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7032 "2>&1| tee", or
7033 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 {not available when compiled without the |+quickfix|
7036 feature}
7037 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007038 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039 including spaces and backslashes.
7040 The name of the temporary file can be represented by "%s" if necessary
7041 (the file name is appended automatically if no %s appears in the value
7042 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007043 For the Amiga the default is ">". For MS-Windows using powershell the
7044 default is "2>&1 | Out-File -Encoding default", otherwise the default
7045 is ">%s 2>&1". The output is directly saved in a file and not echoed
7046 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007047 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 in a file and echoed to the screen. If the 'shell' option is "csh" or
7049 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007050 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007051 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7052 means that stderr is also included. Before using the 'shell' option a
7053 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007054 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7055 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056 The initialization of this option is done after reading the ".vimrc"
7057 and the other initializations, so that when the 'shell' option is set
7058 there, the 'shellpipe' option changes automatically, unless it was
7059 explicitly set before.
7060 When 'shellpipe' is set to an empty string, no redirection of the
7061 ":make" output will be done. This is useful if you use a 'makeprg'
7062 that writes to 'makeef' by itself. If you want no piping, but do
7063 want to include the 'makeef', set 'shellpipe' to a single space.
7064 Don't forget to precede the space with a backslash: ":set sp=\ ".
7065 In the future pipes may be used for filtering and this option will
7066 become obsolete (at least for Unix).
7067 This option cannot be set from a |modeline| or in the |sandbox|, for
7068 security reasons.
7069
7070 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007071'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 Quoting character(s), put around the command passed to the shell, for
7074 the "!" and ":!" commands. The redirection is kept outside of the
7075 quoting. See 'shellxquote' to include the redirection. It's
7076 probably not useful to set both options.
7077 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007078 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007079 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 This option cannot be set from a |modeline| or in the |sandbox|, for
7081 security reasons.
7082
7083 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007084'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7085 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 String to be used to put the output of a filter command in a temporary
7088 file. See also |:!|. See |option-backslash| about including spaces
7089 and backslashes.
7090 The name of the temporary file can be represented by "%s" if necessary
7091 (the file name is appended automatically if no %s appears in the value
7092 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007093 The default is ">". For Unix, if the 'shell' option is "csh" or
7094 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007095 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007096 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7097 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007098 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7099 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007100 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7101 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 The initialization of this option is done after reading the ".vimrc"
7103 and the other initializations, so that when the 'shell' option is set
7104 there, the 'shellredir' option changes automatically unless it was
7105 explicitly set before.
7106 In the future pipes may be used for filtering and this option will
7107 become obsolete (at least for Unix).
7108 This option cannot be set from a |modeline| or in the |sandbox|, for
7109 security reasons.
7110
7111 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7112'shellslash' 'ssl' boolean (default off)
7113 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007114 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007116 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007117 powershell.exe. Backward slashes can still be typed, but they are
7118 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 Note that setting or resetting this option has no effect for some
7120 existing file names, thus this option needs to be set before opening
7121 any file for best results. This might change in the future.
7122 'shellslash' only works when a backslash can be used as a path
7123 separator. To test if this is so use: >
7124 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007125< Also see 'completeslash'.
7126
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007127 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7128'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7129 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007130 When on, use temp files for shell commands. When off use a pipe.
7131 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007132 Currently a pipe is only supported on Unix and MS-Windows 2K and
7133 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007134 :if has("filterpipe")
7135< The advantage of using a pipe is that nobody can read the temp file
7136 and the 'shell' command does not need to support redirection.
7137 The advantage of using a temp file is that the file type and encoding
7138 can be detected.
7139 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7140 |FilterWritePost| autocommands event are not triggered when
7141 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007142 The `system()` function does not respect this option and always uses
7143 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007144 NOTE: This option is set to the Vim default value when 'compatible'
7145 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007146
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 *'shelltype'* *'st'*
7148'shelltype' 'st' number (default 0)
7149 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007150 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 On the Amiga this option influences the way how the commands work
7152 which use a shell.
7153 0 and 1: always use the shell
7154 2 and 3: use the shell only to filter lines
7155 4 and 5: use shell only for ':sh' command
7156 When not using the shell, the command is executed directly.
7157
7158 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7159 1 and 3: use "shell cmd" to start external commands
7160
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007161 *'shellxescape'* *'sxe'*
7162'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007163 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007164 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007165 When 'shellxquote' is set to "(" then the characters listed in this
7166 option will be escaped with a '^' character. This makes it possible
7167 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007168 This option cannot be set from a |modeline| or in the |sandbox|, for
7169 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007170
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 *'shellxquote'* *'sxq'*
7172'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007173 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007174 for Win32, when 'shell' is
7175 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007176 for Win32, when 'shell' contains "sh"
7177 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 for Unix, when using system(): "\"")
7179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 Quoting character(s), put around the command passed to the shell, for
7181 the "!" and ":!" commands. Includes the redirection. See
7182 'shellquote' to exclude the redirection. It's probably not useful
7183 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007184 When the value is '(' then ')' is appended. When the value is '"('
7185 then ')"' is appended.
7186 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007187 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007188 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7189 pwsh.exe which automatically strips off the first and last quote on a
7190 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7191 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007192 'shell', to reduce the need to set this option by the user. See
7193 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 This option cannot be set from a |modeline| or in the |sandbox|, for
7195 security reasons.
7196
7197 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7198'shiftround' 'sr' boolean (default off)
7199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 Round indent to multiple of 'shiftwidth'. Applies to > and <
7201 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7202 a multiple of 'shiftwidth' (this is Vi compatible).
7203 NOTE: This option is reset when 'compatible' is set.
7204
7205 *'shiftwidth'* *'sw'*
7206'shiftwidth' 'sw' number (default 8)
7207 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007208 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007210 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007211 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212
7213 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007214'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7215 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007216 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 This option helps to avoid all the |hit-enter| prompts caused by file
7218 messages, for example with CTRL-G, and to avoid some other messages.
7219 It is a list of flags:
7220 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007221 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7222 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7223 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7224 m use "[+]" instead of "[Modified]" *shm-m*
7225 n use "[New]" instead of "[New File]" *shm-n*
7226 r use "[RO]" instead of "[readonly]" *shm-r*
7227 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007229 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7230 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007231 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007232 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007234 o overwrite message for writing a file with subsequent *shm-o*
7235 message for reading a file (useful for ":wn" or when
7236 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007237 O message for reading a file overwrites any previous *shm-O*
7238 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007239 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7240 "search hit TOP, continuing at BOTTOM" messages; when using
7241 the search count do not show "W" after the count message (see
7242 S below)
7243 t truncate file message at the start if it is too long *shm-t*
7244 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007245 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007246 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007247 long to fit on the command line; "..." will appear in the
7248 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007249 W don't give "written" or "[w]" when writing a file *shm-W*
7250 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007251 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007252 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007253 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007254 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007255 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7256 match", "Pattern not found", "Back at original", etc.
7257 C don't give messages while scanning for ins-completion *shm-C*
7258 items, for instance "scanning tags"
7259 q use "recording" instead of "recording @a" *shm-q*
7260 F don't give the file info when editing a file, like *shm-F*
7261 `:silent` was used for the command; note that this also
7262 affects messages from autocommands
Bram Moolenaar938ae282023-02-20 20:44:55 +00007263 S do not show search count message when searching, e.g. *shm-S*
7264 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265
7266 This gives you the opportunity to avoid that a change between buffers
7267 requires you to hit <Enter>, but still gives as useful a message as
7268 possible for the space available. To get the whole message that you
7269 would have got with 'shm' empty, use ":file!"
7270 Useful values:
7271 shm= No abbreviation of message.
7272 shm=a Abbreviation, but no loss of information.
7273 shm=at Abbreviation, and truncate message when necessary.
7274
7275 NOTE: This option is set to the Vi default value when 'compatible' is
7276 set and to the Vim default value when 'compatible' is reset.
7277
7278 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7279'shortname' 'sn' boolean (default off)
7280 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 Filenames are assumed to be 8 characters plus one extension of 3
7282 characters. Multiple dots in file names are not allowed. When this
7283 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007284 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007286 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287
7288 *'showbreak'* *'sbr'* *E595*
7289'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007290 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007291 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 feature}
7293 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007294 values are "> " or "+++ ": >
7295 :set showbreak=>\
7296< Note the backslash to escape the trailing space. It's easier like
7297 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007298 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007299< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 comma (in a future version the comma might be used to separate the
7301 part that is shown at the end and at the start of a line).
7302 The characters are highlighted according to the '@' flag in
7303 'highlight'.
7304 Note that tabs after the showbreak will be displayed differently.
7305 If you want the 'showbreak' to appear in between line numbers, add the
7306 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007307 A window-local value overrules a global value. If the global value is
7308 set and you want no value in the current window use NONE: >
7309 :setlocal showbreak=NONE
7310<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007312'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7313 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007315 Show (partial) command in the last line of the screen. Set this
7316 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 In Visual mode the size of the selected area is shown:
7318 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007319 If the number of bytes is different it is also displayed: "2-6"
7320 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007322 - When selecting a block, the size in screen characters:
7323 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007324 This information can be displayed in an alternative location using the
7325 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 NOTE: This option is set to the Vi default value when 'compatible' is
7327 set and to the Vim default value when 'compatible' is reset.
7328
Luuk van Baalba936f62022-12-15 13:15:39 +00007329 *'showcmdloc'* *'sloc'*
7330'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007331 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007332 This option can be used to display the (partially) entered command in
7333 another location. Possible values are:
7334 last Last line of the screen (default).
7335 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007336 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007337 Setting this option to "statusline" or "tabline" means that these will
7338 be redrawn whenever the command changes, which can be on every key
7339 pressed.
7340 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7341 place the text. Without a custom 'statusline' or 'tabline' it will be
7342 displayed in a convenient location.
7343
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7345'showfulltag' 'sft' boolean (default off)
7346 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 When completing a word in insert mode (see |ins-completion|) from the
7348 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007349 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350 matched a C function, you can see a template for what arguments are
7351 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007352 Note that this doesn't work well together with having "longest" in
7353 'completeopt', because the completion from the search pattern may not
7354 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355
7356 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7357'showmatch' 'sm' boolean (default off)
7358 global
7359 When a bracket is inserted, briefly jump to the matching one. The
7360 jump is only done if the match can be seen on the screen. The time to
7361 show the match can be set with 'matchtime'.
7362 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007363 seen or not).
7364 This option is reset when 'paste' is set and restored when 'paste' is
7365 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 When the 'm' flag is not included in 'cpoptions', typing a character
7367 will immediately move the cursor back to where it belongs.
7368 See the "sm" field in 'guicursor' for setting the cursor shape and
7369 blinking when showing the match.
7370 The 'matchpairs' option can be used to specify the characters to show
7371 matches for. 'rightleft' and 'revins' are used to look for opposite
7372 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007373 Also see the matchparen plugin for highlighting the match when moving
7374 around |pi_paren.txt|.
7375 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376
7377 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7378'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7379 global
7380 If in Insert, Replace or Visual mode put a message on the last line.
7381 Use the 'M' flag in 'highlight' to set the type of highlighting for
7382 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007383 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 doesn't mean XIM is really active, especially when 'imactivatekey' is
7385 not set.
7386 NOTE: This option is set to the Vi default value when 'compatible' is
7387 set and to the Vim default value when 'compatible' is reset.
7388
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007389 *'showtabline'* *'stal'*
7390'showtabline' 'stal' number (default 1)
7391 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007392 The value of this option specifies when the line with tab page labels
7393 will be displayed:
7394 0: never
7395 1: only if there are at least two tab pages
7396 2: always
7397 This is both for the GUI and non-GUI implementation of the tab pages
7398 line.
7399 See |tab-page| for more information about tab pages.
7400
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401 *'sidescroll'* *'ss'*
7402'sidescroll' 'ss' number (default 0)
7403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 The minimal number of columns to scroll horizontally. Used only when
7405 the 'wrap' option is off and the cursor is moved off of the screen.
7406 When it is zero the cursor will be put in the middle of the screen.
7407 When using a slow terminal set it to a large number or 0. When using
7408 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7409 commands.
7410
7411 *'sidescrolloff'* *'siso'*
7412'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007413 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007415 right of the cursor if 'nowrap' is set. Setting this option to a
7416 value greater than 0 while having |'sidescroll'| also at a non-zero
7417 value makes some context visible in the line you are scrolling in
7418 horizontally (except at beginning of the line). Setting this option
7419 to a large value (like 999) has the effect of keeping the cursor
7420 horizontally centered in the window, as long as one does not come too
7421 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007422 After using the local value, go back the global value with one of
7423 these two: >
7424 setlocal sidescrolloff<
7425 setlocal sidescrolloff=-1
7426< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427
7428 Example: Try this together with 'sidescroll' and 'listchars' as
7429 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007430 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431
7432 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7433 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007434<
7435 *'signcolumn'* *'scl'*
7436'signcolumn' 'scl' string (default "auto")
7437 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007438 {not available when compiled without the |+signs|
7439 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007440 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007441 "auto" only when there is a sign to display
7442 "no" never
7443 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007444 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007445 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446
7447
7448 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7449'smartcase' 'scs' boolean (default off)
7450 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 Override the 'ignorecase' option if the search pattern contains upper
7452 case characters. Only used when the search pattern is typed and
7453 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007454 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7456 recalling the search pattern from history and hitting <Enter>.
7457 NOTE: This option is reset when 'compatible' is set.
7458
7459 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7460'smartindent' 'si' boolean (default off)
7461 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 Do smart autoindenting when starting a new line. Works for C-like
7463 programs, but can also be used for other languages. 'cindent' does
7464 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007465 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007466 setting 'si' has no effect. 'indentexpr' is a more advanced
7467 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 Normally 'autoindent' should also be on when using 'smartindent'.
7469 An indent is automatically inserted:
7470 - After a line ending in '{'.
7471 - After a line starting with a keyword from 'cinwords'.
7472 - Before a line starting with '}' (only with the "O" command).
7473 When typing '}' as the first character in a new line, that line is
7474 given the same indent as the matching '{'.
7475 When typing '#' as the first character in a new line, the indent for
7476 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007477 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7479 When using the ">>" command, lines starting with '#' are not shifted
7480 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007481 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007482 This option is reset when 'paste' is set and restored when 'paste' is
7483 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484
7485 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7486'smarttab' 'sta' boolean (default off)
7487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007489 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7490 <BS> will delete a 'shiftwidth' worth of space at the start of the
7491 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007492 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007493 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7494 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007495 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007497 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007498 This option is reset when 'paste' is set and restored when 'paste' is
7499 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500 NOTE: This option is reset when 'compatible' is set.
7501
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007502 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7503'smoothscroll' 'sms' boolean (default off)
7504 local to window
7505 Scrolling works with screen lines. When 'wrap' is set and the first
7506 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007507 above the window. "<<<" is displayed at the start of the first line,
7508 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007509 You may also want to add "lastline" to the 'display' option to show as
7510 much of the last line as possible.
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007511 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
7512 and scrolling with the mouse.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007513
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 *'softtabstop'* *'sts'*
7515'softtabstop' 'sts' number (default 0)
7516 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 Number of spaces that a <Tab> counts for while performing editing
7518 operations, like inserting a <Tab> or using <BS>. It "feels" like
7519 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7520 used. This is useful to keep the 'ts' setting at its standard value
7521 of 8, while being able to edit like it is set to 'sts'. However,
7522 commands like "x" still work on the actual characters.
7523 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007524 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007525 'softtabstop' is set to 0 when the 'paste' option is set and restored
7526 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7528 spaces is minimized by using <Tab>s.
7529 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7530 set.
7531 NOTE: This option is set to 0 when 'compatible' is set.
7532
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007533 If Vim is compiled with the |+vartabs| feature then the value of
7534 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7535 anything other than an empty string.
7536
Bram Moolenaar217ad922005-03-20 22:37:15 +00007537 *'spell'* *'nospell'*
7538'spell' boolean (default off)
7539 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007540 {not available when compiled without the |+syntax|
7541 feature}
7542 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007543 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007544
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007545 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007546'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007547 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007548 {not available when compiled without the |+syntax|
7549 feature}
7550 Pattern to locate the end of a sentence. The following word will be
7551 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007552 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007553 When this check is not wanted make this option empty.
7554 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007555 Be careful with special characters, see |option-backslash| about
7556 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007557 To set this option automatically depending on the language, see
7558 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007559
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007560 *'spellfile'* *'spf'*
7561'spellfile' 'spf' string (default empty)
7562 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007563 {not available when compiled without the |+syntax|
7564 feature}
7565 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007566 commands. It must end in ".{encoding}.add". You need to include the
7567 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007568 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007569 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007570 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007571 |zg| and |zw| commands can be used to access each. This allows using
7572 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007573 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007574 you: Using the first directory in 'runtimepath' that is writable. If
7575 there is no "spell" directory yet it will be created. For the file
7576 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007577 ignoring the region.
7578 The resulting ".spl" file will be used for spell checking, it does not
7579 have to appear in 'spelllang'.
7580 Normally one file is used for all regions, but you can add the region
7581 name if you want to. However, it will then only be used when
7582 'spellfile' is set to it, for entries in 'spelllang' only files
7583 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007584 This option cannot be set from a |modeline| or in the |sandbox|, for
7585 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007586
Bram Moolenaar217ad922005-03-20 22:37:15 +00007587 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007588'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007589 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007590 {not available when compiled without the |+syntax|
7591 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007592 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007593 on spellchecking will be done for these languages. Example: >
7594 set spelllang=en_us,nl,medical
7595< This means US English, Dutch and medical words are recognized. Words
7596 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007597 The word list name must consist of alphanumeric characters, a dash or
7598 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007599 recommended to separate the two letter language name from a
7600 specification. Thus "en-rare" is used for rare English words.
7601 A region name must come last and have the form "_xx", where "xx" is
7602 the two-letter, lower case region name. You can use more than one
7603 region by listing them: "en_us,en_ca" supports both US and Canadian
7604 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007605 Britain. (Note: currently en_au and en_nz dictionaries are older than
7606 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007607 If the name "cjk" is included East Asian characters are excluded from
7608 spell checking. This is useful when editing text that also has Asian
7609 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007610 Note that the "medical" dictionary does not exist, it is just an
7611 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007612 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007613 As a special case the name of a .spl file can be given as-is. The
7614 first "_xx" in the name is removed and used as the region name
7615 (_xx is an underscore, two letters and followed by a non-letter).
7616 This is mainly for testing purposes. You must make sure the correct
7617 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007618 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007619 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7620 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007621 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007622
Bram Moolenaar98692072006-02-04 00:57:42 +00007623 If the |spellfile.vim| plugin is active and you use a language name
7624 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7625 will ask you if you want to download the file.
7626
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007627 After this option has been set successfully, Vim will source the files
7628 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007629 up to the first character that is not an ASCII letter or number and
7630 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007631
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007632 *'spelloptions'* *'spo'*
7633'spelloptions' 'spo' string (default "")
7634 local to buffer
7635 {not available when compiled without the |+syntax|
7636 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007637 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007638 camel When a word is CamelCased, assume "Cased" is a
7639 separate word: every upper-case character in a word
7640 that comes after a lower case character indicates the
7641 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007642
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007643 *'spellsuggest'* *'sps'*
7644'spellsuggest' 'sps' string (default "best")
7645 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007646 {not available when compiled without the |+syntax|
7647 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007648 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007649 the |spellsuggest()| function. This is a comma-separated list of
7650 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007651
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007652 best Internal method that works best for English. Finds
7653 changes like "fast" and uses a bit of sound-a-like
7654 scoring to improve the ordering.
7655
7656 double Internal method that uses two methods and mixes the
7657 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007658 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007659 word. That only works when the language specifies
7660 sound folding. Can be slow and doesn't always give
7661 better results.
7662
7663 fast Internal method that only checks for simple changes:
7664 character inserts/deletes/swaps. Works well for
7665 simple typing mistakes.
7666
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007667 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007668 Not used for |spellsuggest()|. The number of
7669 suggestions is never more than the value of 'lines'
7670 minus two.
7671
Bram Moolenaar585ee072022-01-29 11:22:17 +00007672 timeout:{millisec} Limit the time searching for suggestions to
7673 {millisec} milli seconds. Applies to the following
7674 methods. When omitted the limit is 5000. When
7675 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007676 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007677
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007678 file:{filename} Read file {filename}, which must have two columns,
7679 separated by a slash. The first column contains the
7680 bad word, the second column the suggested good word.
7681 Example:
7682 theribal/terrible ~
7683 Use this for common mistakes that do not appear at the
7684 top of the suggestion list with the internal methods.
7685 Lines without a slash are ignored, use this for
7686 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007687 The word in the second column must be correct,
7688 otherwise it will not be used. Add the word to an
7689 ".add" file if it is currently flagged as a spelling
7690 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007691 The file is used for all languages.
7692
7693 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007694 trouble with spaces. Best is to call a function
7695 without arguments, see |expr-option-function|.
7696 |v:val| holds the badly spelled word. The expression
7697 must evaluate to a List of Lists, each with a
7698 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007699 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007700 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007701 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007702 internal methods use. A lower score is better.
7703 This may invoke |spellsuggest()| if you temporarily
7704 set 'spellsuggest' to exclude the "expr:" part.
7705 Errors are silently ignored, unless you set the
7706 'verbose' option to a non-zero value.
7707
7708 Only one of "best", "double" or "fast" may be used. The others may
7709 appear several times in any order. Example: >
7710 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7711<
7712 This option cannot be set from a |modeline| or in the |sandbox|, for
7713 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007714
7715
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7717'splitbelow' 'sb' boolean (default off)
7718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 When on, splitting a window will put the new window below the current
7720 one. |:split|
7721
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007722 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007723'splitkeep' 'spk' string (default "cursor")
7724 global
7725 The value of this option determines the scroll behavior when opening,
7726 closing or resizing horizontal splits.
7727
7728 Possible values are:
7729 cursor Keep the same relative cursor position.
7730 screen Keep the text on the same screen line.
7731 topline Keep the topline the same.
7732
7733 For the "screen" and "topline" values, the cursor position will be
7734 changed when necessary. In this case, the jumplist will be populated
7735 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007736 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007737
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7739'splitright' 'spr' boolean (default off)
7740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741 When on, splitting a window will put the new window right of the
7742 current one. |:vsplit|
7743
7744 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7745'startofline' 'sol' boolean (default on)
7746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007748 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007749 (if possible). This applies to the commands:
7750 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7751 - "d", "<<" and ">>" with a linewise operator
7752 - "%" with a count
7753 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7754 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 In case of buffer changing commands the cursor is placed at the column
7756 where it was the last time the buffer was edited.
7757 NOTE: This option is set when 'compatible' is set.
7758
Bram Moolenaar00654022011-02-25 14:42:19 +01007759 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007761 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762 {not available when compiled without the |+statusline|
7763 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007764 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 Also see |status-line|.
7766
7767 The option consists of printf style '%' items interspersed with
7768 normal text. Each status line item is of the form:
7769 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007770 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007771 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772
Bram Moolenaar238a5642006-02-21 22:12:05 +00007773 When the option starts with "%!" then it is used as an expression,
7774 evaluated and the result is used as the option value. Example: >
7775 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007776< The *g:statusline_winid* variable will be set to the |window-ID| of the
7777 window that the status line belongs to.
7778 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007779 Note that the "%!" expression is evaluated in the context of the
7780 current window and buffer, while %{} items are evaluated in the
7781 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007782
7783 When there is error while evaluating the option then it will be made
7784 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007785 When the result contains unprintable characters the result is
7786 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007787
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 Note that the only effect of 'ruler' when this option is set (and
7789 'laststatus' is 2) is controlling the output of |CTRL-G|.
7790
7791 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007792 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007794 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795 minwid Minimum width of the item, padding as set by '-' & '0'.
7796 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007797 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 on the left for text items. Numeric items will be
7799 shifted down to maxwid-2 digits followed by '>'number
7800 where number is the amount of missing digits, much like
7801 an exponential notation.
7802 item A one letter code as described below.
7803
7804 Following is a description of the possible statusline items. The
7805 second character in "item" is the type:
7806 N for number
7807 S for string
7808 F for flags as described below
7809 - not applicable
7810
7811 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007812 f S Path to the file in the buffer, as typed or relative to current
7813 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007814 F S Full path to the file in the buffer.
7815 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007816 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007818 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007820 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007822 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007824 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007826 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7828 being used: "<keymap>"
7829 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007830 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 B N As above, in hexadecimal.
7832 o N Byte number in file of byte under cursor, first byte is 1.
7833 Mnemonic: Offset from start of file (with one added)
7834 {not available when compiled without |+byte_offset| feature}
7835 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007836 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 l N Line number.
7838 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007839 c N Column number (byte index).
7840 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007841 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842 p N Percentage through file in lines as in |CTRL-G|.
7843 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007844 percentage described for 'ruler'. Always 3 in length, unless
7845 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007846 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007847 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007849 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007850 Note that there is no '%' before the closing '}'. The
7851 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007852 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007853 {% - This is almost same as { except the result of the expression is
7854 re-evaluated as a statusline format string. Thus if the
7855 return value of expr contains % items they will get expanded.
7856 The expression can contain the } character, the end of
7857 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007858 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007859 func! Stl_filename() abort
7860 return "%t"
7861 endfunc
7862< `stl=%{Stl_filename()}` results in `"%t"`
7863 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007864 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 ( - Start of item group. Can be used for setting the width and
7866 alignment of a section. Must be followed by %) somewhere.
7867 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007868 T N For 'tabline': start of tab page N label. Use %T after the last
7869 label. This information is used for mouse clicks.
7870 X N For 'tabline': start of close tab N label. Use %X after the
7871 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7872 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 < - Where to truncate line if too long. Default is at the start.
7874 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007875 = - Separation point between alignment sections. Each section will
7876 be separated by an equal number of spaces. With one %= what
7877 comes after it will be right-aligned. With two %= there is a
7878 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007880 # - Set highlight group. The name must follow and then a # again.
7881 Thus use %#HLname# for highlight group HLname. The same
7882 highlighting is used, also for the statusline of non-current
7883 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007885 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007886 The difference between User{N} and StatusLine will be applied to
7887 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 The number N must be between 1 and 9. See |hl-User1..9|
7889
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007890 When displaying a flag, Vim removes the leading comma, if any, when
7891 that flag comes right after plaintext. This will make a nice display
7892 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893
Bram Moolenaar582fd852005-03-28 20:58:01 +00007894 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007895 not set) and a minwid is not set for the group, the whole group will
7896 become empty. This will make a group like the following disappear
7897 completely from the statusline when none of the flags are set. >
7898 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007899< Beware that an expression is evaluated each and every time the status
7900 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007901 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007902 While evaluating %{} the current buffer and current window will be set
7903 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007904 currently being drawn. The expression will evaluate in this context.
7905 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7906 real current buffer and "g:actual_curwin" to the |window-ID| of the
7907 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007908
Bram Moolenaar30b65812012-07-12 22:01:11 +02007909 The 'statusline' option will be evaluated in the |sandbox| if set from
7910 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007911 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007912
7913 It is not allowed to change text or jump to another window while
7914 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915
7916 If the statusline is not updated when you want it (e.g., after setting
7917 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007918 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007920 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921 Otherwise the result is taken as flag text and applied to the rules
7922 described above.
7923
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007924 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007926 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927
7928 Examples:
7929 Emulate standard status line with 'ruler' set >
7930 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7931< Similar, but add ASCII value of char under the cursor (like "ga") >
7932 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7933< Display byte count and byte value, modified flag in red. >
7934 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7935 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7936< Display a ,GZ flag if a compressed file is loaded >
7937 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7938< In the |:autocmd|'s: >
7939 :let b:gzflag = 1
7940< And: >
7941 :unlet b:gzflag
7942< And define this function: >
7943 :function VarExists(var, val)
7944 : if exists(a:var) | return a:val | else | return '' | endif
7945 :endfunction
7946<
7947 *'suffixes'* *'su'*
7948'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 Files with these suffixes get a lower priority when multiple files
7951 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007952 suffixes. Spaces after the comma are ignored. A dot is also seen as
7953 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 separator, precede it with a backslash (see |option-backslash| about
7955 including spaces and backslashes).
7956 See 'wildignore' for completely ignoring files.
7957 The use of |:set+=| and |:set-=| is preferred when adding or removing
7958 suffixes from the list. This avoids problems when a future version
7959 uses another default.
7960
7961 *'suffixesadd'* *'sua'*
7962'suffixesadd' 'sua' string (default "")
7963 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007964 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 file for the "gf", "[I", etc. commands. Example: >
7966 :set suffixesadd=.java
7967<
7968 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7969'swapfile' 'swf' boolean (default on)
7970 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007971 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 swapfile is not wanted for a specific buffer. For example, with
7973 confidential information that even root must not be able to access.
7974 Careful: All text will be in memory:
7975 - Don't use this for big files.
7976 - Recovery will be impossible!
7977 A swapfile will only be present when |'updatecount'| is non-zero and
7978 'swapfile' is set.
7979 When 'swapfile' is reset, the swap file for the current buffer is
7980 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7981 non-zero, a swap file is immediately created.
7982 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007983 If you want to open a new buffer without creating a swap file for it,
7984 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007985 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986
7987 This option is used together with 'bufhidden' and 'buftype' to
7988 specify special kinds of buffers. See |special-buffers|.
7989
7990 *'swapsync'* *'sws'*
7991'swapsync' 'sws' string (default "fsync")
7992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007994 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 When this option is empty parts of the swap file may be in memory and
7996 not written to disk. When the system crashes you may lose more work.
7997 On Unix the system does a sync now and then without Vim asking for it,
7998 so the disadvantage of setting this option off is small. On some
7999 systems the swap file will not be written at all. For a unix system
8000 setting it to "sync" will use the sync() call instead of the default
8001 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008002 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003
8004 *'switchbuf'* *'swb'*
8005'switchbuf' 'swb' string (default "")
8006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008008 This option is checked, when
8009 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008010 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008011 - jumping to a tag using the |:stag| command.
8012 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8013 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8014 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008015 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008016 useopen If included, jump to the first open window in the
8017 current tab page that contains the specified buffer
8018 (if there is one). Otherwise: Do not examine other
8019 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008020 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008021 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008023 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008024 Otherwise: do not split, use current window (when used
8025 in the quickfix window: the previously used window or
8026 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008027 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008028 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008029 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008030 uselast If included, jump to the previously used window when
8031 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008033 *'synmaxcol'* *'smc'*
8034'synmaxcol' 'smc' number (default 3000)
8035 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008036 {not available when compiled without the |+syntax|
8037 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008038 Maximum column in which to search for syntax items. In long lines the
8039 text after this column is not highlighted and following lines may not
8040 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008041 This helps to avoid very slow redrawing for an XML file that is one
8042 long line.
8043 Set to zero to remove the limit.
8044
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 *'syntax'* *'syn'*
8046'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008047 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 {not available when compiled without the |+syntax|
8049 feature}
8050 When this option is set, the syntax with this name is loaded, unless
8051 syntax highlighting has been switched off with ":syntax off".
8052 Otherwise this option does not always reflect the current syntax (the
8053 b:current_syntax variable does).
8054 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008055 not automatically recognized. Example, in an IDL file:
8056 /* vim: set syntax=idl : */ ~
8057 When a dot appears in the value then this separates two filetype
8058 names. Example:
8059 /* vim: set syntax=c.doxygen : */ ~
8060 This will use the "c" syntax first, then the "doxygen" syntax.
8061 Note that the second one must be prepared to be loaded as an addition,
8062 otherwise it will be skipped. More than one dot may appear.
8063 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 :set syntax=OFF
8065< To switch syntax highlighting on according to the current value of the
8066 'filetype' option: >
8067 :set syntax=ON
8068< What actually happens when setting the 'syntax' option is that the
8069 Syntax autocommand event is triggered with the value as argument.
8070 This option is not copied to another buffer, independent of the 's' or
8071 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008072 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008074 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008075'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008076 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008077 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008078 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008079 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008080
8081 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008082 option and only when there is no GUI tab line. When 'e' is in
8083 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008084 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008085
8086 The value is evaluated like with 'statusline'. You can use
8087 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008088 the text to be displayed. Use "%1T" for the first label, "%2T" for
8089 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008090
Bram Moolenaare12bab32019-01-08 22:02:56 +01008091 When changing something that is used in 'tabline' that does not
8092 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008093 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008094
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008095 Keep in mind that only one of the tab pages is the current one, others
8096 are invisible and you can't jump to their windows.
8097
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008098
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008099 *'tabpagemax'* *'tpm'*
8100'tabpagemax' 'tpm' number (default 10)
8101 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008102 Maximum number of tab pages to be opened by the |-p| command line
8103 argument or the ":tab all" command. |tabpage|
8104
8105
8106 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107'tabstop' 'ts' number (default 8)
8108 local to buffer
8109 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008110 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008111
8112 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008113 appear wrong in many places, e.g., when printing it.
8114 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115
8116 There are four main ways to use tabs in Vim:
8117 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8118 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008119 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008121 This is the recommended way, the file will look the same with other
8122 tools and when listing it in a terminal.
8123 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8124 'expandtab'. This way you will always insert spaces. The
8125 formatting will never be messed up when 'tabstop' is changed (leave
8126 it at 8 just in case). The file will be a bit larger.
8127 You do need to check if no Tabs exist in the file. You can get rid
8128 of them by first setting 'expandtab' and using `%retab!`, making
8129 sure the value of 'tabstop' is set correctly.
8130 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 'expandtab'. This way you will always insert spaces. The
8132 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008133 You do need to check if no Tabs exist in the file, just like in the
8134 item just above.
8135 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008136 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008137 works when using Vim to edit the file, other tools assume a tabstop
8138 is worth 8 spaces.
8139 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 'noexpandtab'. This should then work (for initial indents only)
8141 for any tabstop setting that people use. It might be nice to have
8142 tabs after the first non-blank inserted as spaces if you do this
8143 though. Otherwise aligned comments will be wrong when 'tabstop' is
8144 changed.
8145
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008146 If Vim is compiled with the |+vartabs| feature then the value of
8147 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8148 than an empty string.
8149
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8151'tagbsearch' 'tbs' boolean (default on)
8152 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008153 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008154 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 searching makes searching for a tag a LOT faster, but a linear search
8156 will find more tags if the tags file wasn't properly sorted.
8157 Vim normally assumes that your tags files are sorted, or indicate that
8158 they are not sorted. Only when this is not the case does the
8159 'tagbsearch' option need to be switched off.
8160
8161 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008162 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 certain files, or retry all files with a linear search. When
8164 'tagbsearch' is off, only a linear search is done.
8165
8166 Linear searching is done anyway, for one file, when Vim finds a line
8167 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008168 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169< [The whitespace before and after the '0' must be a single <Tab>]
8170
8171 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008172 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173 instead of a normal tag name, a retry is done with a linear search.
8174 Tags in unsorted tags files, and matches with different case will only
8175 be found in the retry.
8176
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008177 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008178 linear search can be avoided when case is ignored. Use a value of '2'
8179 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8180 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008181 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8182 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8183 used for this as well. Note that case must be folded to uppercase for
8184 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008185
8186 By default, tag searches are case-sensitive. Case is ignored when
8187 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8188 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008189 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8190 'tagcase' is "smart", and the pattern contains only lowercase
8191 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192
8193 When 'tagbsearch' is off, tags searching is slower when a full match
8194 exists, but faster when no full match exists. Tags in unsorted tags
8195 files may only be found with 'tagbsearch' off.
8196 When the tags file is not sorted, or sorted in a wrong way (not on
8197 ASCII byte value), 'tagbsearch' should be off, or the line given above
8198 must be included in the tags file.
8199 This option doesn't affect commands that find all matching tags (e.g.,
8200 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008201
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008202 *'tagcase'* *'tc'*
8203'tagcase' 'tc' string (default "followic")
8204 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008205 This option specifies how case is handled when searching the tags
8206 file:
8207 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008208 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008209 ignore Ignore case
8210 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008211 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008212 NOTE: This option is set to the Vi default value when 'compatible' is
8213 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008214
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008215 *'tagfunc'* *'tfu'*
8216'tagfunc' 'tfu' string (default: empty)
8217 local to buffer
8218 {not available when compiled without the |+eval|
8219 feature}
8220 This option specifies a function to be used to perform tag searches.
8221 The function gets the tag pattern and should return a List of matching
8222 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008223 function and an example. The value can be the name of a function, a
8224 |lambda| or a |Funcref|. See |option-value-function| for more
8225 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008226 This option cannot be set from a |modeline| or in the |sandbox|, for
8227 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008228
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229 *'taglength'* *'tl'*
8230'taglength' 'tl' number (default 0)
8231 global
8232 If non-zero, tags are significant up to this number of characters.
8233
8234 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8235'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8236 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008237 If on and using a tags file in another directory, file names in that
8238 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 NOTE: This option is set to the Vi default value when 'compatible' is
8240 set and to the Vim default value when 'compatible' is reset.
8241
8242 *'tags'* *'tag'* *E433*
8243'tags' 'tag' string (default "./tags,tags", when compiled with
8244 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8245 global or local to buffer |global-local|
8246 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008247 include a space or comma in a file name, precede it with backslashes
8248 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 When a file name starts with "./", the '.' is replaced with the path
8250 of the current file. But only when the 'd' flag is not included in
8251 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8252 |tags-option|.
8253 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008254 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8255 find all files named "tags" below "/lib". The filename itself cannot
8256 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008257 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008258 The |tagfiles()| function can be used to get a list of the file names
8259 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8261 files are also supported. They are automatically recognized. The
8262 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8263 differences are ignored (MS-Windows). |emacs-tags|
8264 The use of |:set+=| and |:set-=| is preferred when adding or removing
8265 file names from the list. This avoids problems when a future version
8266 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008267
8268 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8269'tagstack' 'tgst' boolean (default on)
8270 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 When on, the |tagstack| is used normally. When off, a ":tag" or
8272 ":tselect" command with an argument will not push the tag onto the
8273 tagstack. A following ":tag" without an argument, a ":pop" command or
8274 any other command that uses the tagstack will use the unmodified
8275 tagstack, but does change the pointer to the active entry.
8276 Resetting this option is useful when using a ":tag" command in a
8277 mapping which should not change the tagstack.
8278
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008279 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008280'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008281 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008282 {only available when compiled with the |+tcl/dyn|
8283 feature}
8284 Specifies the name of the Tcl shared library. The default is
8285 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008286 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008287 This option cannot be set from a |modeline| or in the |sandbox|, for
8288 security reasons.
8289
Bram Moolenaar071d4272004-06-13 20:20:40 +00008290 *'term'* *E529* *E530* *E531*
8291'term' string (default is $TERM, if that fails:
8292 in the GUI: "builtin_gui"
8293 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008294 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 on Unix: "ansi"
8297 on VMS: "ansi"
8298 on Win 32: "win32")
8299 global
8300 Name of the terminal. Used for choosing the terminal control
8301 characters. Environment variables are expanded |:set_env|.
8302 For example: >
8303 :set term=$TERM
8304< See |termcap|.
8305
8306 *'termbidi'* *'tbidi'*
8307 *'notermbidi'* *'notbidi'*
8308'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 {only available when compiled with the |+arabic|
8311 feature}
8312 The terminal is in charge of Bi-directionality of text (as specified
8313 by Unicode). The terminal is also expected to do the required shaping
8314 that some languages (such as Arabic) require.
8315 Setting this option implies that 'rightleft' will not be set when
8316 'arabic' is set and the value of 'arabicshape' will be ignored.
8317 Note that setting 'termbidi' has the immediate effect that
8318 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8319 This option is reset when the GUI is started.
8320 For further details see |arabic.txt|.
8321
8322 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008323'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 Encoding used for the terminal. This specifies what character
8326 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008327 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008328 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008329 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008330 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8332 Any attempts to set a different value will be rejected, and an error
8333 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008334 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 because the Win32 system always passes Unicode characters.
8336 When empty, the same encoding is used as for the 'encoding' option.
8337 This is the normal value.
8338 Not all combinations for 'termencoding' and 'encoding' are valid. See
8339 |encoding-table|.
8340 The value for this option must be supported by internal conversions or
8341 iconv(). When this is not possible no conversion will be done and you
8342 will probably experience problems with non-ASCII characters.
8343 Example: You are working with the locale set to euc-jp (Japanese) and
8344 want to edit a UTF-8 file: >
8345 :let &termencoding = &encoding
8346 :set encoding=utf-8
8347< You need to do this when your system has no locale support for UTF-8.
8348
Bram Moolenaar938ae282023-02-20 20:44:55 +00008349 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008350'termguicolors' 'tgc' boolean (default off)
8351 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008352 {not available when compiled without the
8353 |+termguicolors| feature}
8354 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008355 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008356
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008357 Requires a ISO-8613-3 compatible terminal. If setting this option
8358 does not work (produces a colorless UI) reading |xterm-true-color|
8359 might help.
8360
8361 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8362 is required. Use this check to find out: >
8363 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008364< This requires Vim to be built with the |+vtp| feature.
8365
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008366 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008367
8368 When using Vim with Windows Terminal, the background of Windows
8369 Terminal is normally filled with the Vim background color. Setting
8370 'termguicolors' and the guibg of the Normal highlight group to NONE
8371 will make the background transparent: >
8372 :hi Normal guibg=NONE
8373<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008374 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008375
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008376 *'termwinkey'* *'twk'*
8377'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008378 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008379 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008380 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008381 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008382 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008383< The string must be one key stroke but can be multiple bytes.
8384 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008385 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008386 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008387
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008388 *'termwinscroll'* *'twsl'*
8389'termwinscroll' 'twsl' number (default 10000)
8390 local to buffer
8391 {not available when compiled without the
8392 |+terminal| feature}
8393 Number of scrollback lines to keep. When going over this limit the
8394 first 10% of the scrollback lines are deleted. This is just to reduce
8395 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008396 Also used as a limit for text sent to the terminal in one write,
8397 multiplied by the number of columns times 3 (average number of bytes
8398 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008399
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008400 *'termwinsize'* *'tws'*
8401'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008402 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008403 Size used when opening the |terminal| window. Format:
8404 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008405 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008406 - When set with a "x" (e.g., "24x80") the terminal size is not
8407 adjusted to the window size. If the window is smaller only the
8408 top-left part is displayed.
8409 - When set with a "*" (e.g., "10*50") the terminal size follows the
8410 window size, but will not be smaller than the specified rows and/or
8411 columns.
8412 - When rows is zero then use the height of the window.
8413 - When columns is zero then use the width of the window.
8414 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008415 - Can be overruled in the |term_start()| options with "term_rows" and
8416 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008417
8418 Examples:
8419 "30x0" uses 30 rows and the current window width.
8420 "20*0" uses at least 20 rows and the current window width.
8421 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008422 Note that the command running in the terminal window may still change
8423 the size of the terminal. In that case the Vim window will be
8424 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008425
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008426 *'termwintype'* *'twt'*
8427'termwintype' 'twt' string (default "")
8428 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008429 {only available when compiled with the |terminal|
8430 feature on MS-Windows}
8431 Specify the virtual console (pty) used when opening the terminal
8432 window.
8433
8434 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008435 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008436 "winpty" use winpty, fail if not supported
8437 "conpty" use |ConPTY|, fail if not supported
8438
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008439 |ConPTY| support depends on the platform. Windows 10 October 2018
8440 Update is the first version that supports ConPTY, however it is still
8441 considered unstable. ConPTY might become stable in the next release
8442 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008443 supported then you cannot open a terminal window.
8444
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 *'terse'* *'noterse'*
8446'terse' boolean (default off)
8447 global
8448 When set: Add 's' flag to 'shortmess' option (this makes the message
8449 for a search that hits the start or end of the file not being
8450 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8451 shortens a lot of messages}
8452
8453 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8454'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8455 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456 This option is obsolete. Use 'fileformats'.
8457 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8458 set to the default value for the current system. When 'textauto' is
8459 reset, 'fileformats' is made empty.
8460 NOTE: This option is set to the Vi default value when 'compatible' is
8461 set and to the Vim default value when 'compatible' is reset.
8462
8463 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008464'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465 others: default off)
8466 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467 This option is obsolete. Use 'fileformat'.
8468 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8469 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8470 "unix".
8471
8472 *'textwidth'* *'tw'*
8473'textwidth' 'tw' number (default 0)
8474 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475 Maximum width of text that is being inserted. A longer line will be
8476 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008477 this.
8478 'textwidth' is set to 0 when the 'paste' option is set and restored
8479 when 'paste' is reset.
8480 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008482 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 NOTE: This option is set to 0 when 'compatible' is set.
8484
8485 *'thesaurus'* *'tsr'*
8486'thesaurus' 'tsr' string (default "")
8487 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008489 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8490 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008491
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008492 This option is not used if 'thesaurusfunc' is set, either for the
8493 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008494
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008495 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008497 name. See |option-backslash| about using backslashes. The use of
8498 |:set+=| and |:set-=| is preferred when adding or removing directories
8499 from the list. This avoids problems when a future version uses
8500 another default. Backticks cannot be used in this option for security
8501 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008503 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008504'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008505 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008506 {not available when compiled without the |+eval|
8507 feature}
8508 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008509 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008510 The value can be the name of a function, a |lambda| or a |Funcref|.
8511 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008512
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008513 This option cannot be set from a |modeline| or in the |sandbox|, for
8514 security reasons.
8515
Bram Moolenaar071d4272004-06-13 20:20:40 +00008516 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8517'tildeop' 'top' boolean (default off)
8518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 When on: The tilde command "~" behaves like an operator.
8520 NOTE: This option is reset when 'compatible' is set.
8521
8522 *'timeout'* *'to'* *'notimeout'* *'noto'*
8523'timeout' 'to' boolean (default on)
8524 global
8525 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008526'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008528 These two options together determine the behavior when part of a
8529 mapped key sequence or keyboard code has been received:
8530
8531 'timeout' 'ttimeout' action ~
8532 off off do not time out
8533 on on or off time out on :mappings and key codes
8534 off on time out on key codes
8535
8536 If both options are off, Vim will wait until either the complete
8537 mapping or key sequence has been received, or it is clear that there
8538 is no mapping or key sequence for the received characters. For
8539 example: if you have mapped "vl" and Vim has received 'v', the next
8540 character is needed to see if the 'v' is followed by an 'l'.
8541 When one of the options is on, Vim will wait for about 1 second for
8542 the next character to arrive. After that the already received
8543 characters are interpreted as single characters. The waiting time can
8544 be changed with the 'timeoutlen' option.
8545 On slow terminals or very busy systems timing out may cause
8546 malfunctioning cursor keys. If both options are off, Vim waits
8547 forever after an entered <Esc> if there are key codes that start
8548 with <Esc>. You will have to type <Esc> twice. If you do not have
8549 problems with key codes, but would like to have :mapped key
8550 sequences not timing out in 1 second, set the 'ttimeout' option and
8551 reset the 'timeout' option.
8552
8553 NOTE: 'ttimeout' is reset when 'compatible' is set.
8554
8555 *'timeoutlen'* *'tm'*
8556'timeoutlen' 'tm' number (default 1000)
8557 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008558
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008560'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 The time in milliseconds that is waited for a key code or mapped key
8563 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8564 when part of a command has been typed.
8565 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8566 different timeout value for key codes is desired set 'ttimeoutlen' to
8567 a non-negative number.
8568
8569 ttimeoutlen mapping delay key code delay ~
8570 < 0 'timeoutlen' 'timeoutlen'
8571 >= 0 'timeoutlen' 'ttimeoutlen'
8572
8573 The timeout only happens when the 'timeout' and 'ttimeout' options
8574 tell so. A useful setting would be >
8575 :set timeout timeoutlen=3000 ttimeoutlen=100
8576< (time out on mapping after three seconds, time out on key codes after
8577 a tenth of a second).
8578
8579 *'title'* *'notitle'*
8580'title' boolean (default off, on when title can be restored)
8581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 When on, the title of the window will be set to the value of
8583 'titlestring' (if it is not empty), or to:
8584 filename [+=-] (path) - VIM
8585 Where:
8586 filename the name of the file being edited
8587 - indicates the file cannot be modified, 'ma' off
8588 + indicates the file was modified
8589 = indicates the file is read-only
8590 =+ indicates the file is read-only and modified
8591 (path) is the path of the file being edited
8592 - VIM the server name |v:servername| or "VIM"
8593 Only works if the terminal supports setting window titles
8594 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008595 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8597 *X11*
8598 When Vim was compiled with HAVE_X11 defined, the original title will
8599 be restored if possible. The output of ":version" will include "+X11"
8600 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8601 works for the icon name |'icon'|.
8602 But: When Vim was started with the |-X| argument, restoring the title
8603 will not work (except in the GUI).
8604 If the title cannot be restored, it is set to the value of 'titleold'.
8605 You might want to restore the title outside of Vim then.
8606 When using an xterm from a remote machine you can use this command:
8607 rsh machine_name xterm -display $DISPLAY &
8608 then the WINDOWID environment variable should be inherited and the
8609 title of the window should change back to what it should be after
8610 exiting Vim.
8611
8612 *'titlelen'*
8613'titlelen' number (default 85)
8614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008616 title. When the title is longer, only the end of the path name is
8617 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 Using a percentage makes this adapt to the width of the window. But
8619 it won't work perfectly, because the actual number of characters
8620 available also depends on the font used and other things in the title
8621 bar. When 'titlelen' is zero the full path is used. Otherwise,
8622 values from 1 to 30000 percent can be used.
8623 'titlelen' is also used for the 'titlestring' option.
8624
8625 *'titleold'*
8626'titleold' string (default "Thanks for flying Vim")
8627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 This option will be used for the window title when exiting Vim if the
8629 original title cannot be restored. Only happens if 'title' is on or
8630 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008631 This option cannot be set from a |modeline| or in the |sandbox|, for
8632 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633 *'titlestring'*
8634'titlestring' string (default "")
8635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 When this option is not empty, it will be used for the title of the
8637 window. This happens only when the 'title' option is on.
8638 Only works if the terminal supports setting window titles (currently
8639 Amiga console, Win32 console, all GUI versions and terminals with a
8640 non-empty 't_ts' option).
8641 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008642 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008643
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 When this option contains printf-style '%' items, they will be
8645 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008646 This option cannot be set in a modeline when 'modelineexpr' is off.
8647
Bram Moolenaar071d4272004-06-13 20:20:40 +00008648 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008649 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008650 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8651< The value of 'titlelen' is used to align items in the middle or right
8652 of the available space.
8653 Some people prefer to have the file name first: >
8654 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8655< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008656 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 separating space only when needed.
8658 NOTE: Use of special characters in 'titlestring' may cause the display
8659 to be garbled (e.g., when it contains a CR or NL character).
8660 {not available when compiled without the |+statusline| feature}
8661
8662 *'toolbar'* *'tb'*
8663'toolbar' 'tb' string (default "icons,tooltips")
8664 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008665 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008666 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 possible values are:
8668 icons Toolbar buttons are shown with icons.
8669 text Toolbar buttons shown with text.
8670 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008671 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 tooltips Tooltips are active for toolbar buttons.
8673 Tooltips refer to the popup help text which appears after the mouse
8674 cursor is placed over a toolbar button for a brief moment.
8675
8676 If you want the toolbar to be shown with icons as well as text, do the
8677 following: >
8678 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008679< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008680 will show icons if both are requested.
8681
8682 If none of the strings specified in 'toolbar' are valid or if
8683 'toolbar' is empty, this option is ignored. If you want to disable
8684 the toolbar, you need to set the 'guioptions' option. For example: >
8685 :set guioptions-=T
8686< Also see |gui-toolbar|.
8687
8688 *'toolbariconsize'* *'tbis'*
8689'toolbariconsize' 'tbis' string (default "small")
8690 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008691 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008693 tiny Use tiny icons.
8694 small Use small icons (default).
8695 medium Use medium-sized icons.
8696 large Use large icons.
8697 huge Use even larger icons.
8698 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008700 the current theme. Common dimensions are giant=48x48, huge=32x32,
8701 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008702
8703 If 'toolbariconsize' is empty, the global default size as determined
8704 by user preferences or the current theme is used.
8705
8706 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8707'ttybuiltin' 'tbi' boolean (default on)
8708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 When on, the builtin termcaps are searched before the external ones.
8710 When off the builtin termcaps are searched after the external ones.
8711 When this option is changed, you should set the 'term' option next for
8712 the change to take effect, for example: >
8713 :set notbi term=$TERM
8714< See also |termcap|.
8715 Rationale: The default for this option is "on", because the builtin
8716 termcap entries are generally better (many systems contain faulty
8717 xterm entries...).
8718
8719 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008720'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 Indicates a fast terminal connection. More characters will be sent to
8723 the screen for redrawing, instead of using insert/delete line
8724 commands. Improves smoothness of redrawing when there are multiple
8725 windows and the terminal does not support a scrolling region.
8726 Also enables the extra writing of characters at the end of each screen
8727 line for lines that wrap. This helps when using copy/paste with the
8728 mouse in an xterm and other terminals.
8729
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008730 The default used to be set only for some terminal names, but these
8731 days nearly all terminals are fast, therefore the default is now "on".
8732 If you have a slow connection you may want to set this option off,
8733 e.g. depending on the host name: >
8734 if hostname() =~ 'faraway'
8735 set nottyfast
8736 endif
8737<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 *'ttymouse'* *'ttym'*
8739'ttymouse' 'ttym' string (default depends on 'term')
8740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 {only in Unix and VMS, doesn't work in the GUI; not
8742 available when compiled without |+mouse|}
8743 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008744 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 *xterm-mouse*
8746 xterm xterm-like mouse handling. The mouse generates
8747 "<Esc>[Mscr", where "scr" is three bytes:
8748 "s" = button state
8749 "c" = column plus 33
8750 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008751 This only works up to 223 columns! See "dec",
8752 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 xterm2 Works like "xterm", but with the xterm reporting the
8754 mouse position while the mouse is dragged. This works
8755 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008756 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 work. See below for how Vim detects this
8758 automatically.
8759 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008760 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008762 for the row and column. No other mouse events are
8763 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 *dec-mouse*
8765 dec DEC terminal mouse handling. The mouse generates a
8766 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008767 This is also available for an Xterm, if it was
8768 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 *jsbterm-mouse*
8770 jsbterm JSB term mouse handling.
8771 *pterm-mouse*
8772 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008773 *urxvt-mouse*
8774 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008775 The mouse works only if the terminal supports this
8776 encoding style, but it does not have 223 columns limit
8777 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008778 *sgr-mouse*
8779 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008780 mouse reporting. The mouse works even in columns
8781 beyond 223. This option is backward compatible with
8782 "xterm2" because it can also decode "xterm2" style
8783 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784
8785 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008786 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8787 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8789 recognized, if enabled at compile time. DEC terminal mouse codes
8790 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008791 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8792 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008794 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8795 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8796 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008797 If the terminfo/termcap entry "XM" exists and the first number is
8798 "1006" then 'ttymouse' will be set to "sgr". This works for many
8799 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008800 Additionally, if vim is compiled with the |+termresponse| feature and
8801 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008802 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008804 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8805 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8806 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008807 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8808 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008809 :set t_RV=
8810<
8811 *'ttyscroll'* *'tsl'*
8812'ttyscroll' 'tsl' number (default 999)
8813 global
8814 Maximum number of lines to scroll the screen. If there are more lines
8815 to scroll the window is redrawn. For terminals where scrolling is
8816 very slow and redrawing is not slow this can be set to a small number,
8817 e.g., 3, to speed up displaying.
8818
8819 *'ttytype'* *'tty'*
8820'ttytype' 'tty' string (default from $TERM)
8821 global
8822 Alias for 'term', see above.
8823
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008824 *'undodir'* *'udir'*
8825'undodir' 'udir' string (default ".")
8826 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008827 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008828 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008829 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008830 "." means using the directory of the file. The undo file name for
8831 "file.txt" is ".file.txt.un~".
8832 For other directories the file name is the full path of the edited
8833 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008834 When writing: The first directory that exists is used. "." always
8835 works, no directories after "." will be used for writing.
8836 When reading all entries are tried to find an undo file. The first
8837 undo file that exists is used. When it cannot be read an error is
8838 given, no further entry is used.
8839 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008840 This option cannot be set from a |modeline| or in the |sandbox|, for
8841 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008842
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008843 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008844'undofile' 'udf' boolean (default off)
8845 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008846 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008847 When on, Vim automatically saves undo history to an undo file when
8848 writing a buffer to a file, and restores undo history from the same
8849 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008850 The directory where the undo file is stored is specified by 'undodir'.
8851 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008852 The undo file is not read when 'undoreload' causes the buffer from
8853 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008854 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008855 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008856
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008858'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008859 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008860 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008861 is kept in memory, higher numbers will cause more memory to be used.
8862 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8864 itself: >
8865 set ul=0
8866< But you can also get Vi compatibility by including the 'u' flag in
8867 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008868 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008869 Set to -1 for no undo at all. You might want to do this only for the
8870 current buffer: >
8871 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008873
8874 The local value is set to -123456 when the global value is to be used.
8875
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008876 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008878 *'undoreload'* *'ur'*
8879'undoreload' 'ur' number (default 10000)
8880 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008881 Save the whole buffer for undo when reloading it. This applies to the
8882 ":e!" command and reloading for when the buffer changed outside of
8883 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008884 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008885 of lines is smaller than the value of this option.
8886 Set this option to zero to disable undo for a reload.
8887
8888 When saving undo for a reload, any undo file is not read.
8889
8890 Note that this causes the whole buffer to be stored in memory. Set
8891 this option to a lower value if you run out of memory.
8892
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893 *'updatecount'* *'uc'*
8894'updatecount' 'uc' number (default: 200)
8895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896 After typing this many characters the swap file will be written to
8897 disk. When zero, no swap file will be created at all (see chapter on
8898 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8899 Vim with the "-n" option, see |startup|. When editing in readonly
8900 mode this option will be initialized to 10000.
8901 The swapfile can be disabled per buffer with |'swapfile'|.
8902 When 'updatecount' is set from zero to non-zero, swap files are
8903 created for all buffers that have 'swapfile' set. When 'updatecount'
8904 is set to zero, existing swap files are not deleted.
8905 Also see |'swapsync'|.
8906 This option has no meaning in buffers where |'buftype'| is "nofile"
8907 or "nowrite".
8908
8909 *'updatetime'* *'ut'*
8910'updatetime' 'ut' number (default 4000)
8911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008912 If this many milliseconds nothing is typed the swap file will be
8913 written to disk (see |crash-recovery|). Also used for the
8914 |CursorHold| autocommand event.
8915
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008916 *'varsofttabstop'* *'vsts'*
8917'varsofttabstop' 'vsts' string (default "")
8918 local to buffer
8919 {only available when compiled with the |+vartabs|
8920 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008921 A list of the number of spaces that a <Tab> counts for while editing,
8922 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8923 width <Tab>s are being inserted, while in fact a mixture of spaces
8924 and <Tab>s is used. Tab widths are separated with commas, with the
8925 final value applying to all subsequent tabs.
8926
8927 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008928 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008929 to use the following: >
8930 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008931< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8932 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008933
8934 Note that the value of |'softtabstop'| will be ignored while
8935 'varsofttabstop' is set.
8936
8937 *'vartabstop'* *'vts'*
8938'vartabstop' 'vts' string (default "")
8939 local to buffer
8940 {only available when compiled with the |+vartabs|
8941 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008942 A list of the number of spaces that a <Tab> in the file counts for,
8943 separated by commas. Each value corresponds to one tab, with the
8944 final value applying to all subsequent tabs. For example: >
8945 :set vartabstop=4,20,10,8
8946< This will make the first tab 4 spaces wide, the second 20 spaces,
8947 the third 10 spaces, and all following tabs 8 spaces.
8948
8949 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8950 is set.
8951
Bram Moolenaar071d4272004-06-13 20:20:40 +00008952 *'verbose'* *'vbs'*
8953'verbose' 'vbs' number (default 0)
8954 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955 When bigger than zero, Vim will give messages about what it is doing.
8956 Currently, these messages are given:
8957 >= 1 When the viminfo file is read or written.
8958 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008959 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008960 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 >= 8 Files for which a group of autocommands is executed.
8962 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008963 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 >= 12 Every executed function.
8965 >= 13 When an exception is thrown, caught, finished, or discarded.
8966 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008967 >= 15 Every executed Ex command from a script (truncated at 200
8968 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008969 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008970
8971 This option can also be set with the "-V" argument. See |-V|.
8972 This option is also set by the |:verbose| command.
8973
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008974 When the 'verbosefile' option is set then the verbose messages are not
8975 displayed.
8976
8977 *'verbosefile'* *'vfile'*
8978'verbosefile' 'vfile' string (default empty)
8979 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008980 When not empty all messages are written in a file with this name.
8981 When the file exists messages are appended.
8982 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008983 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008984 Setting 'verbosefile' to a new value is like making it empty first.
8985 The difference with |:redir| is that verbose messages are not
8986 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11008987 This option cannot be set from a |modeline| or in the |sandbox|, for
8988 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008989
Bram Moolenaar071d4272004-06-13 20:20:40 +00008990 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09008991'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008992 for Win32: "$HOME/vimfiles/view",
Christian Brabandtb8b1c8e2023-06-23 22:23:01 +01008993 for Unix: "$HOME/.vim/view",
h_east59858792023-10-25 22:47:05 +09008994 for macOS: "$VIM/vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008995 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008996 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008997 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008998 feature}
8999 Name of the directory where to store files for |:mkview|.
9000 This option cannot be set from a |modeline| or in the |sandbox|, for
9001 security reasons.
9002
9003 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009004'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009006 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009008 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009009 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010 word save and restore ~
9011 cursor cursor position in file and in window
9012 folds manually created folds, opened/closed folds and local
9013 fold options
9014 options options and mappings local to a window or buffer (not
9015 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009016 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 slash backslashes in file names replaced with forward
9018 slashes
9019 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009020 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009021 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009023 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009025 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026
9027 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009028'viminfo' 'vi' string (Vi default: "", Vim default for
9029 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009030 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9031 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009033 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009034 feature}
9035 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009036 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9037 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009038 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009039 consisting of a single character identifying the particular parameter,
9040 followed by a number or string which specifies the value of that
9041 parameter. If a particular character is left out, then the default
9042 value is used for that parameter. The following is a list of the
9043 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009044 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009045 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009046 ! When included, save and restore global variables that start
9047 with an uppercase letter, and don't contain a lowercase
9048 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009049 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009050 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009051 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 " Maximum number of lines saved for each register. Old name of
9053 the '<' item, with the disadvantage that you need to put a
9054 backslash before the ", otherwise it will be recognized as the
9055 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009056 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009057 % When included, save and restore the buffer list. If Vim is
9058 started with a file name argument, the buffer list is not
9059 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009060 buffer list is restored from the viminfo file. Quickfix
9061 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9062 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009063 When followed by a number, the number specifies the maximum
9064 number of buffers that are stored. Without a number all
9065 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009066 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009067 ' Maximum number of previously edited files for which the marks
9068 are remembered. This parameter must always be included when
9069 'viminfo' is non-empty.
9070 Including this item also means that the |jumplist| and the
9071 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009072 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009073 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009074 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 patterns are also saved. When not included, the value of
9076 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009077 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009078 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009079 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009080 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009081 < Maximum number of lines saved for each register. If zero then
9082 registers are not saved. When not included, all lines are
9083 saved. '"' is the old name for this item.
9084 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009085 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009087 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009088 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089 c When included, convert the text in the viminfo file from the
9090 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009091 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009092 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009093 f Whether file marks need to be stored. If zero, file marks ('0
9094 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009095 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009096 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009097 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009098 h Disable the effect of 'hlsearch' when loading the viminfo
9099 file. When not included, it depends on whether ":nohlsearch"
9100 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009101 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009102 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009103 the 'n'. Must be at the end of the option! If the
9104 'viminfofile' option is set, that file name overrides the one
9105 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009106 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009107 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 r Removable media. The argument is a string (up to the next
9109 ','). This parameter can be given several times. Each
9110 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009111 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9113 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9114 ignored. Maximum length of each 'r' argument is 50
9115 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009116 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009117 s Maximum size of an item in Kbyte. If zero then registers are
9118 not saved. Currently only applies to registers. The default
9119 "s10" will exclude registers with more than 10 Kbyte of text.
9120 Also see the '<' item above: line count limit.
9121
9122 Example: >
9123 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9124<
9125 '50 Marks will be remembered for the last 50 files you
9126 edited.
9127 <1000 Contents of registers (up to 1000 lines each) will be
9128 remembered.
9129 s100 Registers with more than 100 Kbyte text are skipped.
9130 :0 Command-line history will not be saved.
9131 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9132 no / Since '/' is not specified, the default will be used,
9133 that is, save all of the search history, and also the
9134 previous search and substitute patterns.
9135 no % The buffer list will not be saved nor read back.
9136 no h 'hlsearch' highlighting will be restored.
9137
9138 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9139 load the contents of the file, this is not done automatically.
9140
9141 This option cannot be set from a |modeline| or in the |sandbox|, for
9142 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009143 NOTE: This option is set to the Vim default value when 'compatible'
9144 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009145
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009146 *'viminfofile'* *'vif'*
9147'viminfofile' 'vif' string (default: "")
9148 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009149 {not available when compiled without the |+viminfo|
9150 feature}
9151 When non-empty, overrides the file name used for viminfo.
9152 When equal to "NONE" no viminfo file will be read or written.
9153 This option can be set with the |-i| command line flag. The |--clean|
9154 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009155 This option cannot be set from a |modeline| or in the |sandbox|, for
9156 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009157
Bram Moolenaar071d4272004-06-13 20:20:40 +00009158 *'virtualedit'* *'ve'*
9159'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009160 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009161 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009162 block Allow virtual editing in Visual block mode.
9163 insert Allow virtual editing in Insert mode.
9164 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009165 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009166 none When used as the local value, do not allow virtual
9167 editing even when the global value is set. When used
9168 as the global value, "none" is the same as "".
9169 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009170
Bram Moolenaar071d4272004-06-13 20:20:40 +00009171 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009172 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 of the line. Useful for selecting a rectangle in Visual mode and
9174 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009175 "onemore" is not the same, it will only allow moving the cursor just
9176 after the last character of the line. This makes some commands more
9177 consistent. Previously the cursor was always past the end of the line
9178 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009179 break some plugins or Vim scripts. For example because |l| can move
9180 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009181 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009182 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009183 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009184 It doesn't make sense to combine "all" with "onemore", but you will
9185 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009186 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009187 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009188
9189 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9190'visualbell' 'vb' boolean (default off)
9191 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009192 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009193 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009194 use: >
9195 :set vb t_vb=
9196< If you want a short flash, you can use this on many terminals: >
9197 :set vb t_vb=[?5h$<100>[?5l
9198< Here $<100> specifies the time, you can use a smaller or bigger value
9199 to get a shorter or longer flash.
9200
9201 Note: Vim will limit the bell to once per half a second. This avoids
9202 having to wait for the flashing to finish when there are lots of
9203 bells, e.g. on key repeat. This also happens without 'visualbell'
9204 set.
9205
Bram Moolenaar071d4272004-06-13 20:20:40 +00009206 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9207 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9208 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009209
9210 Note: When the GUI starts, 't_vb' is reset to its default value. You
9211 might want to set it again in your |gvimrc|.
9212
Bram Moolenaar071d4272004-06-13 20:20:40 +00009213 Does not work on the Amiga, you always get a screen flash.
9214 Also see 'errorbells'.
9215
9216 *'warn'* *'nowarn'*
9217'warn' boolean (default on)
9218 global
9219 Give a warning message when a shell command is used while the buffer
9220 has been changed.
9221
9222 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9223'weirdinvert' 'wiv' boolean (default off)
9224 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009225 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009226 It is provided for backwards compatibility with version 4.x.
9227 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9228 vice versa. Has no effect when the GUI is running.
9229
9230 *'whichwrap'* *'ww'*
9231'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009233 Allow specified keys that move the cursor left/right to move to the
9234 previous/next line when the cursor is on the first/last character in
9235 the line. Concatenate characters to allow this for these keys:
9236 char key mode ~
9237 b <BS> Normal and Visual
9238 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009239 h "h" Normal and Visual (not recommended)
9240 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009241 < <Left> Normal and Visual
9242 > <Right> Normal and Visual
9243 ~ "~" Normal
9244 [ <Left> Insert and Replace
9245 ] <Right> Insert and Replace
9246 For example: >
9247 :set ww=<,>,[,]
9248< allows wrap only when cursor keys are used.
9249 When the movement keys are used in combination with a delete or change
9250 operator, the <EOL> also counts for a character. This makes "3h"
9251 different from "3dh" when the cursor crosses the end of a line. This
9252 is also true for "x" and "X", because they do the same as "dl" and
9253 "dh". If you use this, you may also want to use the mapping
9254 ":map <BS> X" to make backspace delete the character in front of the
9255 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009256 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009257 line (not an empty line) then it will not move to the next line. This
9258 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009259 NOTE: This option is set to the Vi default value when 'compatible' is
9260 set and to the Vim default value when 'compatible' is reset.
9261
9262 *'wildchar'* *'wc'*
9263'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009265 Character you have to type to start wildcard expansion in the
9266 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009267 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009268 The character is not recognized when used inside a macro. See
9269 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009270 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009271 <Esc> can be used, but hitting it twice in a row will still exit
9272 command-line as a failsafe measure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009273 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009274 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009275< NOTE: This option is set to the Vi default value when 'compatible' is
9276 set and to the Vim default value when 'compatible' is reset.
9277
9278 *'wildcharm'* *'wcm'*
9279'wildcharm' 'wcm' number (default: none (0))
9280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009282 recognized when used inside a macro. You can find "spare" command-line
9283 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009284 you'll never actually type 'wildcharm', just use it in mappings that
9285 automatically invoke completion mode, e.g.: >
9286 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009287 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009288< Then after typing :ss you can use CTRL-P & CTRL-N.
9289
9290 *'wildignore'* *'wig'*
9291'wildignore' 'wig' string (default "")
9292 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009293 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009294 patterns is ignored when expanding |wildcards|, completing file or
9295 directory names, and influences the result of |expand()|, |glob()| and
9296 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009297 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9298 Also see 'suffixes'.
9299 Example: >
9300 :set wildignore=*.o,*.obj
9301< The use of |:set+=| and |:set-=| is preferred when adding or removing
9302 a pattern from the list. This avoids problems when a future version
9303 uses another default.
9304
Bram Moolenaar94950a92010-12-02 16:01:29 +01009305
Bram Moolenaar81af9252010-12-10 20:35:50 +01009306 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009307'wildignorecase' 'wic' boolean (default off)
9308 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009309 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009310 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009311 Does not apply when the shell is used to expand wildcards, which
9312 happens when there are special characters.
9313
9314
Bram Moolenaar071d4272004-06-13 20:20:40 +00009315 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009316'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009318 When 'wildmenu' is on, command-line completion operates in an enhanced
9319 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009320 the possible matches are shown.
9321 When 'wildoptions' contains "pum", then the completion matches are
9322 shown in a popup menu. Otherwise they are displayed just above the
9323 command line, with the first match highlighted (overwriting the status
9324 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009325 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9327 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9328 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009329 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009330 If there are more matches than can fit in the line, a ">" is shown on
9331 the right and/or a "<" is shown on the left. The status line scrolls
9332 as needed.
9333 The "wildmenu" mode is abandoned when a key is hit that is not used
9334 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009335 While the "wildmenu" is active, the following keys have special
9336 meanings:
9337 CTRL-P - go to the previous entry
9338 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009339 <CR> - in menu completion, when the cursor is just after a
9340 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009341 CTRL-E - end completion, go back to what was there before
9342 selecting a match.
9343 CTRL-Y - accept the currently selected match and stop
9344 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009345
9346 When not using the popup menu for command line completion, the
9347 following keys have special meanings:
9348 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009349 <Up> - in filename/menu name completion: move up into
9350 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009351 <Down> - in filename/menu name completion: move into a
9352 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009353
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009354 When using the popup menu for command line completion, the following
9355 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009356 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009357 <PageUp> - select a match several entries back
9358 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009359 <Left> - in filename/menu name completion: move up into
9360 parent directory or parent menu.
9361 <Right> - in filename/menu name completion: move into a
9362 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009363
Bram Moolenaar071d4272004-06-13 20:20:40 +00009364 This makes the menus accessible from the console |console-menus|.
9365
9366 If you prefer the <Left> and <Right> keys to move the cursor instead
9367 of selecting a different match, use this: >
9368 :cnoremap <Left> <Space><BS><Left>
9369 :cnoremap <Right> <Space><BS><Right>
9370<
9371 The "WildMenu" highlighting is used for displaying the current match
9372 |hl-WildMenu|.
9373
9374 *'wildmode'* *'wim'*
9375'wildmode' 'wim' string (Vim default: "full")
9376 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009377 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009378 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009379 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009380 first part specifies the behavior for the first use of 'wildchar',
9381 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009382
9383 Each part consists of a colon separated list consisting of the
9384 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009385 "" Complete only the first match.
9386 "full" Complete the next full match. After the last match,
9387 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009388 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009389 "longest" Complete till longest common string. If this doesn't
9390 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009391 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009392 "lastused" When completing buffer names and more than one buffer
9393 matches, sort buffers by time last used (other than
9394 the current buffer).
9395 When there is only a single match, it is fully completed in all cases.
9396
9397 Examples of useful colon-separated values:
9398 "longest:full" Like "longest", but also start 'wildmenu' if it is
9399 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009400 "list:full" When more than one match, list all matches and
9401 complete first match.
9402 "list:longest" When more than one match, list all matches and
9403 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009404 "list:lastused" When more than one buffer matches, list all matches
9405 and sort buffers by time last used (other than the
9406 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009407
9408 Examples: >
9409 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009410< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009411 :set wildmode=longest,full
9412< Complete longest common string, then each full match >
9413 :set wildmode=list:full
9414< List all matches and complete each full match >
9415 :set wildmode=list,full
9416< List all matches without completing, then each full match >
9417 :set wildmode=longest,list
9418< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009419 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009420
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009421 *'wildoptions'* *'wop'*
9422'wildoptions' 'wop' string (default "")
9423 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009424 A list of words that change how |cmdline-completion| is done.
9425 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009426 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009427 this value is specified, wildcard expansion will not
9428 be used for completion. The matches will be sorted by
9429 the "best match" rather than alphabetically sorted.
9430 This will find more matches than the wildcard
9431 expansion. Currently fuzzy matching based completion
9432 is not supported for file and directory names and
9433 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009434 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009435 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009436 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009437 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009438 is displayed per line. Often used tag kinds are:
9439 d #define
9440 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009441
Bram Moolenaar071d4272004-06-13 20:20:40 +00009442 *'winaltkeys'* *'wak'*
9443'winaltkeys' 'wak' string (default "menu")
9444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009445 {only used in Win32, Motif, GTK and Photon GUI}
9446 Some GUI versions allow the access to menu entries by using the ALT
9447 key in combination with a character that appears underlined in the
9448 menu. This conflicts with the use of the ALT key for mappings and
9449 entering special characters. This option tells what to do:
9450 no Don't use ALT keys for menus. ALT key combinations can be
9451 mapped, but there is no automatic handling. This can then be
9452 done with the |:simalt| command.
9453 yes ALT key handling is done by the windowing system. ALT key
9454 combinations cannot be mapped.
9455 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009456 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457 keys can be mapped.
9458 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9459 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009460 This option is not used for <F10>; on Win32 and with GTK <F10> will
9461 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009462
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009463 *'wincolor'* *'wcr'*
9464'wincolor' 'wcr' string (default empty)
9465 local to window
9466 Highlight group name to use for this window instead of the Normal
9467 color |hl-Normal|.
9468
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009469 *'window'* *'wi'*
9470'window' 'wi' number (default screen height - 1)
9471 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009472 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9473 window and the value is smaller than 'lines' minus one. The screen
9474 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009475 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9476 in a much smarter way, taking care of wrapping lines.
9477 When resizing the Vim window, the value is smaller than 1 or more than
9478 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009479 Note: Do not confuse this with the height of the Vim window, use
9480 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009481
Bram Moolenaar071d4272004-06-13 20:20:40 +00009482 *'winheight'* *'wh'* *E591*
9483'winheight' 'wh' number (default 1)
9484 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009485 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009486 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009487 focus goes to a window that is smaller, its size is increased, at the
9488 cost of the height of other windows.
9489 Set 'winheight' to a small number for normal editing.
9490 Set it to 999 to make the current window fill most of the screen.
9491 Other windows will be only 'winminheight' high. This has the drawback
9492 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9493 to create only two windows, set the option after startup is done,
9494 using the |VimEnter| event: >
9495 au VimEnter * set winheight=999
9496< Minimum value is 1.
9497 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009498 height of the current window.
9499 'winheight' applies to the current window. Use 'winminheight' to set
9500 the minimal height for other windows.
9501
9502 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9503'winfixheight' 'wfh' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02009504 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009505 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009506 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9507 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009508 The height may be changed anyway when running out of room.
9509
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009510 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9511'winfixwidth' 'wfw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02009512 local to window |local-noglobal|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009513 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009514 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009515 The width may be changed anyway when running out of room.
9516
Bram Moolenaar071d4272004-06-13 20:20:40 +00009517 *'winminheight'* *'wmh'*
9518'winminheight' 'wmh' number (default 1)
9519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009520 The minimal height of a window, when it's not the current window.
9521 This is a hard minimum, windows will never become smaller.
9522 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9523 status bar) if necessary. They will return to at least one line when
9524 they become active (since the cursor has to have somewhere to go.)
9525 Use 'winheight' to set the minimal height of the current window.
9526 This option is only checked when making a window smaller. Don't use a
9527 large number, it will cause errors when opening more than a few
9528 windows. A value of 0 to 3 is reasonable.
9529
9530 *'winminwidth'* *'wmw'*
9531'winminwidth' 'wmw' number (default 1)
9532 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009533 The minimal width of a window, when it's not the current window.
9534 This is a hard minimum, windows will never become smaller.
9535 When set to zero, windows may be "squashed" to zero columns (i.e. just
9536 a vertical separator) if necessary. They will return to at least one
9537 line when they become active (since the cursor has to have somewhere
9538 to go.)
9539 Use 'winwidth' to set the minimal width of the current window.
9540 This option is only checked when making a window smaller. Don't use a
9541 large number, it will cause errors when opening more than a few
9542 windows. A value of 0 to 12 is reasonable.
9543
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009544 *'winptydll'*
9545'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9546 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009547 {only available when compiled with the |terminal|
9548 feature on MS-Windows}
9549 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009550 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009551 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009552 a fallback.
9553 Environment variables are expanded |:set_env|.
9554 This option cannot be set from a |modeline| or in the |sandbox|, for
9555 security reasons.
9556
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 *'winwidth'* *'wiw'* *E592*
9558'winwidth' 'wiw' number (default 20)
9559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009560 Minimal number of columns for the current window. This is not a hard
9561 minimum, Vim will use fewer columns if there is not enough room. If
9562 the current window is smaller, its size is increased, at the cost of
9563 the width of other windows. Set it to 999 to make the current window
9564 always fill the screen. Set it to a small number for normal editing.
9565 The width is not adjusted after one of the commands to change the
9566 width of the current window.
9567 'winwidth' applies to the current window. Use 'winminwidth' to set
9568 the minimal width for other windows.
9569
9570 *'wrap'* *'nowrap'*
9571'wrap' boolean (default on)
9572 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009573 This option changes how text is displayed. It doesn't change the text
9574 in the buffer, see 'textwidth' for that.
9575 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009576 displaying continues on the next line. When off lines will not wrap
9577 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009578 moved to a part that is not shown, the screen will scroll
9579 horizontally.
9580 The line will be broken in the middle of a word if necessary. See
9581 'linebreak' to get the break at a word boundary.
9582 To make scrolling horizontally a bit more useful, try this: >
9583 :set sidescroll=5
9584 :set listchars+=precedes:<,extends:>
9585< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009586 This option can't be set from a |modeline| when the 'diff' option is
9587 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009588
9589 *'wrapmargin'* *'wm'*
9590'wrapmargin' 'wm' number (default 0)
9591 local to buffer
9592 Number of characters from the right window border where wrapping
9593 starts. When typing text beyond this limit, an <EOL> will be inserted
9594 and inserting continues on the next line.
9595 Options that add a margin, such as 'number' and 'foldcolumn', cause
9596 the text width to be further reduced. This is Vi compatible.
9597 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009598 This option is set to 0 when 'paste' is set and restored when 'paste'
9599 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009600 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009601
9602 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9603'wrapscan' 'ws' boolean (default on) *E384* *E385*
9604 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009605 Searches wrap around the end of the file. Also applies to |]s| and
9606 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009607
9608 *'write'* *'nowrite'*
9609'write' boolean (default on)
9610 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009611 Allows writing files. When not set, writing a file is not allowed.
9612 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009613 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009614 argument. Filtering text is still possible, even though this requires
9615 writing a temporary file.
9616
9617 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9618'writeany' 'wa' boolean (default off)
9619 global
9620 Allows writing to any file with no need for "!" override.
9621
9622 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9623'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9624 otherwise)
9625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009626 Make a backup before overwriting a file. The backup is removed after
9627 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009628 also on.
9629 WARNING: Switching this option off means that when Vim fails to write
9630 your buffer correctly and then, for whatever reason, Vim exits, you
9631 lose both the original file and what you were writing. Only reset
9632 this option if your file system is almost full and it makes the write
9633 fail (and make sure not to exit Vim until the write was successful).
9634 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009635 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009636 Depending on 'backupcopy' the backup is a new file or the original
9637 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009638 NOTE: This option is set to the default value when 'compatible' is
9639 set.
9640
9641 *'writedelay'* *'wd'*
9642'writedelay' 'wd' number (default 0)
9643 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009644 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009645 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009646 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009647
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009648 *'xtermcodes'* *'noxtermcodes'*
9649'xtermcodes' boolean (default on)
9650 global
9651 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009652 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009653 key codes and number of colors from the terminal. This takes care of
9654 various configuration options of the terminal that cannot be obtained
9655 from the termlib/terminfo entry, see |xterm-codes|.
9656 A side effect may be that t_Co changes and Vim will redraw the
9657 display.
9658
9659
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009660 vim:tw=78:ts=8:noet:ft=help:norl: