blob: cfef59de60c7d660a9fa6e777a807556703d0293 [file] [log] [blame]
Christian Brabandt596ad662023-08-16 00:11:09 +02001*options.txt* For Vim version 9.0. Last change: 2023 Aug 15
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
Yee Cheng Chin900894b2023-09-29 20:42:32 +020074 *: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.
1607 NOTE: This option is reset when 'compatible' is set.
1608
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 *'cdpath'* *'cd'* *E344* *E346*
1610'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001613 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1614 searched for has a relative path, not an absolute part starting with
1615 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 The 'cdpath' option's value has the same form and semantics as
1617 |'path'|. Also see |file-searching|.
1618 The default value is taken from $CDPATH, with a "," prepended to look
1619 in the current directory first.
1620 If the default value taken from $CDPATH is not what you want, include
1621 a modified version of the following command in your vimrc file to
1622 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001623 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624< This option cannot be set from a |modeline| or in the |sandbox|, for
1625 security reasons.
1626 (parts of 'cdpath' can be passed to the shell to expand file names).
1627
1628 *'cedit'*
1629'cedit' string (Vi default: "", Vim default: CTRL-F)
1630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 The key used in Command-line Mode to open the command-line window.
1632 The default is CTRL-F when 'compatible' is off.
1633 Only non-printable keys are allowed.
1634 The key can be specified as a single character, but it is difficult to
1635 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001636 :exe "set cedit=\<C-Y>"
1637 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638< |Nvi| also has this option, but it only uses the first character.
1639 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001640 NOTE: This option is set to the Vim default value when 'compatible'
1641 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642
1643 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1644'charconvert' 'ccv' string (default "")
1645 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001646 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 An expression that is used for character encoding conversion. It is
1648 evaluated when a file that is to be read or has been written has a
1649 different encoding from what is desired.
1650 'charconvert' is not used when the internal iconv() function is
1651 supported and is able to do the conversion. Using iconv() is
1652 preferred, because it is much faster.
1653 'charconvert' is not used when reading stdin |--|, because there is no
1654 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001655 The expression must return zero, false or an empty string for success,
1656 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 The possible encoding names encountered are in 'encoding'.
1658 Additionally, names given in 'fileencodings' and 'fileencoding' are
1659 used.
1660 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1661 is done internally by Vim, 'charconvert' is not used for this.
1662 'charconvert' is also used to convert the viminfo file, if the 'c'
1663 flag is present in 'viminfo'. Also used for Unicode conversion.
1664 Example: >
1665 set charconvert=CharConvert()
1666 fun CharConvert()
1667 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001668 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1669 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 return v:shell_error
1671 endfun
1672< The related Vim variables are:
1673 v:charconvert_from name of the current encoding
1674 v:charconvert_to name of the desired encoding
1675 v:fname_in name of the input file
1676 v:fname_out name of the output file
1677 Note that v:fname_in and v:fname_out will never be the same.
1678 Note that v:charconvert_from and v:charconvert_to may be different
1679 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001680
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001681 The advantage of using a function call without arguments is that it is
1682 faster, see |expr-option-function|.
1683
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684 Encryption is not done by Vim when using 'charconvert'. If you want
1685 to encrypt the file after conversion, 'charconvert' should take care
1686 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001687
1688 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1689 replaced with the script ID (|local-function|). Example: >
1690 set charconvert=s:MyConvert()
1691 set charconvert=<SID>SomeConvert()
1692< Otherwise the expression is evaluated in the context of the script
1693 where the option was set, thus script-local items are available.
1694
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 This option cannot be set from a |modeline| or in the |sandbox|, for
1696 security reasons.
1697
1698 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1699'cindent' 'cin' boolean (default off)
1700 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001701 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 that trigger reindenting in insert mode and 'cinoptions' to set your
1703 preferred indent style.
1704 If 'indentexpr' is not empty, it overrules 'cindent'.
1705 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1706 the "=" operator indents using this algorithm rather than calling an
1707 external program.
1708 See |C-indenting|.
1709 When you don't like the way 'cindent' works, try the 'smartindent'
1710 option or 'indentexpr'.
1711 This option is not used when 'paste' is set.
1712 NOTE: This option is reset when 'compatible' is set.
1713
1714 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001715'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 A list of keys that, when typed in Insert mode, cause reindenting of
1718 the current line. Only used if 'cindent' is on and 'indentexpr' is
1719 empty.
1720 For the format of this option see |cinkeys-format|.
1721 See |C-indenting|.
1722
1723 *'cinoptions'* *'cino'*
1724'cinoptions' 'cino' string (default "")
1725 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1727 program. See |cinoptions-values| for the values of this option, and
1728 |C-indenting| for info on C indenting in general.
1729
1730
1731 *'cinwords'* *'cinw'*
1732'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1733 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 These keywords start an extra indent in the next line when
1735 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1736 an appropriate place (inside {}).
1737 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1738 matter, include the keyword both the uppercase and lowercase:
1739 "if,If,IF".
1740
Tom Praschan3506cf32022-04-07 12:39:08 +01001741 *'cinscopedecls'* *'cinsd'*
1742'cinscopedecls' 'cinsd' string (default "public,protected,private")
1743 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001744 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1745 Useful e.g. for working with the Qt framework that defines additional
1746 scope declarations "signals", "public slots" and "private slots": >
1747 set cinscopedecls+=signals,public\ slots,private\ slots
1748
1749< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1751 for X-windows, "" otherwise)
1752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 {only in GUI versions or when the |+xterm_clipboard|
1754 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001755 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001756 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001757 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001758 prepend, e.g.: >
1759 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001760< When using the GUI see |'go-A'|.
1761 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001763 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 unnamed When included, Vim will use the clipboard register '*'
1765 for all yank, delete, change and put operations which
1766 would normally go to the unnamed register. When a
1767 register is explicitly specified, it will always be
1768 used regardless of whether "unnamed" is in 'clipboard'
1769 or not. The clipboard register can always be
1770 explicitly accessed using the "* notation. Also see
1771 |gui-clipboard|.
1772
Bram Moolenaar30b65812012-07-12 22:01:11 +02001773 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001774 unnamedplus A variant of the "unnamed" flag which uses the
1775 clipboard register '+' (|quoteplus|) instead of
1776 register '*' for all yank, delete, change and put
1777 operations which would normally go to the unnamed
1778 register. When "unnamed" is also included to the
1779 option, yank operations (but not delete, change or
1780 put) will additionally copy the text into register
1781 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001782 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001783 Availability can be checked with: >
1784 if has('unnamedplus')
1785<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001786 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 autoselect Works like the 'a' flag in 'guioptions': If present,
1788 then whenever Visual mode is started, or the Visual
1789 area extended, Vim tries to become the owner of the
1790 windowing system's global selection or put the
1791 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001792 register "*. See |'go-a'| and |quotestar| for details.
1793 When the GUI is active, the 'a' flag in 'guioptions'
1794 is used, when the GUI is not active, this "autoselect"
1795 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 Also applies to the modeless selection.
1797
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001798 *clipboard-autoselectplus*
1799 autoselectplus Like "autoselect" but using the + register instead of
1800 the * register. Compare to the 'P' flag in
1801 'guioptions'.
1802
1803 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 autoselectml Like "autoselect", but for the modeless selection
1805 only. Compare to the 'A' flag in 'guioptions'.
1806
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001807 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001808 html When the clipboard contains HTML, use this when
1809 pasting. When putting text on the clipboard, mark it
1810 as HTML. This works to copy rendered HTML from
1811 Firefox, paste it as raw HTML in Vim, select the HTML
1812 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001813 You probably want to add this only temporarily,
1814 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001815 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001816
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001817 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 exclude:{pattern}
1819 Defines a pattern that is matched against the name of
1820 the terminal 'term'. If there is a match, no
1821 connection will be made to the X server. This is
1822 useful in this situation:
1823 - Running Vim in a console.
1824 - $DISPLAY is set to start applications on another
1825 display.
1826 - You do not want to connect to the X server in the
1827 console, but do want this in a terminal emulator.
1828 To never connect to the X server use: >
1829 exclude:.*
1830< This has the same effect as using the |-X| argument.
1831 Note that when there is no connection to the X server
1832 the window title won't be restored and the clipboard
1833 cannot be accessed.
1834 The value of 'magic' is ignored, {pattern} is
1835 interpreted as if 'magic' was on.
1836 The rest of the option value will be used for
1837 {pattern}, this must be the last entry.
1838
1839 *'cmdheight'* *'ch'*
1840'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001841 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001842 Number of screen lines to use for the command-line. A larger value
1843 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001844 The value of this option is stored with the tab page, so that each tab
1845 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846
1847 *'cmdwinheight'* *'cwh'*
1848'cmdwinheight' 'cwh' number (default 7)
1849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 Number of screen lines to use for the command-line window. |cmdwin|
1851
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001852 *'colorcolumn'* *'cc'*
1853'colorcolumn' 'cc' string (default "")
1854 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001855 {not available when compiled without the |+syntax|
1856 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001857 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001858 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1859 text. Will make screen redrawing slower.
1860 The screen column can be an absolute number, or a number preceded with
1861 '+' or '-', which is added to or subtracted from 'textwidth'. >
1862
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001863 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001864 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1865 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1866<
1867 When 'textwidth' is zero then the items with '-' and '+' are not used.
1868 A maximum of 256 columns are highlighted.
1869
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 *'columns'* *'co'* *E594*
1871'columns' 'co' number (default 80 or terminal width)
1872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001874 initialization and does not have to be set by hand. Also see
1875 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 When Vim is running in the GUI or in a resizable window, setting this
1877 option will cause the window size to be changed. When you only want
1878 to use the size for the GUI, put the command in your |gvimrc| file.
1879 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001880 number of columns of the display, the display may be messed up. For
1881 the GUI it is always possible and Vim limits the number of columns to
1882 what fits on the screen. You can use this command to get the widest
1883 window possible: >
1884 :set columns=9999
1885< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886
1887 *'comments'* *'com'* *E524* *E525*
1888'comments' 'com' string (default
1889 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1890 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001891 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 |format-comments|. See |option-backslash| about using backslashes to
1893 insert a space.
1894
1895 *'commentstring'* *'cms'* *E537*
1896'commentstring' 'cms' string (default "/*%s*/")
1897 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898 {not available when compiled without the |+folding|
1899 feature}
1900 A template for a comment. The "%s" in the value is replaced with the
1901 comment text. Currently only used to add markers for folding, see
1902 |fold-marker|.
1903
1904 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001905'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001906 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 This option has the effect of making Vim either more Vi-compatible, or
1909 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001910
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001912 other options are also changed as a side effect.
1913 NOTE: Setting or resetting this option can have a lot of unexpected
1914 effects: Mappings are interpreted in another way, undo behaves
1915 differently, etc. If you set this option in your vimrc file, you
1916 should probably put it at the very start.
1917
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 By default this option is on and the Vi defaults are used for the
1919 options. This default was chosen for those people who want to use Vim
1920 just like Vi, and don't even (want to) know about the 'compatible'
1921 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001922 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001923 this option is switched off, and all options that have not been
1924 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001925 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001926 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001927 happen for the system-wide vimrc or gvimrc file, nor for a file given
1928 with the |-u| argument). Also see |compatible-default| and
1929 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 You can also set this option with the "-C" argument, and reset it with
1931 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001932 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933
Bram Moolenaar214641f2017-03-05 17:04:09 +01001934 When this option is set, numerous other options are set to make Vim as
1935 Vi-compatible as possible. When this option is unset, various options
1936 are set to make Vim more useful. The table below lists all the
1937 options affected.
1938 The {?} column indicates when the options are affected:
1939 + Means that the option is set to the value given in {set value} when
1940 'compatible' is set.
1941 & Means that the option is set to the value given in {set value} when
1942 'compatible' is set AND is set to its Vim default value when
1943 'compatible' is unset.
1944 - Means the option is NOT changed when setting 'compatible' but IS
1945 set to its Vim default when 'compatible' is unset.
1946 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947
Bram Moolenaar036986f2017-03-16 17:41:02 +01001948 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001949
1950 'allowrevins' + off no CTRL-_ command
1951 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001952 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001953 'arabicshape' + on correct character shapes
1954 'backspace' + "" normal backspace
1955 'backup' + off no backup file
1956 'backupcopy' & Unix: "yes" backup file is a copy
1957 else: "auto" copy or rename backup file
1958 'balloonexpr' + "" text to show in evaluation balloon
1959 'breakindent' + off don't indent when wrapping lines
1960 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001961 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001962 'cindent' + off no C code indentation
1963 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1964 'copyindent' + off don't copy indent structure
1965 'cpoptions' & (all flags) Vi-compatible flags
1966 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001967 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001968 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001969 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001970 'cscopeverbose' + off see |cscopeverbose|
1971 'delcombine' + off unicode: delete whole char combination
1972 'digraph' + off no digraphs
1973 'esckeys' & off no <Esc>-keys in Insert mode
1974 'expandtab' + off tabs not expanded to spaces
1975 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001976 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001977 'formatexpr' + "" use 'formatprg' for auto-formatting
1978 'formatoptions' & "vt" Vi compatible formatting
1979 'gdefault' + off no default 'g' flag for ":s"
1980 'history' & 0 no commandline history
1981 'hkmap' + off no Hebrew keyboard mapping
1982 'hkmapp' + off no phonetic Hebrew keyboard mapping
1983 'hlsearch' + off no highlighting of search matches
1984 'incsearch' + off no incremental searching
1985 'indentexpr' + "" no indenting by expression
1986 'insertmode' + off do not start in Insert mode
1987 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001989 'joinspaces' + on insert 2 spaces after period
1990 'modeline' & off no modelines
1991 'more' & off no pauses in listings
1992 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1993 'numberwidth' & 8 min number of columns for line number
1994 'preserveindent'+ off don't preserve current indent structure
1995 when changing it
1996 'revins' + off no reverse insert
1997 'ruler' + off no ruler
1998 'scrolljump' + 1 no jump scroll
1999 'scrolloff' + 0 no scroll offset
2000 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2001 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002002 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002003 'showcmd' & off command characters not shown
2004 'showmode' & off current mode not shown
2005 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2006 'smartcase' + off no automatic ignore case switch
2007 'smartindent' + off no smart indentation
2008 'smarttab' + off no smart tab size
2009 'softtabstop' + 0 tabs are always 'tabstop' positions
2010 'startofline' + on goto startofline with some commands
2011 'tagcase' & "followic" 'ignorecase' when searching tags file
2012 'tagrelative' & off tag file names are not relative
2013 'termguicolors' + off don't use highlight-(guifg|guibg)
2014 'textauto' & off no automatic textmode detection
2015 'textwidth' + 0 no automatic line wrap
2016 'tildeop' + off tilde is not an operator
2017 'ttimeout' + off no terminal timeout
2018 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002019 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002020 'virtualedit' + "" cursor can only be placed on characters
2021 'whichwrap' & "" left-right movements don't wrap
2022 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002024 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025
2026 *'complete'* *'cpt'* *E535*
2027'complete' 'cpt' string (default: ".,w,b,u,t,i")
2028 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 This option specifies how keyword completion |ins-completion| works
2030 when CTRL-P or CTRL-N are used. It is also used for whole-line
2031 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002032 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002033 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 w scan buffers from other windows
2035 b scan other loaded buffers that are in the buffer list
2036 u scan the unloaded buffers that are in the buffer list
2037 U scan the buffers that are not in the buffer list
2038 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002039 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 k{dict} scan the file {dict}. Several "k" flags can be given,
2041 patterns are valid too. For example: >
2042 :set cpt=k/usr/dict/*,k~/spanish
2043< s scan the files given with the 'thesaurus' option
2044 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2045 are valid too.
2046 i scan current and included files
2047 d scan current and included files for defined name or macro
2048 |i_CTRL-X_CTRL-D|
2049 ] tag completion
2050 t same as "]"
2051
2052 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2053 not executed, this may lead to unexpected completions from some files
2054 (gzipped files for example). Unloaded buffers are not scanned for
2055 whole-line completion.
2056
2057 The default is ".,w,b,u,t,i", which means to scan:
2058 1. the current buffer
2059 2. buffers in other windows
2060 3. other loaded buffers
2061 4. unloaded buffers
2062 5. tags
2063 6. included files
2064
2065 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002066 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2067 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002069 *'completefunc'* *'cfu'*
2070'completefunc' 'cfu' string (default: empty)
2071 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002072 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002073 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002074 This option specifies a function to be used for Insert mode completion
2075 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002076 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002077 invoked and what it should return. The value can be the name of a
2078 function, a |lambda| or a |Funcref|. See |option-value-function| for
2079 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002080 This option cannot be set from a |modeline| or in the |sandbox|, for
2081 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002082
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002083 *'completeslash'* *'csl'*
2084'completeslash' 'csl' string (default: "")
2085 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002086 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002087 When this option is set it overrules 'shellslash' for completion:
2088 - When this option is set to "slash", a forward slash is used for path
2089 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002090 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002091 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002092 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002093 - When this option is empty, same character is used as for
2094 'shellslash'.
2095 For Insert mode completion the buffer-local value is used. For
2096 command line completion the global value is used.
2097
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002098 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002099'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002100 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002101 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002102 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002103
2104 menu Use a popup menu to show the possible completions. The
2105 menu is only shown when there is more than one match and
2106 sufficient colors are available. |ins-completion-menu|
2107
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002108 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002109 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002110 match, e.g., what file it comes from.
2111
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002112 longest Only insert the longest common text of the matches. If
2113 the menu is displayed you can use CTRL-L to add more
2114 characters. Whether case is ignored depends on the kind
2115 of completion. For buffer text the 'ignorecase' option is
2116 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002117
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002118 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002119 completion in the preview window. Only works in
2120 combination with "menu" or "menuone".
2121
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002122 popup Show extra information about the currently selected
2123 completion in a popup window. Only works in combination
2124 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002125 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002126 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002127
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002128 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002129 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002130 |CompleteChanged| autocommand to fetch the info and call
2131 |popup_show()| once the popup has been filled.
2132 See the example at |complete-popuphidden|.
2133 {only works when compiled with the |+textprop| feature}
2134
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002135 noinsert Do not insert any text for a match until the user selects
2136 a match from the menu. Only works in combination with
2137 "menu" or "menuone". No effect if "longest" is present.
2138
2139 noselect Do not select a match in the menu, force the user to
2140 select one from the menu. Only works in combination with
2141 "menu" or "menuone".
2142
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002143
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002144 *'completepopup'* *'cpp'*
2145'completepopup' 'cpp' string (default empty)
2146 global
2147 {not available when compiled without the |+textprop|
2148 or |+quickfix| feature}
2149 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002150 properties of the info popup when it is created. If an info popup
2151 window already exists it is closed, so that the option value is
2152 applied when it is created again.
2153 You can also use |popup_findinfo()| and then set properties for an
2154 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002155
2156
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002157 *'concealcursor'* *'cocu'*
2158'concealcursor' 'cocu' string (default: "")
2159 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002160 {not available when compiled without the |+conceal|
2161 feature}
2162 Sets the modes in which text in the cursor line can also be concealed.
2163 When the current mode is listed then concealing happens just like in
2164 other lines.
2165 n Normal mode
2166 v Visual mode
2167 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002168 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002169
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002170 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002171 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002172 are moving around text is concealed, but when starting to insert text
2173 or selecting a Visual area the concealed text is displayed, so that
2174 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002175 Keep in mind that the cursor position is not always where it's
2176 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002177
2178
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002179 *'conceallevel'* *'cole'*
2180'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002181 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002182 {not available when compiled without the |+conceal|
2183 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002184 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2185 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002186
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002187 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002188 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002189 1 Each block of concealed text is replaced with one
2190 character. If the syntax item does not have a custom
2191 replacement character defined (see |:syn-cchar|) the
2192 character defined in 'listchars' is used (default is a
2193 space).
2194 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002195 2 Concealed text is completely hidden unless it has a
2196 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002197 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002198 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002199
Bram Moolenaara7781e02010-07-19 20:13:22 +02002200 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002201 edit and copy the text. This can be changed with the 'concealcursor'
2202 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002203
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2205'confirm' 'cf' boolean (default off)
2206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 When 'confirm' is on, certain operations that would normally
2208 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2209 instead raise a |dialog| asking if you wish to save the current
2210 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2211 If 'confirm' is off you can still activate confirmation for one
2212 command only (this is most useful in mappings) with the |:confirm|
2213 command.
2214 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2215
2216 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2217'conskey' 'consk' boolean (default off)
2218 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002219 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220
2221 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2222'copyindent' 'ci' boolean (default off)
2223 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 Copy the structure of the existing lines indent when autoindenting a
2225 new line. Normally the new indent is reconstructed by a series of
2226 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2227 in which case only spaces are used). Enabling this option makes the
2228 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002229 existing line. 'expandtab' has no effect on these characters, a Tab
2230 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002232 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 Also see 'preserveindent'.
2234
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002235 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236'cpoptions' 'cpo' string (Vim default: "aABceFs",
2237 Vi default: all flags)
2238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002240 this indicates Vi-compatible behavior. This is used for things where
2241 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 'cpoptions' stands for "compatible-options".
2243 Commas can be added for readability.
2244 To avoid problems with flags that are added in the future, use the
2245 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002246
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 NOTE: This option is set to the Vi default value when 'compatible' is
2248 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002249
2250 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2251 is saved, 'cpoptions' is set to the Vim default, and the saved value
2252 is restored at the end of the script. Changes to the value of
2253 'cpoptions' will be applied to the saved value, but keep in mind that
2254 removing a flag that is not present when 'cpoptions' is changed has no
2255 effect. In the |.vimrc| file the value is not restored, thus using
2256 `vim9script` in the |.vimrc| file results in using the Vim default.
2257
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002258 NOTE: This option is set to the POSIX default value at startup when
2259 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002260 variable exists |posix|. This means Vim tries to behave like the
2261 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262
2263 contains behavior ~
2264 *cpo-a*
2265 a When included, a ":read" command with a file name
2266 argument will set the alternate file name for the
2267 current window.
2268 *cpo-A*
2269 A When included, a ":write" command with a file name
2270 argument will set the alternate file name for the
2271 current window.
2272 *cpo-b*
2273 b "\|" in a ":map" command is recognized as the end of
2274 the map command. The '\' is included in the mapping,
2275 the text after the '|' is interpreted as the next
2276 command. Use a CTRL-V instead of a backslash to
2277 include the '|' in the mapping. Applies to all
2278 mapping, abbreviation, menu and autocmd commands.
2279 See also |map_bar|.
2280 *cpo-B*
2281 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002282 abbreviations, user commands and the "to" part of the
2283 menu commands. Remove this flag to be able to use a
2284 backslash like a CTRL-V. For example, the command
2285 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 'B' included: "\^[" (^[ is a real <Esc>)
2287 'B' excluded: "<Esc>" (5 characters)
2288 ('<' excluded in both cases)
2289 *cpo-c*
2290 c Searching continues at the end of any match at the
2291 cursor position, but not further than the start of the
2292 next line. When not present searching continues
2293 one character from the cursor position. With 'c'
2294 "abababababab" only gets three matches when repeating
2295 "/abab", without 'c' there are five matches.
2296 *cpo-C*
2297 C Do not concatenate sourced lines that start with a
2298 backslash. See |line-continuation|.
2299 *cpo-d*
2300 d Using "./" in the 'tags' option doesn't mean to use
2301 the tags file relative to the current file, but the
2302 tags file in the current directory.
2303 *cpo-D*
2304 D Can't use CTRL-K to enter a digraph after Normal mode
2305 commands with a character argument, like |r|, |f| and
2306 |t|.
2307 *cpo-e*
2308 e When executing a register with ":@r", always add a
2309 <CR> to the last line, also when the register is not
2310 linewise. If this flag is not present, the register
2311 is not linewise and the last line does not end in a
2312 <CR>, then the last line is put on the command-line
2313 and can be edited before hitting <CR>.
2314 *cpo-E*
2315 E It is an error when using "y", "d", "c", "g~", "gu" or
2316 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002317 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 This makes "y0" fail in the first column.
2319 *cpo-f*
2320 f When included, a ":read" command with a file name
2321 argument will set the file name for the current buffer,
2322 if the current buffer doesn't have a file name yet.
2323 *cpo-F*
2324 F When included, a ":write" command with a file name
2325 argument will set the file name for the current
2326 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002327 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 *cpo-g*
2329 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002330 *cpo-H*
2331 H When using "I" on a line with only blanks, insert
2332 before the last blank. Without this flag insert after
2333 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 *cpo-i*
2335 i When included, interrupting the reading of a file will
2336 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002337 *cpo-I*
2338 I When moving the cursor up or down just after inserting
2339 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 *cpo-j*
2341 j When joining lines, only add two spaces after a '.',
2342 not after '!' or '?'. Also see 'joinspaces'.
2343 *cpo-J*
2344 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002345 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 white space.
2347 *cpo-k*
2348 k Disable the recognition of raw key codes in
2349 mappings, abbreviations, and the "to" part of menu
2350 commands. For example, if <Key> sends ^[OA (where ^[
2351 is <Esc>), the command ":map X ^[OA" results in X
2352 being mapped to:
2353 'k' included: "^[OA" (3 characters)
2354 'k' excluded: "<Key>" (one key code)
2355 Also see the '<' flag below.
2356 *cpo-K*
2357 K Don't wait for a key code to complete when it is
2358 halfway a mapping. This breaks mapping <F1><F1> when
2359 only part of the second <F1> has been read. It
2360 enables cancelling the mapping by typing <F1><Esc>.
2361 *cpo-l*
2362 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002363 literally, only "\]", "\^", "\-" and "\\" are special.
2364 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2366 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002367 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 *cpo-L*
2369 L When the 'list' option is set, 'wrapmargin',
2370 'textwidth', 'softtabstop' and Virtual Replace mode
2371 (see |gR|) count a <Tab> as two characters, instead of
2372 the normal behavior of a <Tab>.
2373 *cpo-m*
2374 m When included, a showmatch will always wait half a
2375 second. When not included, a showmatch will wait half
2376 a second or until a character is typed. |'showmatch'|
2377 *cpo-M*
2378 M When excluded, "%" matching will take backslashes into
2379 account. Thus in "( \( )" and "\( ( \)" the outer
2380 parenthesis match. When included "%" ignores
2381 backslashes, which is Vi compatible.
2382 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002383 n When included, the column used for 'number' and
2384 'relativenumber' will also be used for text of wrapped
2385 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 *cpo-o*
2387 o Line offset to search command is not remembered for
2388 next search.
2389 *cpo-O*
2390 O Don't complain if a file is being overwritten, even
2391 when it didn't exist when editing it. This is a
2392 protection against a file unexpectedly created by
2393 someone else. Vi didn't complain about this.
2394 *cpo-p*
2395 p Vi compatible Lisp indenting. When not present, a
2396 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002397 *cpo-P*
2398 P When included, a ":write" command that appends to a
2399 file will set the file name for the current buffer, if
2400 the current buffer doesn't have a file name yet and
2401 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002402 *cpo-q*
2403 q When joining multiple lines leave the cursor at the
2404 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 *cpo-r*
2406 r Redo ("." command) uses "/" to repeat a search
2407 command, instead of the actually used search string.
2408 *cpo-R*
2409 R Remove marks from filtered lines. Without this flag
2410 marks are kept like |:keepmarks| was used.
2411 *cpo-s*
2412 s Set buffer options when entering the buffer for the
2413 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002414 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 set when the buffer is created.
2416 *cpo-S*
2417 S Set buffer options always when entering a buffer
2418 (except 'readonly', 'fileformat', 'filetype' and
2419 'syntax'). This is the (most) Vi compatible setting.
2420 The options are set to the values in the current
2421 buffer. When you change an option and go to another
2422 buffer, the value is copied. Effectively makes the
2423 buffer options global to all buffers.
2424
2425 's' 'S' copy buffer options
2426 no no when buffer created
2427 yes no when buffer first entered (default)
2428 X yes each time when buffer entered (vi comp.)
2429 *cpo-t*
2430 t Search pattern for the tag command is remembered for
2431 "n" command. Otherwise Vim only puts the pattern in
2432 the history for search pattern, but doesn't change the
2433 last used search pattern.
2434 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002435 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436 *cpo-v*
2437 v Backspaced characters remain visible on the screen in
2438 Insert mode. Without this flag the characters are
2439 erased from the screen right away. With this flag the
2440 screen newly typed text overwrites backspaced
2441 characters.
2442 *cpo-w*
2443 w When using "cw" on a blank character, only change one
2444 character and not all blanks until the start of the
2445 next word.
2446 *cpo-W*
2447 W Don't overwrite a readonly file. When omitted, ":w!"
2448 overwrites a readonly file, if possible.
2449 *cpo-x*
2450 x <Esc> on the command-line executes the command-line.
2451 The default in Vim is to abandon the command-line,
2452 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002453 *cpo-X*
2454 X When using a count with "R" the replaced text is
2455 deleted only once. Also when repeating "R" with "."
2456 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002458 y A yank command can be redone with ".". Think twice if
2459 you really want to use this, it may break some
2460 plugins, since most people expect "." to only repeat a
2461 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002462 *cpo-Z*
2463 Z When using "w!" while the 'readonly' option is set,
2464 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 *cpo-!*
2466 ! When redoing a filter command, use the last used
2467 external command, whatever it was. Otherwise the last
2468 used -filter- command is used.
2469 *cpo-$*
2470 $ When making a change to one line, don't redisplay the
2471 line, but put a '$' at the end of the changed text.
2472 The changed text will be overwritten when you type the
2473 new text. The line is redisplayed if you type any
2474 command that moves the cursor from the insertion
2475 point.
2476 *cpo-%*
2477 % Vi-compatible matching is done for the "%" command.
2478 Does not recognize "#if", "#endif", etc.
2479 Does not recognize "/*" and "*/".
2480 Parens inside single and double quotes are also
2481 counted, causing a string that contains a paren to
2482 disturb the matching. For example, in a line like
2483 "if (strcmp("foo(", s))" the first paren does not
2484 match the last one. When this flag is not included,
2485 parens inside single and double quotes are treated
2486 specially. When matching a paren outside of quotes,
2487 everything inside quotes is ignored. When matching a
2488 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002489 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002490 This flag is also used for other features, such as
2491 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002492 *cpo--*
2493 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002494 it would go above the first line or below the last
2495 line. Without it the cursor moves to the first or
2496 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002497 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002498 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002499 *cpo-+*
2500 + When included, a ":write file" command will reset the
2501 'modified' flag of the buffer, even though the buffer
2502 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002503 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 * Use ":*" in the same way as ":@". When not included,
2505 ":*" is an alias for ":'<,'>", select the Visual area.
2506 *cpo-<*
2507 < Disable the recognition of special key codes in |<>|
2508 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002509 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 ":map X <Tab>" results in X being mapped to:
2511 '<' included: "<Tab>" (5 characters)
2512 '<' excluded: "^I" (^I is a real <Tab>)
2513 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002514 *cpo->*
2515 > When appending to a register, put a line break before
2516 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002517 *cpo-;*
2518 ; When using |,| or |;| to repeat the last |t| search
2519 and the cursor is right in front of the searched
2520 character, the cursor won't move. When not included,
2521 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002522 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002523
2524 POSIX flags. These are not included in the Vi default value, except
2525 when $VIM_POSIX was set on startup. |posix|
2526
2527 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002528 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002529 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002530 *cpo-&*
2531 & When ":preserve" was used keep the swap file when
2532 exiting normally while this buffer is still loaded.
2533 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002534 *cpo-\*
2535 \ Backslash in a [] range in a search pattern is taken
2536 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002537 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2538 '\' excluded: "/[ \-]" finds <Space> and '-'
2539 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002540 *cpo-/*
2541 / When "%" is used as the replacement string in a |:s|
2542 command, use the previous replacement string. |:s%|
2543 *cpo-{*
2544 { The |{| and |}| commands also stop at a "{" character
2545 at the start of a line.
2546 *cpo-.*
2547 . The ":chdir" and ":cd" commands fail if the current
2548 buffer is modified, unless ! is used. Vim doesn't
2549 need this, since it remembers the full path of an
2550 opened file.
2551 *cpo-bar*
2552 | The value of the $LINES and $COLUMNS environment
2553 variables overrule the terminal size values obtained
2554 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002555
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002557 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002558'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002559 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002560 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002561 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002562 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002563 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002564 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002565 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002566 blowfish Blowfish method. Medium strong encryption but it has
2567 an implementation flaw. Requires Vim 7.3 or later,
2568 files can NOT be read by Vim 7.2 and older. This adds
2569 a "seed" to the file, every time you write the file
2570 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002571 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002572 *blowfish2*
2573 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002574 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002575 and older. This adds a "seed" to the file, every time
2576 you write the file the encrypted bytes will be
2577 different. The whole undo file is encrypted, not just
2578 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002579 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002580 *E1197* *E1198* *E1199* *E1200* *E1201*
2581 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2582 Code. Medium strong till strong encryption.
2583 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002584 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002585 It adds a seed and a message authentication code (MAC)
2586 to the file. This needs at least a Vim 8.2.3022 to
2587 read the encrypted file.
2588 Encryption of swap files is not supported, therefore
2589 no swap file will be used when xchacha20 encryption is
2590 enabled.
2591 Encryption of undo files is not yet supported,
2592 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002593 CAREFUL: Files written with this method might have to
2594 be read back with the same version of Vim if the
2595 binary format changes later.
2596 Obsolete, please do no longer use.
2597 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2598 stores the key derivation parameters together with the
2599 encrypted file. Should work better in case the
2600 parameters in the libsodium library ever change.
2601 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002602 might have to be read back with the same version of
2603 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002604
Christian Brabandtaae58342023-04-23 17:50:22 +01002605 You should use "blowfish2", also to re-encrypt older files. The
2606 "xchacha20" method provides better encryption, but it does not work
2607 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002608
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002609 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002610 to the detected method of the file being read. Thus if you write it
2611 without changing 'cryptmethod' the same method will be used.
2612 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002613 explicitly write it, you don't get a warning unless there are other
2614 modifications. Also see |:X|.
2615
2616 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002617 the value "blowfish2". When setting the local value to an empty
2618 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002619
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002620 When a new encryption method is added in a later version of Vim, and
2621 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002622 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002623
2624
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 *'cscopepathcomp'* *'cspc'*
2626'cscopepathcomp' 'cspc' number (default 0)
2627 global
2628 {not available when compiled without the |+cscope|
2629 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630 Determines how many components of the path to show in a list of tags.
2631 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002632 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633
2634 *'cscopeprg'* *'csprg'*
2635'cscopeprg' 'csprg' string (default "cscope")
2636 global
2637 {not available when compiled without the |+cscope|
2638 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 Specifies the command to execute cscope. See |cscopeprg|.
2640 This option cannot be set from a |modeline| or in the |sandbox|, for
2641 security reasons.
2642
2643 *'cscopequickfix'* *'csqf'*
2644'cscopequickfix' 'csqf' string (default "")
2645 global
2646 {not available when compiled without the |+cscope|
2647 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 Specifies whether to use quickfix window to show cscope results.
2649 See |cscopequickfix|.
2650
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002651 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002652'cscoperelative' 'csre' boolean (default off)
2653 global
2654 {not available when compiled without the |+cscope|
2655 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002656 In the absence of a prefix (-P) for cscope. setting this option enables
2657 to use the basename of cscope.out path as the prefix.
2658 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002659 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002660
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2662'cscopetag' 'cst' boolean (default off)
2663 global
2664 {not available when compiled without the |+cscope|
2665 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 Use cscope for tag commands. See |cscope-options|.
2667 NOTE: This option is reset when 'compatible' is set.
2668
2669 *'cscopetagorder'* *'csto'*
2670'cscopetagorder' 'csto' number (default 0)
2671 global
2672 {not available when compiled without the |+cscope|
2673 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 Determines the order in which ":cstag" performs a search. See
2675 |cscopetagorder|.
2676 NOTE: This option is set to 0 when 'compatible' is set.
2677
2678 *'cscopeverbose'* *'csverb'*
2679 *'nocscopeverbose'* *'nocsverb'*
2680'cscopeverbose' 'csverb' boolean (default off)
2681 global
2682 {not available when compiled without the |+cscope|
2683 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 Give messages when adding a cscope database. See |cscopeverbose|.
2685 NOTE: This option is reset when 'compatible' is set.
2686
Bram Moolenaar860cae12010-06-05 23:22:07 +02002687 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2688'cursorbind' 'crb' boolean (default off)
2689 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002690 When this option is set, as the cursor in the current
2691 window moves other cursorbound windows (windows that also have
2692 this option set) move their cursors to the corresponding line and
2693 column. This option is useful for viewing the
2694 differences between two versions of a file (see 'diff'); in diff mode,
2695 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002696 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002697
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002698
2699 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2700'cursorcolumn' 'cuc' boolean (default off)
2701 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002702 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002703 feature}
2704 Highlight the screen column of the cursor with CursorColumn
2705 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2706 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002707 If you only want the highlighting in the current window you can use
2708 these autocommands: >
2709 au WinLeave * set nocursorline nocursorcolumn
2710 au WinEnter * set cursorline cursorcolumn
2711<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002712
2713 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2714'cursorline' 'cul' boolean (default off)
2715 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002716 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002717 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002718 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2719 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002720 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002721 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002722
2723
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002724 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002725'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002726 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002727 {not available when compiled without the |+syntax|
2728 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002729 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002730 Valid values:
2731 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002732 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002733 "screenline" Highlight only the screen line of the cursor with
2734 CursorLine |hl-CursorLine|.
2735 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002736 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002737
2738 Special value:
2739 "both" Alias for the values "line,number".
2740
2741 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002742
2743
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 *'debug'*
2745'debug' string (default "")
2746 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002747 These values can be used:
2748 msg Error messages that would otherwise be omitted will be given
2749 anyway.
2750 throw Error messages that would otherwise be omitted will be given
2751 anyway and also throw an exception and set |v:errmsg|.
2752 beep A message will be given when otherwise only a beep would be
2753 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002754 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002755 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2756 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757
2758 *'define'* *'def'*
2759'define' 'def' string (default "^\s*#\s*define")
2760 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002761 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 pattern, just like for the "/" command. This option is used for the
2763 commands like "[i" and "[d" |include-search|. The 'isident' option is
2764 used to recognize the defined name after the match:
2765 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2766 See |option-backslash| about inserting backslashes to include a space
2767 or backslash.
2768 The default value is for C programs. For C++ this value would be
2769 useful, to include const type declarations: >
2770 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002771< You can also use "\ze" just before the name and continue the pattern
2772 to check what is following. E.g. for Javascript, if a function is
2773 defined with "func_name = function(args)": >
2774 ^\s*\ze\i\+\s*=\s*function(
2775< If the function is defined with "func_name : function() {...": >
2776 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002778 To avoid that use `:let` with a single quote string: >
2779 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002780<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781
2782 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2783'delcombine' 'deco' boolean (default off)
2784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 If editing Unicode and this option is set, backspace and Normal mode
2786 "x" delete each combining character on its own. When it is off (the
2787 default) the character along with its combining characters are
2788 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002789 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790
2791 This is useful for Arabic, Hebrew and many other languages where one
2792 may have combining characters overtop of base characters, and want
2793 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002794 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795
2796 *'dictionary'* *'dict'*
2797'dictionary' 'dict' string (default "")
2798 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 List of file names, separated by commas, that are used to lookup words
2800 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2801 contain a list of words. This can be one word per line, or several
2802 words per line, separated by non-keyword characters (white space is
2803 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002804
2805 When this option is empty or an entry "spell" is present, and spell
2806 checking is enabled, words in the word lists for the currently active
2807 'spelllang' are used. See |spell|.
2808
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002809 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 after a comma are ignored, otherwise spaces are included in the file
2811 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002812 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 Where to find a list of words?
2814 - On FreeBSD, there is the file "/usr/share/dict/words".
2815 - In the Simtel archive, look in the "msdos/linguist" directory.
2816 - In "miscfiles" of the GNU collection.
2817 The use of |:set+=| and |:set-=| is preferred when adding or removing
2818 directories from the list. This avoids problems when a future version
2819 uses another default.
2820 Backticks cannot be used in this option for security reasons.
2821
2822 *'diff'* *'nodiff'*
2823'diff' boolean (default off)
2824 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 {not available when compiled without the |+diff|
2826 feature}
2827 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002828 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829
2830 *'dex'* *'diffexpr'*
2831'diffexpr' 'dex' string (default "")
2832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 {not available when compiled without the |+diff|
2834 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002835 Expression which is evaluated to obtain a diff file (either ed-style
2836 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 This option cannot be set from a |modeline| or in the |sandbox|, for
2838 security reasons.
2839
2840 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002841'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 {not available when compiled without the |+diff|
2844 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002845 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 All are optional. Items must be separated by a comma.
2847
2848 filler Show filler lines, to keep the text
2849 synchronized with a window that has inserted
2850 lines at the same position. Mostly useful
2851 when windows are side-by-side and 'scrollbind'
2852 is set.
2853
2854 context:{n} Use a context of {n} lines between a change
2855 and a fold that contains unchanged lines.
2856 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002857 When using zero the context is actually one,
2858 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002859 for a deleted line. Set it to a very large
2860 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 See |fold-diff|.
2862
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002863 iblank Ignore changes where lines are all blank. Adds
2864 the "-B" flag to the "diff" command if
2865 'diffexpr' is empty. Check the documentation
2866 of the "diff" command for what this does
2867 exactly.
2868 NOTE: the diff windows will get out of sync,
2869 because no differences between blank lines are
2870 taken into account.
2871
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 icase Ignore changes in case of text. "a" and "A"
2873 are considered the same. Adds the "-i" flag
2874 to the "diff" command if 'diffexpr' is empty.
2875
2876 iwhite Ignore changes in amount of white space. Adds
2877 the "-b" flag to the "diff" command if
2878 'diffexpr' is empty. Check the documentation
2879 of the "diff" command for what this does
2880 exactly. It should ignore adding trailing
2881 white space, but not leading white space.
2882
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002883 iwhiteall Ignore all white space changes. Adds
2884 the "-w" flag to the "diff" command if
2885 'diffexpr' is empty. Check the documentation
2886 of the "diff" command for what this does
2887 exactly.
2888
2889 iwhiteeol Ignore white space changes at end of line.
2890 Adds the "-Z" flag to the "diff" command if
2891 'diffexpr' is empty. Check the documentation
2892 of the "diff" command for what this does
2893 exactly.
2894
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002895 horizontal Start diff mode with horizontal splits (unless
2896 explicitly specified otherwise).
2897
2898 vertical Start diff mode with vertical splits (unless
2899 explicitly specified otherwise).
2900
Bram Moolenaarc8234772019-11-10 21:00:27 +01002901 closeoff When a window is closed where 'diff' is set
2902 and there is only one window remaining in the
2903 same tab page with 'diff' set, execute
2904 `:diffoff` in that window. This undoes a
2905 `:diffsplit` command.
2906
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002907 hiddenoff Do not use diff mode for a buffer when it
2908 becomes hidden.
2909
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002910 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2911 starting diff mode. Without this 2 is used.
2912
Bram Moolenaar4223d432021-02-10 13:18:17 +01002913 followwrap Follow the 'wrap' option and leave as it is.
2914
Bram Moolenaare828b762018-09-10 17:51:58 +02002915 internal Use the internal diff library. This is
2916 ignored when 'diffexpr' is set. *E960*
2917 When running out of memory when writing a
2918 buffer this item will be ignored for diffs
2919 involving that buffer. Set the 'verbose'
2920 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921
Bram Moolenaare828b762018-09-10 17:51:58 +02002922 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002923 Use the indent heuristic for the internal
2924 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002925
2926 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002927 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002928 algorithms are:
2929 myers the default algorithm
2930 minimal spend extra time to generate the
2931 smallest possible diff
2932 patience patience diff algorithm
2933 histogram histogram diff algorithm
2934
2935 Examples: >
2936 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002938 :set diffopt=internal,filler,foldcolumn:3
2939 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940<
2941 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2942'digraph' 'dg' boolean (default off)
2943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 {not available when compiled without the |+digraphs|
2945 feature}
2946 Enable the entering of digraphs in Insert mode with {char1} <BS>
2947 {char2}. See |digraphs|.
2948 NOTE: This option is reset when 'compatible' is set.
2949
2950 *'directory'* *'dir'*
2951'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002952 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 for Unix: ".,~/tmp,/var/tmp,/tmp")
2954 global
2955 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002956 Recommended value: ".,~/vimswap//" - this will put the swap file next
2957 to the edited file if possible, and in your personal swap directory
2958 otherwise. Make sure "~/vimswap//" is only readable for you.
2959
2960 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 - The swap file will be created in the first directory where this is
2962 possible.
2963 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002964 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 - A directory "." means to put the swap file in the same directory as
2966 the edited file. On Unix, a dot is prepended to the file name, so
2967 it doesn't show in a directory listing. On MS-Windows the "hidden"
2968 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002969 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2970 the swap file relative to where the edited file is. The leading "."
2971 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002972 - For Unix and Win32, if a directory ends in two path separators "//",
2973 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002974 with all path separators replaced by percent '%' signs (including
2975 the colon following the drive letter on Win32). This will ensure
2976 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002977 On Win32, it is also possible to end with "\\". However, When a
2978 separating comma is following, you must use "//", since "\\" will
2979 include the comma in the file name. Therefore it is recommended to
2980 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 - Spaces after the comma are ignored, other spaces are considered part
2982 of the directory name. To have a space at the start of a directory
2983 name, precede it with a backslash.
2984 - To include a comma in a directory name precede it with a backslash.
2985 - A directory name may end in an ':' or '/'.
2986 - Environment variables are expanded |:set_env|.
2987 - Careful with '\' characters, type one before a space, type two to
2988 get one in the option (see |option-backslash|), for example: >
2989 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2990< - For backwards compatibility with Vim version 3.0 a '>' at the start
2991 of the option is removed.
2992 Using "." first in the list is recommended. This means that editing
2993 the same file twice will result in a warning. Using "/tmp" on Unix is
2994 discouraged: When the system crashes you lose the swap file.
2995 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002996 choice than "/tmp". But others on the computer may be able to see the
2997 files, and it can contain a lot of files, your swap files get lost in
2998 the crowd. That is why a "tmp" directory in your home directory is
2999 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 The use of |:set+=| and |:set-=| is preferred when adding or removing
3001 directories from the list. This avoids problems when a future version
3002 uses another default.
3003 This option cannot be set from a |modeline| or in the |sandbox|, for
3004 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005
3006 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003007'display' 'dy' string (default "", set to "truncate" in
3008 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003010 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 flags:
3012 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003013 in a window will be displayed. "@@@" is put in the
3014 last columns of the last screen line to indicate the
3015 rest of the line is not displayed.
3016 truncate Like "lastline", but "@@@" is displayed in the first
3017 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 uhex Show unprintable characters hexadecimal as <xx>
3019 instead of using ^C and ~C.
3020
Bram Moolenaard0796902016-09-16 20:02:31 +02003021 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003022 doesn't fit is replaced with "@" lines.
3023
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003024 The "@" character can be changed by setting the "lastline" item in
3025 'fillchars'. The character is highlighted with |hl-NonText|.
3026
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 *'eadirection'* *'ead'*
3028'eadirection' 'ead' string (default "both")
3029 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 Tells when the 'equalalways' option applies:
3031 ver vertically, width of windows is not affected
3032 hor horizontally, height of windows is not affected
3033 both width and height of windows is affected
3034
3035 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3036'edcompatible' 'ed' boolean (default off)
3037 global
3038 Makes the 'g' and 'c' flags of the ":substitute" command to be
3039 toggled each time the flag is given. See |complex-change|. See
3040 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003041 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003042 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043
Bram Moolenaar03413f42016-04-12 21:07:15 +02003044 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003045'emoji' 'emo' boolean (default: on)
3046 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003047 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003048 This excludes "text emoji" characters, which are normally displayed as
3049 single width. Unfortunately there is no good specification for this
3050 and it has been determined on trial-and-error basis. Use the
3051 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003052
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003054'encoding' 'enc' string (default for MS-Windows: "utf-8",
3055 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 Sets the character encoding used inside Vim. It applies to text in
3058 the buffers, registers, Strings in expressions, text stored in the
3059 viminfo file, etc. It sets the kind of characters which Vim can work
3060 with. See |encoding-names| for the possible values.
3061
3062 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003063 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003065 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066
Bram Moolenaar865242e2010-07-14 21:12:05 +02003067 This option cannot be set from a |modeline|. It would most likely
3068 corrupt the text.
3069
Bram Moolenaar3df01732017-02-17 22:47:16 +01003070 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3071 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 'encoding', "utf-8" is the natural choice for the environment and
3073 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003074 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 versions, and to avoid changing the encoding of newly created files
3076 without your knowledge (in case 'fileencodings' is empty).
3077
3078 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003079 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 iconv() or as specified with 'charconvert'.
3081
Bram Moolenaar207f0092020-08-30 17:20:20 +02003082 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003083 can use: >
3084 if has("multi_byte_encoding")
3085<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 Normally 'encoding' will be equal to your current locale. This will
3087 be the default if Vim recognizes your environment settings. If
3088 'encoding' is not set to the current locale, 'termencoding' must be
3089 set to convert typed and displayed text. See |encoding-table|.
3090
3091 When you set this option, it fires the |EncodingChanged| autocommand
3092 event so that you can set up fonts if necessary.
3093
3094 When the option is set, the value is converted to lowercase. Thus
3095 you can set it with uppercase values too. Underscores are translated
3096 to '-' signs.
3097 When the encoding is recognized, it is changed to the standard name.
3098 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3099 "iso-8859-2" and "utf8" becomes "utf-8".
3100
3101 Note: "latin1" is also used when the encoding could not be detected.
3102 This only works when editing files in the same encoding! When the
3103 actual character set is not latin1, make sure 'fileencoding' and
3104 'fileencodings' are empty. When conversion is needed, switch to using
3105 utf-8.
3106
3107 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3108 You don't notice this while editing, but it does matter for the
3109 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3110 setting 'encoding' to one of these values instead of utf-8 only has
3111 effect for encoding used for files when 'fileencoding' is empty.
3112
Bram Moolenaar661b1822005-07-28 22:36:45 +00003113 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3114 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003116 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003117'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003119 Indicates that a CTRL-Z character was found at the end of the file
3120 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003122 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003123 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003124 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003125
3126 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3127'endofline' 'eol' boolean (default on)
3128 local to buffer
3129 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003130 is on, or 'fixeol' option is off, no <EOL> will be written for the
3131 last line in the file. This option is automatically set or reset when
3132 starting to edit a new file, depending on whether file has an <EOL>
3133 for the last line in the file. Normally you don't have to set or
3134 reset this option.
3135 When 'binary' is off and 'fixeol' is on the value is not used when
3136 writing the file. When 'binary' is on or 'fixeol' is off it is used
3137 to remember the presence of a <EOL> for the last line in the file, so
3138 that when you write the file the situation from the original file can
3139 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003140 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141
3142 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3143'equalalways' 'ea' boolean (default on)
3144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003146 splitting or closing a window. This also happens the moment the
3147 option is switched on. When off, splitting a window will reduce the
3148 size of the current window and leave the other windows the same. When
3149 closing a window the extra lines are given to the window next to it
3150 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 When mixing vertically and horizontally split windows, a minimal size
3152 is computed and some windows may be larger if there is room. The
3153 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003154 Changing the height and width of a window can be avoided by setting
3155 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003156 If a window size is specified when creating a new window sizes are
3157 currently not equalized (it's complicated, but may be implemented in
3158 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159
3160 *'equalprg'* *'ep'*
3161'equalprg' 'ep' string (default "")
3162 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003164 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003165 or 'indentexpr'. When Vim was compiled without internal formatting,
3166 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003167 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 about including spaces and backslashes.
3169 This option cannot be set from a |modeline| or in the |sandbox|, for
3170 security reasons.
3171
3172 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3173'errorbells' 'eb' boolean (default off)
3174 global
3175 Ring the bell (beep or screen flash) for error messages. This only
3176 makes a difference for error messages, the bell will be used always
3177 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003178 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003179 screen flash or do nothing. See 'belloff' to finetune when to ring the
3180 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181
3182 *'errorfile'* *'ef'*
3183'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3184 others: "errors.err")
3185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 {not available when compiled without the |+quickfix|
3187 feature}
3188 Name of the errorfile for the QuickFix mode (see |:cf|).
3189 When the "-q" command-line argument is used, 'errorfile' is set to the
3190 following argument. See |-q|.
3191 NOT used for the ":make" command. See 'makeef' for that.
3192 Environment variables are expanded |:set_env|.
3193 See |option-backslash| about including spaces and backslashes.
3194 This option cannot be set from a |modeline| or in the |sandbox|, for
3195 security reasons.
3196
3197 *'errorformat'* *'efm'*
3198'errorformat' 'efm' string (default is very long)
3199 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 {not available when compiled without the |+quickfix|
3201 feature}
3202 Scanf-like description of the format for the lines in the error file
3203 (see |errorformat|).
3204
3205 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3206'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 Function keys that start with an <Esc> are recognized in Insert
3209 mode. When this option is off, the cursor and function keys cannot be
3210 used in Insert mode if they start with an <Esc>. The advantage of
3211 this is that the single <Esc> is recognized immediately, instead of
3212 after one second. Instead of resetting this option, you might want to
3213 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3214 when 'esckeys' is off, you can still map anything, but the cursor keys
3215 won't work by default.
3216 NOTE: This option is set to the Vi default value when 'compatible' is
3217 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003218 NOTE: when this option is off then the |modifyOtherKeys| functionality
3219 is disabled while in Insert mode to avoid ending Insert mode with any
3220 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221
3222 *'eventignore'* *'ei'*
3223'eventignore' 'ei' string (default "")
3224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003226 When set to "all" or when "all" is one of the items, all autocommand
3227 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003228 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 :set ei=WinEnter,WinLeave
3230<
3231 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3232'expandtab' 'et' boolean (default off)
3233 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003235 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3237 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003238 This option is reset when the 'paste' option is set and restored when
3239 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 NOTE: This option is reset when 'compatible' is set.
3241
3242 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3243'exrc' 'ex' boolean (default off)
3244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003246 directory.
3247
3248 Setting this option is a potential security leak. E.g., consider
3249 unpacking a package or fetching files from github, a .vimrc in there
3250 might be a trojan horse. BETTER NOT SET THIS OPTION!
3251 Instead, define an autocommand in your .vimrc to set options for a
3252 matching directory.
3253
3254 If you do switch this option on you should also consider setting the
3255 'secure' option (see |initialization|).
3256 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 This option cannot be set from a |modeline| or in the |sandbox|, for
3258 security reasons.
3259
3260 *'fileencoding'* *'fenc'* *E213*
3261'fileencoding' 'fenc' string (default: "")
3262 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003264
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003266 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 When 'fileencoding' is empty, the same value as 'encoding' will be
3268 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003269 No error will be given when the value is set, only when it is used,
3270 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003271 Conversion will also be done when 'encoding' and 'fileencoding' are
3272 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3273 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003275 'encoding' is "utf-8" or another Unicode encoding, conversion
3276 is most likely done in a way that the reverse conversion
3277 results in the same text. When 'encoding' is not "utf-8" some
3278 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003279
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 See 'encoding' for the possible values. Additionally, values may be
3281 specified that can be handled by the converter, see
3282 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003283
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 When reading a file 'fileencoding' will be set from 'fileencodings'.
3285 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003286 'fileencoding', use the |++enc| argument. One exception: when
3287 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003288 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003289
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3291 When the option is set, the value is converted to lowercase. Thus
3292 you can set it with uppercase values too. '_' characters are
3293 replaced with '-'. If a name is recognized from the list for
3294 'encoding', it is replaced by the standard name. For example
3295 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003296
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 When this option is set, after starting to edit a file, the 'modified'
3298 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003299
3300 Keep in mind that changing 'fenc' from a modeline happens
3301 AFTER the text has been read, thus it applies to when the file will be
3302 written. If you do set 'fenc' in a modeline, you might want to set
3303 'nomodified' to avoid not being able to ":q".
3304
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 This option can not be changed when 'modifiable' is off.
3306
3307 *'fe'*
3308 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003309 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 old short name was 'fe', which is no longer used.
3311
3312 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003313'fileencodings' 'fencs' string (default: "ucs-bom",
3314 "ucs-bom,utf-8,default,latin1" when
3315 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 This is a list of character encodings considered when starting to edit
3318 an existing file. When a file is read, Vim tries to use the first
3319 mentioned character encoding. If an error is detected, the next one
3320 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003321 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 an empty string, which means the value of 'encoding' is used.
3323 WARNING: Conversion can cause loss of information! When
3324 'encoding' is "utf-8" (or one of the other Unicode variants)
3325 conversion is most likely done in a way that the reverse
3326 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003327 "utf-8" some non-ASCII characters may be lost! You can use
3328 the |++bad| argument to specify what is done with characters
3329 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 For an empty file or a file with only ASCII characters most encodings
3331 will work and the first entry of 'fileencodings' will be used (except
3332 "ucs-bom", which requires the BOM to be present). If you prefer
3333 another encoding use an BufReadPost autocommand event to test if your
3334 preferred encoding is to be used. Example: >
3335 au BufReadPost * if search('\S', 'w') == 0 |
3336 \ set fenc=iso-2022-jp | endif
3337< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3338 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003339 When the |++enc| argument is used then the value of 'fileencodings' is
3340 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003341 Note that 'fileencodings' is not used for a new file, the global value
3342 of 'fileencoding' is used instead. You can set it with: >
3343 :setglobal fenc=iso-8859-2
3344< This means that a non-existing file may get a different encoding than
3345 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 The special value "ucs-bom" can be used to check for a Unicode BOM
3347 (Byte Order Mark) at the start of the file. It must not be preceded
3348 by "utf-8" or another Unicode encoding for this to work properly.
3349 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3350 because Vim cannot detect an error, thus the encoding is always
3351 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003352 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003353 environment. On MS-Windows this is the system encoding. Otherwise
3354 this is the default value for 'encoding'. It is useful when
3355 'encoding' is set to "utf-8" and your environment uses a non-latin1
3356 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003357 When 'encoding' is "utf-8" and a file contains an illegal byte
3358 sequence it won't be recognized as UTF-8. You can use the |8g8|
3359 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 WRONG VALUES: WHAT'S WRONG:
3361 latin1,utf-8 "latin1" will always be used
3362 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3363 file
3364 cp1250,latin1 "cp1250" will always be used
3365 If 'fileencodings' is empty, 'fileencoding' is not modified.
3366 See 'fileencoding' for the possible values.
3367 Setting this option does not have an effect until the next time a file
3368 is read.
3369
3370 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003371'fileformat' 'ff' string (MS-Windows default: "dos",
3372 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 This gives the <EOL> of the current buffer, which is used for
3375 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003376 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 unix <NL>
3378 mac <CR>
3379 When "dos" is used, CTRL-Z at the end of a file is ignored.
3380 See |file-formats| and |file-read|.
3381 For the character encoding of the file see 'fileencoding'.
3382 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003383 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 This option is set automatically when starting to edit a file and
3385 'fileformats' is not empty and 'binary' is off.
3386 When this option is set, after starting to edit a file, the 'modified'
3387 option is set, because the file would be different when written.
3388 This option can not be changed when 'modifiable' is off.
3389 For backwards compatibility: When this option is set to "dos",
3390 'textmode' is set, otherwise 'textmode' is reset.
3391
3392 *'fileformats'* *'ffs'*
3393'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003394 Vim+Vi MS-Windows: "dos,unix",
3395 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 Vi Cygwin: "unix,dos",
3397 Vi others: "")
3398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 This gives the end-of-line (<EOL>) formats that will be tried when
3400 starting to edit a new buffer and when reading a file into an existing
3401 buffer:
3402 - When empty, the format defined with 'fileformat' will be used
3403 always. It is not set automatically.
3404 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003405 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 'fileformats' name will be used when a file is read into an existing
3407 buffer, no matter what 'fileformat' for that buffer is set to.
3408 - When more than one name is present, separated by commas, automatic
3409 <EOL> detection will be done when reading a file. When starting to
3410 edit a file, a check is done for the <EOL>:
3411 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3412 'fileformat' is set to "dos".
3413 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003414 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003416 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3417 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003418 This means that "mac" is only chosen when:
3419 "unix" is not present or no <NL> is found in the file, and
3420 "dos" is not present or no <CR><NL> is found in the file.
3421 Except: if "unix" was chosen, but there is a <CR> before
3422 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003423 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 4. If 'fileformat' is still not set, the first name from
3425 'fileformats' is used.
3426 When reading a file into an existing buffer, the same is done, but
3427 this happens like 'fileformat' has been set appropriately for that
3428 file only, the option is not changed.
3429 When 'binary' is set, the value of 'fileformats' is not used.
3430
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003431 When Vim starts up with an empty buffer the first item is used. You
3432 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003433
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3435 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3436 done:
3437 - When 'fileformats' is empty, there is no automatic detection. Dos
3438 format will be used.
3439 - When 'fileformats' is set to one or more names, automatic detection
3440 is done. This is based on the first <NL> in the file: If there is a
3441 <CR> in front of it, Dos format is used, otherwise Unix format is
3442 used.
3443 Also see |file-formats|.
3444 For backwards compatibility: When this option is set to an empty
3445 string or one format (no comma is included), 'textauto' is reset,
3446 otherwise 'textauto' is set.
3447 NOTE: This option is set to the Vi default value when 'compatible' is
3448 set and to the Vim default value when 'compatible' is reset.
3449
Bram Moolenaarbf884932013-04-05 22:26:15 +02003450 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3451'fileignorecase' 'fic' boolean (default on for systems where case in file
3452 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003453 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003454 When set case is ignored when using file names and directories.
3455 See 'wildignorecase' for only ignoring case when doing completion.
3456
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 *'filetype'* *'ft'*
3458'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003459 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 When this option is set, the FileType autocommand event is triggered.
3461 All autocommands that match with the value of this option will be
3462 executed. Thus the value of 'filetype' is used in place of the file
3463 name.
3464 Otherwise this option does not always reflect the current file type.
3465 This option is normally set when the file type is detected. To enable
3466 this use the ":filetype on" command. |:filetype|
3467 Setting this option to a different value is most useful in a modeline,
3468 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003469 Example, for in an IDL file:
3470 /* vim: set filetype=idl : */ ~
3471 |FileType| |filetypes|
3472 When a dot appears in the value then this separates two filetype
3473 names. Example:
3474 /* vim: set filetype=c.doxygen : */ ~
3475 This will use the "c" filetype first, then the "doxygen" filetype.
3476 This works both for filetype plugins and for syntax files. More than
3477 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 This option is not copied to another buffer, independent of the 's' or
3479 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003480 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481
3482 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003483'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003484 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003485 {not available when compiled without the |+folding|
3486 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003487 Characters to fill the statuslines, vertical separators and special
3488 lines in the window.
3489 It is a comma-separated list of items. Each item has a name, a colon
3490 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003492 item name default Used for ~
3493 stl ' ' or '^' statusline of the current window
3494 stlnc ' ' or '=' statusline of the non-current windows
3495 vert '|' vertical separators |:vsplit|
3496 fold '-' filling 'foldtext'
3497 foldopen '-' mark the beginning of a fold
3498 foldclose '+' show a closed fold
3499 foldsep '|' open fold middle character
3500 diff '-' deleted lines of the 'diff' option
3501 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003502 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003504 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003505 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 otherwise.
3507
3508 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003509 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510< This is similar to the default, except that these characters will also
3511 be used when there is highlighting.
3512
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003513 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3514 single-byte and multibyte characters are supported. But double-width
3515 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003516
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003518 item name highlight group ~
3519 stl StatusLine |hl-StatusLine|
3520 stlnc StatusLineNC |hl-StatusLineNC|
3521 vert VertSplit |hl-VertSplit|
3522 fold Folded |hl-Folded|
3523 diff DiffDelete |hl-DiffDelete|
3524 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003525 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003527 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3528'fixendofline' 'fixeol' boolean (default on)
3529 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003530 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003531 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003532 preserve the situation from the original file.
3533 When the 'binary' option is set the value of this option doesn't
3534 matter.
3535 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003536 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003537
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003539'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 {only available when compiled with the |+rightleft|
3542 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003543 This option was for using Farsi, which has been removed. See
3544 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545
3546 *'foldclose'* *'fcl'*
3547'foldclose' 'fcl' string (default "")
3548 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 {not available when compiled without the |+folding|
3550 feature}
3551 When set to "all", a fold is closed when the cursor isn't in it and
3552 its level is higher than 'foldlevel'. Useful if you want folds to
3553 automatically close when moving out of them.
3554
3555 *'foldcolumn'* *'fdc'*
3556'foldcolumn' 'fdc' number (default 0)
3557 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 {not available when compiled without the |+folding|
3559 feature}
3560 When non-zero, a column with the specified width is shown at the side
3561 of the window which indicates open and closed folds. The maximum
3562 value is 12.
3563 See |folding|.
3564
3565 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3566'foldenable' 'fen' boolean (default on)
3567 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 {not available when compiled without the |+folding|
3569 feature}
3570 When off, all folds are open. This option can be used to quickly
3571 switch between showing all text unfolded and viewing the text with
3572 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003573 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 'foldenable' is off.
3575 This option is set by commands that create a new fold or close a fold.
3576 See |folding|.
3577
3578 *'foldexpr'* *'fde'*
3579'foldexpr' 'fde' string (default: "0")
3580 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003582 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003584 for each line to obtain its fold level. The context is set to the
3585 script where 'foldexpr' was set, script-local items can be accessed.
3586 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003587
Bram Moolenaar30b65812012-07-12 22:01:11 +02003588 The expression will be evaluated in the |sandbox| if set from a
3589 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003590 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003591 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003592
3593 It is not allowed to change text or jump to another window while
3594 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595
3596 *'foldignore'* *'fdi'*
3597'foldignore' 'fdi' string (default: "#")
3598 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 {not available when compiled without the |+folding|
3600 feature}
3601 Used only when 'foldmethod' is "indent". Lines starting with
3602 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003603 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 The default "#" works well for C programs. See |fold-indent|.
3605
3606 *'foldlevel'* *'fdl'*
3607'foldlevel' 'fdl' number (default: 0)
3608 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 {not available when compiled without the |+folding|
3610 feature}
3611 Sets the fold level: Folds with a higher level will be closed.
3612 Setting this option to zero will close all folds. Higher numbers will
3613 close fewer folds.
3614 This option is set by commands like |zm|, |zM| and |zR|.
3615 See |fold-foldlevel|.
3616
3617 *'foldlevelstart'* *'fdls'*
3618'foldlevelstart' 'fdls' number (default: -1)
3619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 {not available when compiled without the |+folding|
3621 feature}
3622 Sets 'foldlevel' when starting to edit another buffer in a window.
3623 Useful to always start editing with all folds closed (value zero),
3624 some folds closed (one) or no folds closed (99).
3625 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003626 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 ignores this option and closes all folds.
3628 It is also done before BufReadPre autocommands, to allow an autocmd to
3629 overrule the 'foldlevel' value for specific files.
3630 When the value is negative, it is not used.
3631
3632 *'foldmarker'* *'fmr'* *E536*
3633'foldmarker' 'fmr' string (default: "{{{,}}}")
3634 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 {not available when compiled without the |+folding|
3636 feature}
3637 The start and end marker used when 'foldmethod' is "marker". There
3638 must be one comma, which separates the start and end marker. The
3639 marker is a literal string (a regular expression would be too slow).
3640 See |fold-marker|.
3641
3642 *'foldmethod'* *'fdm'*
3643'foldmethod' 'fdm' string (default: "manual")
3644 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 {not available when compiled without the |+folding|
3646 feature}
3647 The kind of folding used for the current window. Possible values:
3648 |fold-manual| manual Folds are created manually.
3649 |fold-indent| indent Lines with equal indent form a fold.
3650 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3651 |fold-marker| marker Markers are used to specify folds.
3652 |fold-syntax| syntax Syntax highlighting items specify folds.
3653 |fold-diff| diff Fold text that is not changed.
3654
3655 *'foldminlines'* *'fml'*
3656'foldminlines' 'fml' number (default: 1)
3657 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658 {not available when compiled without the |+folding|
3659 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003660 Sets the number of screen lines above which a fold can be displayed
3661 closed. Also for manually closed folds. With the default value of
3662 one a fold can only be closed if it takes up two or more screen lines.
3663 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003664 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 "zc" to close a fold, which is displayed open because it's smaller
3666 than 'foldminlines', a following "zc" may close a containing fold.
3667
3668 *'foldnestmax'* *'fdn'*
3669'foldnestmax' 'fdn' number (default: 20)
3670 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 {not available when compiled without the |+folding|
3672 feature}
3673 Sets the maximum nesting of folds for the "indent" and "syntax"
3674 methods. This avoids that too many folds will be created. Using more
3675 than 20 doesn't work, because the internal limit is 20.
3676
3677 *'foldopen'* *'fdo'*
3678'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3679 search,tag,undo")
3680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 {not available when compiled without the |+folding|
3682 feature}
3683 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003684 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003686 NOTE: When the command is part of a mapping this option is not used.
3687 Add the |zv| command to the mapping to get the same effect.
3688 (rationale: the mapping may want to control opening folds itself)
3689
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 item commands ~
3691 all any
3692 block "(", "{", "[[", "[{", etc.
3693 hor horizontal movements: "l", "w", "fx", etc.
3694 insert any command in Insert mode
3695 jump far jumps: "G", "gg", etc.
3696 mark jumping to a mark: "'m", CTRL-O, etc.
3697 percent "%"
3698 quickfix ":cn", ":crew", ":make", etc.
3699 search search for a pattern: "/", "n", "*", "gd", etc.
3700 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003701 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 tag jumping to a tag: ":ta", CTRL-T, etc.
3703 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 When a movement command is used for an operator (e.g., "dl" or "y%")
3705 this option is not used. This means the operator will include the
3706 whole closed fold.
3707 Note that vertical movements are not here, because it would make it
3708 very difficult to move onto a closed fold.
3709 In insert mode the folds containing the cursor will always be open
3710 when text is inserted.
3711 To close folds you can re-apply 'foldlevel' with the |zx| command or
3712 set the 'foldclose' option to "all".
3713
3714 *'foldtext'* *'fdt'*
3715'foldtext' 'fdt' string (default: "foldtext()")
3716 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 {not available when compiled without the |+folding|
3718 feature}
3719 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003720 fold. The context is set to the script where 'foldexpr' was set,
3721 script-local items can be accessed. See |fold-foldtext| for the
3722 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723
Bram Moolenaar30b65812012-07-12 22:01:11 +02003724 The expression will be evaluated in the |sandbox| if set from a
3725 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003726 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003727
3728 It is not allowed to change text or jump to another window while
3729 evaluating 'foldtext' |textlock|.
3730
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003731 *'formatexpr'* *'fex'*
3732'formatexpr' 'fex' string (default "")
3733 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003734 {not available when compiled without the |+eval|
3735 feature}
3736 Expression which is evaluated to format a range of lines for the |gq|
3737 operator or automatic formatting (see 'formatoptions'). When this
3738 option is empty 'formatprg' is used.
3739
3740 The |v:lnum| variable holds the first line to be formatted.
3741 The |v:count| variable holds the number of lines to be formatted.
3742 The |v:char| variable holds the character that is going to be
3743 inserted if the expression is being evaluated due to
3744 automatic formatting. This can be empty. Don't insert
3745 it yet!
3746
3747 Example: >
3748 :set formatexpr=mylang#Format()
3749< This will invoke the mylang#Format() function in the
3750 autoload/mylang.vim file in 'runtimepath'. |autoload|
3751
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003752 The advantage of using a function call without arguments is that it is
3753 faster, see |expr-option-function|.
3754
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003755 The expression is also evaluated when 'textwidth' is set and adding
3756 text beyond that limit. This happens under the same conditions as
3757 when internal formatting is used. Make sure the cursor is kept in the
3758 same spot relative to the text then! The |mode()| function will
3759 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003760
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003761 When the expression evaluates to non-zero Vim will fall back to using
3762 the internal format mechanism.
3763
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003764 If the expression starts with s: or |<SID>|, then it is replaced with
3765 the script ID (|local-function|). Example: >
3766 set formatexpr=s:MyFormatExpr()
3767 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003768< Otherwise, the expression is evaluated in the context of the script
3769 where the option was set, thus script-local items are available.
3770
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003771 The expression will be evaluated in the |sandbox| when set from a
3772 modeline, see |sandbox-option|. That stops the option from working,
3773 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003774 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003775 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003776
Bram Moolenaar86b68352004-12-27 21:59:20 +00003777 *'formatlistpat'* *'flp'*
3778'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3779 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003780 A pattern that is used to recognize a list header. This is used for
3781 the "n" flag in 'formatoptions'.
3782 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003783 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003784 while still checking more characters. There must be a character
3785 following the pattern, when it matches the whole line it is handled
3786 like there is no match.
3787 The default recognizes a number, followed by an optional punctuation
3788 character and white space.
3789
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003790 *'formatoptions'* *'fo'*
3791'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3792 local to buffer
3793 This is a sequence of letters which describes how automatic
3794 formatting is to be done. See |fo-table|. When the 'paste' option is
3795 on, no formatting is done (like 'formatoptions' is empty). Commas can
3796 be inserted for readability.
3797 To avoid problems with flags that are added in the future, use the
3798 "+=" and "-=" feature of ":set" |add-option-flags|.
3799 NOTE: This option is set to the Vi default value when 'compatible' is
3800 set and to the Vim default value when 'compatible' is reset.
3801
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 *'formatprg'* *'fp'*
3803'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003806 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003808 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003809 If the 'formatexpr' option is not empty it will be used instead.
3810 Otherwise, if 'formatprg' option is an empty string, the internal
3811 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003812 Environment variables are expanded |:set_env|. See |option-backslash|
3813 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003814 This option cannot be set from a |modeline| or in the |sandbox|, for
3815 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816
Bram Moolenaard94464e2015-11-02 15:28:18 +01003817 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003818'fsync' 'fs' boolean (default on)
3819 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003820 When on, the library function fsync() will be called after writing a
3821 file. This will flush a file to disk, ensuring that it is safely
3822 written even on filesystems which do metadata-only journaling. This
3823 will force the harddrive to spin up on Linux systems running in laptop
3824 mode, so it may be undesirable in some situations. Be warned that
3825 turning this off increases the chances of data loss after a crash. On
3826 systems without an fsync() implementation, this variable is always
3827 off.
3828 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003829 'fsync' also applies to |writefile()| (unless a flag is used to
3830 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003831 This option cannot be set from a |modeline| or in the |sandbox|, for
3832 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003833
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3835'gdefault' 'gd' boolean (default off)
3836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 When on, the ":substitute" flag 'g' is default on. This means that
3838 all matches in a line are substituted instead of one. When a 'g' flag
3839 is given to a ":substitute" command, this will toggle the substitution
3840 of all or one match. See |complex-change|.
3841
3842 command 'gdefault' on 'gdefault' off ~
3843 :s/// subst. all subst. one
3844 :s///g subst. one subst. all
3845 :s///gg subst. all subst. one
3846
3847 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003848 DEPRECATED: Setting this option may break plugins that are not aware
3849 of this option. Also, many users get confused that adding the /g flag
3850 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003851 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852
3853 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003854'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 Format to recognize for the ":grep" command output.
3857 This is a scanf-like string that uses the same format as the
3858 'errorformat' option: see |errorformat|.
3859
3860 *'grepprg'* *'gp'*
3861'grepprg' 'gp' string (default "grep -n ",
3862 Unix: "grep -n $* /dev/null",
3863 Win32: "findstr /n" or "grep -n",
3864 VMS: "SEARCH/NUMBERS ")
3865 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003866 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 and '#' characters, which are expanded like when used in a command-
3868 line. The placeholder "$*" is allowed to specify where the arguments
3869 will be included. Environment variables are expanded |:set_env|. See
3870 |option-backslash| about including spaces and backslashes.
3871 When your "grep" accepts the "-H" argument, use this to make ":grep"
3872 also work well with a single file: >
3873 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003874< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003875 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3876 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003877 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 apply equally to 'grepprg'.
3879 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3880 otherwise it's "grep -n".
3881 This option cannot be set from a |modeline| or in the |sandbox|, for
3882 security reasons.
3883
3884 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3885'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3886 ve:ver35-Cursor,
3887 o:hor50-Cursor,
3888 i-ci:ver25-Cursor/lCursor,
3889 r-cr:hor20-Cursor/lCursor,
3890 sm:block-Cursor
3891 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003892 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 "n-v-c:block,o:hor50,i-ci:hor15,
3894 r-cr:hor30,sm:block")
3895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003897 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003899 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003900 height of the cursor can be changed. This can be done by specifying a
3901 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003902 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3903 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003905 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 mode-list and an argument-list:
3907 mode-list:argument-list,mode-list:argument-list,..
3908 The mode-list is a dash separated list of these modes:
3909 n Normal mode
3910 v Visual mode
3911 ve Visual mode with 'selection' "exclusive" (same as 'v',
3912 if not specified)
3913 o Operator-pending mode
3914 i Insert mode
3915 r Replace mode
3916 c Command-line Normal (append) mode
3917 ci Command-line Insert mode
3918 cr Command-line Replace mode
3919 sm showmatch in Insert mode
3920 a all modes
3921 The argument-list is a dash separated list of these arguments:
3922 hor{N} horizontal bar, {N} percent of the character height
3923 ver{N} vertical bar, {N} percent of the character width
3924 block block cursor, fills the whole character
3925 [only one of the above three should be present]
3926 blinkwait{N} *cursor-blinking*
3927 blinkon{N}
3928 blinkoff{N}
3929 blink times for cursor: blinkwait is the delay before
3930 the cursor starts blinking, blinkon is the time that
3931 the cursor is shown and blinkoff is the time that the
3932 cursor is not shown. The times are in msec. When one
3933 of the numbers is zero, there is no blinking. The
3934 default is: "blinkwait700-blinkon400-blinkoff250".
3935 These numbers are used for a missing entry. This
3936 means that blinking is enabled by default. To switch
3937 blinking off you can use "blinkon0". The cursor only
3938 blinks when Vim is waiting for input, not while
3939 executing a command.
3940 To make the cursor blink in an xterm, see
3941 |xterm-blink|.
3942 {group-name}
3943 a highlight group name, that sets the color and font
3944 for the cursor
3945 {group-name}/{group-name}
3946 Two highlight group names, the first is used when
3947 no language mappings are used, the other when they
3948 are. |language-mapping|
3949
3950 Examples of parts:
3951 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3952 block cursor with colors from the "nCursor"
3953 highlight group
3954 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3955 In Insert and Command-line Insert mode, use a
3956 30% vertical bar cursor with colors from the
3957 "iCursor" highlight group. Blink a bit
3958 faster.
3959
3960 The 'a' mode is different. It will set the given argument-list for
3961 all modes. It does not reset anything to defaults. This can be used
3962 to do a common setting for all modes. For example, to switch off
3963 blinking: "a:blinkon0"
3964
3965 Examples of cursor highlighting: >
3966 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3967 :highlight Cursor gui=NONE guifg=bg guibg=fg
3968<
3969 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003970 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971'guifont' 'gfn' string (default "")
3972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 {only available when compiled with GUI enabled}
3974 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003975 In its simplest form the value is just one font name.
3976 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977
3978 *'guifontset'* *'gfs'*
3979 *E250* *E252* *E234* *E597* *E598*
3980'guifontset' 'gfs' string (default "")
3981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 {only available when compiled with GUI enabled and
3983 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003984 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 When not empty, specifies two (or more) fonts to be used. The first
3986 one for normal English, the second one for your special language. See
3987 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003988
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3990'guifontwide' 'gfw' string (default "")
3991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 {only available when compiled with GUI enabled}
3993 When not empty, specifies a comma-separated list of fonts to be used
3994 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003995 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003996
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 *'guiheadroom'* *'ghr'*
3998'guiheadroom' 'ghr' number (default 50)
3999 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004000 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 The number of pixels subtracted from the screen height when fitting
4002 the GUI window on the screen. Set this before the GUI is started,
4003 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004004 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 lines will be left for window decorations and other items on the
4006 screen. Set it to a negative value to allow windows taller than the
4007 screen.
4008
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004009 *'guiligatures'* *'gli'* *E1243*
4010'guiligatures' 'gli' string (default "")
4011 global
4012 {only for GTK GUI}
4013 List of ASCII characters that, when combined together, can create more
4014 complex shapes. Each character must be a printable ASCII character
4015 with a value in the 32-127 range.
4016 Example: >
4017 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4018< Changing this option updates screen output immediately. Set it to an
4019 empty string to disable ligatures.
4020
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004022'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4023 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004024 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004025 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004028 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 sequence of letters which describes what components and options of the
4030 GUI should be used.
4031 To avoid problems with flags that are added in the future, use the
4032 "+=" and "-=" feature of ":set" |add-option-flags|.
4033
Bram Moolenaar13568252018-03-16 20:46:58 +01004034 Valid characters are as follows:
4035 *'go-!'*
4036 '!' External commands are executed in a terminal window. Without
4037 this flag the MS-Windows GUI will open a console window to
4038 execute the command. The Unix GUI will simulate a dumb
4039 terminal to list the command output.
4040 The terminal window will be positioned at the bottom, and grow
4041 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004042 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 'a' Autoselect: If present, then whenever VISUAL mode is started,
4044 or the Visual area extended, Vim tries to become the owner of
4045 the windowing system's global selection. This means that the
4046 Visually highlighted text is available for pasting into other
4047 applications as well as into Vim itself. When the Visual mode
4048 ends, possibly due to an operation on the text, or when an
4049 application wants to paste the selection, the highlighted text
4050 is automatically yanked into the "* selection register.
4051 Thus the selection is still available for pasting into other
4052 applications after the VISUAL mode has ended.
4053 If not present, then Vim won't become the owner of the
4054 windowing system's global selection unless explicitly told to
4055 by a yank or delete operation for the "* register.
4056 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004057 *'go-P'*
4058 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004059 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004060 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004061 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 applies to the modeless selection.
4063
4064 'guioptions' autoselect Visual autoselect modeless ~
4065 "" - -
4066 "a" yes yes
4067 "A" - yes
4068 "aA" yes yes
4069
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004070 When using a terminal see the 'clipboard' option.
4071
Bram Moolenaar02467872007-05-06 13:22:01 +00004072 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 'c' Use console dialogs instead of popup dialogs for simple
4074 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004075 *'go-d'*
4076 'd' Use dark theme variant if available. Currently only works for
4077 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004078 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004079 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004080 'guitablabel' can be used to change the text in the labels.
4081 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004082 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004083 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004084 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 'f' Foreground: Don't use fork() to detach the GUI from the shell
4086 where it was started. Use this for programs that wait for the
4087 editor to finish (e.g., an e-mail program). Alternatively you
4088 can use "gvim -f" or ":gui -f" to start the GUI in the
4089 foreground. |gui-fork|
4090 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004091 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004092 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4094 corner of the window. It's black&white on non-GTK, because of
4095 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004096 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004098 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004099 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004101 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004103 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004104 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 'g' Grey menu items: Make menu items that are not active grey. If
4106 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004107 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 't' Include tearoff menu items. Currently only works for Win32,
4109 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004110 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004111 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4112 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004113 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004115 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 'R' Right-hand scrollbar is present when there is a vertically
4117 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004118 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004120 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 'L' Left-hand scrollbar is present when there is a vertically
4122 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004123 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4125 the longest visible line, or on the cursor line if the 'h'
4126 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004127 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 'h' Limit horizontal scrollbar size to the length of the cursor
4129 line. Reduces computations. |gui-horiz-scroll|
4130
4131 And yes, you may even have scrollbars on the left AND the right if
4132 you really want to :-). See |gui-scrollbars| for more information.
4133
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004134 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 'v' Use a vertical button layout for dialogs. When not included,
4136 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004137 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004138 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 'p' Use Pointer callbacks for X11 GUI. This is required for some
4140 window managers. If the cursor is not blinking or hollow at
4141 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004142 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004144 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004145 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004146 *'go-k'*
4147 'k' Keep the GUI window size when adding/removing a scrollbar, or
4148 toolbar, tabline, etc. Instead, the behavior is similar to
4149 when the window is maximized and will adjust 'lines' and
4150 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004151 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004152 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004153
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 *'guipty'* *'noguipty'*
4155'guipty' boolean (default on)
4156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 {only available when compiled with GUI enabled}
4158 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4159 I/O to/from shell commands. See |gui-pty|.
4160
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004161 *'guitablabel'* *'gtl'*
4162'guitablabel' 'gtl' string (default empty)
4163 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004164 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004165 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004166 pages line. When empty and when the result is empty Vim will use a
4167 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004168
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004169 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004170 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004171 The expression will be evaluated in the |sandbox| when set from a
4172 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004173 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004174
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004175 Only used when the GUI tab pages line is displayed. 'e' must be
4176 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4177 used.
4178
Bram Moolenaar57657d82006-04-21 22:12:41 +00004179 *'guitabtooltip'* *'gtt'*
4180'guitabtooltip' 'gtt' string (default empty)
4181 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004182 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004183 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004184 pages line. When empty Vim will use a default tooltip.
4185 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004186 You can include a line break. Simplest method is to use |:let|: >
4187 :let &guitabtooltip = "line one\nline two"
4188<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004189
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004191'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 (others) "$VIMRUNTIME/doc/help.txt")
4193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 Name of the main help file. All distributed help files should be
4195 placed together in one directory. Additionally, all "doc" directories
4196 in 'runtimepath' will be used.
4197 Environment variables are expanded |:set_env|. For example:
4198 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004199 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 spaces and backslashes.
4201 This option cannot be set from a |modeline| or in the |sandbox|, for
4202 security reasons.
4203
4204 *'helpheight'* *'hh'*
4205'helpheight' 'hh' number (default 20)
4206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 Minimal initial height of the help window when it is opened with the
4208 ":help" command. The initial height of the help window is half of the
4209 current window, or (when the 'ea' option is on) the same as other
4210 windows. When the height is less than 'helpheight', the height is
4211 set to 'helpheight'. Set to zero to disable.
4212
4213 *'helplang'* *'hlg'*
4214'helplang' 'hlg' string (default: messages language or empty)
4215 global
4216 {only available when compiled with the |+multi_lang|
4217 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004218 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 for which the desired help can be found. The English help will always
4220 be used as a last resort. You can add "en" to prefer English over
4221 another language, but that will only find tags that exist in that
4222 language and not in the English help.
4223 Example: >
4224 :set helplang=de,it
4225< This will first search German, then Italian and finally English help
4226 files.
4227 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4228 try to find the tag in the current language before using this option.
4229 See |help-translated|.
4230
4231 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4232'hidden' 'hid' boolean (default off)
4233 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 When off a buffer is unloaded when it is |abandon|ed. When on a
4235 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4236 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004237
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004239 hidden even if the 'hidden' option is off when these three are true:
4240 - the buffer is modified
4241 - 'autowrite' is off or writing is not possible
4242 - the '!' flag was used
4243 Also see |windows.txt|.
4244
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004245 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 This option is set for one command with ":hide {command}" |:hide|.
4247 WARNING: It's easy to forget that you have changes in hidden buffers.
4248 Think twice when using ":q!" or ":qa!".
4249
4250 *'highlight'* *'hl'*
4251'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004252 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4253 d:Directory,e:ErrorMsg,i:IncSearch,
4254 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004255 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004256 N:CursorLineNr,r:Question,s:StatusLine,
4257 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004258 v:Visual,V:VisualNOS,w:WarningMsg,
4259 W:WildMenu,f:Folded,F:FoldColumn,
4260 A:DiffAdd,C:DiffChange,D:DiffDelete,
4261 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004262 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004263 L:SpellLocal,+:Pmenu,=:PmenuSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004264 [:PmenuKind,]:PmenuKindSel,
4265 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004266 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4267 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004268 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004269 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004272 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004274 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004276 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4277 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 characters from 'showbreak'
4279 |hl-Directory| d directories in CTRL-D listing and other special
4280 things in listings
4281 |hl-ErrorMsg| e error messages
4282 h (obsolete, ignored)
4283 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004284 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4286 |hl-MoreMsg| m |more-prompt|
4287 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004288 |hl-LineNr| n line number for ":number" and ":#" commands, and
4289 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004290 |hl-LineNrAbove| a line number above the cursor for when the
4291 'relativenumber' option is set.
4292 |hl-LineNrBelow| b line number below the cursor for when the
4293 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004294 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4295 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 |hl-Question| r |hit-enter| prompt and yes/no questions
4297 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004298 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4300 |hl-VertSplit| c column used to separate vertically split windows
4301 |hl-Visual| v Visual mode
4302 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4303 Selection" Only X11 Gui's |gui-x11| and
4304 |xterm-clipboard|.
4305 |hl-WarningMsg| w warning messages
4306 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4307 |hl-Folded| f line used for closed folds
4308 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004309 |hl-DiffAdd| A added line in diff mode
4310 |hl-DiffChange| C changed line in diff mode
4311 |hl-DiffDelete| D deleted line in diff mode
4312 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004314 |hl-Conceal| - the placeholders used for concealed characters
4315 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004316 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004317 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004318 |hl-SpellRare| R rare word |spell|
4319 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004320 |hl-Pmenu| + popup menu normal line
4321 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004322 |hl-PmenuKind| [ popup menu "kind" normal line
4323 |hl-PmenuKindSel| ] popup menu "kind" selected line
4324 |hl-PmenuExtra| { popup menu "kind" normal line
4325 |hl-PmenuExtraSel| } popup menu "kind" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004326 |hl-PmenuSbar| x popup menu scrollbar
4327 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328
4329 The display modes are:
4330 r reverse (termcap entry "mr" and "me")
4331 i italic (termcap entry "ZH" and "ZR")
4332 b bold (termcap entry "md" and "me")
4333 s standout (termcap entry "so" and "se")
4334 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004335 c undercurl (termcap entry "Us" and "Ce")
4336 2 double underline (termcap entry "Ds" and "Ce")
4337 d dotted underline (termcap entry "ds" and "Ce")
4338 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004339 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 n no highlighting
4341 - no highlighting
4342 : use a highlight group
4343 The default is used for occasions that are not included.
4344 If you want to change what the display modes do, see |dos-colors|
4345 for an example.
4346 When using the ':' display mode, this must be followed by the name of
4347 a highlight group. A highlight group can be used to define any type
4348 of highlighting, including using color. See |:highlight| on how to
4349 define one. The default uses a different group for each occasion.
4350 See |highlight-default| for the default highlight groups.
4351
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004353'history' 'hi' number (Vim default: 50, Vi default: 0,
4354 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004357 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004359 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 NOTE: This option is set to the Vi default value when 'compatible' is
4361 set and to the Vim default value when 'compatible' is reset.
4362
4363 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4364'hkmap' 'hk' boolean (default off)
4365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 {only available when compiled with the |+rightleft|
4367 feature}
4368 When on, the keyboard is mapped for the Hebrew character set.
4369 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4370 toggle this option. See |rileft.txt|.
4371 NOTE: This option is reset when 'compatible' is set.
4372
4373 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4374'hkmapp' 'hkp' boolean (default off)
4375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 {only available when compiled with the |+rightleft|
4377 feature}
4378 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4379 This is useful if you have a non-Hebrew keyboard.
4380 See |rileft.txt|.
4381 NOTE: This option is reset when 'compatible' is set.
4382
Bram Moolenaar036986f2017-03-16 17:41:02 +01004383 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4384'hlsearch' 'hls' boolean (default off)
4385 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004386 {not available when compiled without the
4387 |+extra_search| feature}
4388 When there is a previous search pattern, highlight all its matches.
4389 The type of highlighting used can be set with the 'l' occasion in the
4390 'highlight' option. This uses the "Search" highlight group by
4391 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004392 are not applied. If the "CurSearch" highlight group is set then the
4393 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004394 See also: 'incsearch' and |:match|.
4395 When you get bored looking at the highlighted matches, you can turn it
4396 off with |:nohlsearch|. This does not change the option value, as
4397 soon as you use a search command, the highlighting comes back.
4398 'redrawtime' specifies the maximum time spent on finding matches.
4399 When the search pattern can match an end-of-line, Vim will try to
4400 highlight all of the matched text. However, this depends on where the
4401 search starts. This will be the first line in the window or the first
4402 line below a closed fold. A match in a previous line which is not
4403 drawn may not continue in a newly drawn line.
4404 You can specify whether the highlight status is restored on startup
4405 with the 'h' flag in 'viminfo' |viminfo-h|.
4406 NOTE: This option is reset when 'compatible' is set.
4407
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 *'icon'* *'noicon'*
4409'icon' boolean (default off, on when title can be restored)
4410 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 When on, the icon text of the window will be set to the value of
4412 'iconstring' (if it is not empty), or to the name of the file
4413 currently being edited. Only the last part of the name is used.
4414 Overridden by the 'iconstring' option.
4415 Only works if the terminal supports setting window icons (currently
4416 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4417 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4418 builtin termcap).
4419 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004420 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004422 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423
4424 *'iconstring'*
4425'iconstring' string (default "")
4426 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 When this option is not empty, it will be used for the icon text of
4428 the window. This happens only when the 'icon' option is on.
4429 Only works if the terminal supports setting window icon text
4430 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004431 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 When Vim was compiled with HAVE_X11 defined, the original icon will be
4433 restored if possible |X11|.
4434 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004435 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004437 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 {not available when compiled without the |+statusline| feature}
4439
4440 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4441'ignorecase' 'ic' boolean (default off)
4442 global
4443 Ignore case in search patterns. Also used when searching in the tags
4444 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004445 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 Can be overruled by using "\c" or "\C" in the pattern, see
4447 |/ignorecase|.
4448
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004449 *'imactivatefunc'* *'imaf'*
4450'imactivatefunc' 'imaf' string (default "")
4451 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004452 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004453 activate or deactivate the Input Method. The value can be the name of
4454 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4455 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004456 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004457 The expression will be evaluated in the |sandbox| when set from a
4458 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004459
4460 Example: >
4461 function ImActivateFunc(active)
4462 if a:active
4463 ... do something
4464 else
4465 ... do something
4466 endif
4467 " return value is not used
4468 endfunction
4469 set imactivatefunc=ImActivateFunc
4470<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 *'imactivatekey'* *'imak'*
4472'imactivatekey' 'imak' string (default "")
4473 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004475 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 Specifies the key that your Input Method in X-Windows uses for
4477 activation. When this is specified correctly, vim can fully control
4478 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4479 You can't use this option to change the activation key, the option
4480 tells Vim what the key is.
4481 Format:
4482 [MODIFIER_FLAG-]KEY_STRING
4483
4484 These characters can be used for MODIFIER_FLAG (case is ignored):
4485 S Shift key
4486 L Lock key
4487 C Control key
4488 1 Mod1 key
4489 2 Mod2 key
4490 3 Mod3 key
4491 4 Mod4 key
4492 5 Mod5 key
4493 Combinations are allowed, for example "S-C-space" or "SC-space" are
4494 both shift+ctrl+space.
4495 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4496
4497 Example: >
4498 :set imactivatekey=S-space
4499< "S-space" means shift+space. This is the activation key for kinput2 +
4500 canna (Japanese), and ami (Korean).
4501
4502 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4503'imcmdline' 'imc' boolean (default off)
4504 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 When set the Input Method is always on when starting to edit a command
4506 line, unless entering a search pattern (see 'imsearch' for that).
4507 Setting this option is useful when your input method allows entering
4508 English characters directly, e.g., when it's used to type accented
4509 characters with dead keys.
4510
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004511 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4513 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 When set the Input Method is never used. This is useful to disable
4515 the IM when it doesn't work properly.
4516 Currently this option is on by default for SGI/IRIX machines. This
4517 may change in later releases.
4518
4519 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004520'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 Specifies whether :lmap or an Input Method (IM) is to be used in
4523 Insert mode. Valid values:
4524 0 :lmap is off and IM is off
4525 1 :lmap is ON and IM is off
4526 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 To always reset the option to zero when leaving Insert mode with <Esc>
4528 this can be used: >
4529 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4530< This makes :lmap and IM turn off automatically when leaving Insert
4531 mode.
4532 Note that this option changes when using CTRL-^ in Insert mode
4533 |i_CTRL-^|.
4534 The value is set to 1 when setting 'keymap' to a valid keymap name.
4535 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004536 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 methods. Use 'imdisable' to disable XIM then.
4538
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004539 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004540 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004541 |+multi_byte_ime| or |global-ime|.
4542
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004544'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 Specifies whether :lmap or an Input Method (IM) is to be used when
4547 entering a search pattern. Valid values:
4548 -1 the value of 'iminsert' is used, makes it look like
4549 'iminsert' is also used when typing a search pattern
4550 0 :lmap is off and IM is off
4551 1 :lmap is ON and IM is off
4552 2 :lmap is off and IM is ON
4553 Note that this option changes when using CTRL-^ in Command-line mode
4554 |c_CTRL-^|.
4555 The value is set to 1 when it is not -1 and setting the 'keymap'
4556 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004557 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 methods. Use 'imdisable' to disable XIM then.
4559
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004560 *'imstatusfunc'* *'imsf'*
4561'imstatusfunc' 'imsf' string (default "")
4562 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004563 This option specifies a function that is called to obtain the status
4564 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004565 The value can be the name of a function, a |lambda| or a |Funcref|.
4566 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004567 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004568
4569 Example: >
4570 function ImStatusFunc()
4571 let is_active = ...do something
4572 return is_active ? 1 : 0
4573 endfunction
4574 set imstatusfunc=ImStatusFunc
4575<
4576 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004577 The expression will be evaluated in the |sandbox| when set from a
4578 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004579
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004580 *'imstyle'* *'imst'*
4581'imstyle' 'imst' number (default 1)
4582 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004583 {only available when compiled with |+xim| and
4584 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004585 This option specifies the input style of Input Method:
4586 0 use on-the-spot style
4587 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004588 See: |xim-input-style|
4589
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004590 For a long time on-the-spot style had been used in the GTK version of
4591 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004592 |single-repeat|, etc. Therefore over-the-spot style becomes the
4593 default now. This should work fine for most people, however if you
4594 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004595 The expression will be evaluated in the |sandbox| when set from a
4596 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004597
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 *'include'* *'inc'*
4599'include' 'inc' string (default "^\s*#\s*include")
4600 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 {not available when compiled without the
4602 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004603 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 pattern, just like for the "/" command (See |pattern|). The default
4605 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004606 "]I", "[d", etc.
4607 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004608 comes after the matched pattern. But if "\zs" appears in the pattern
4609 then the text matched from "\zs" to the end, or until "\ze" if it
4610 appears, is used as the file name. Use this to include characters
4611 that are not in 'isfname', such as a space. You can then use
4612 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004613 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614
4615 *'includeexpr'* *'inex'*
4616'includeexpr' 'inex' string (default "")
4617 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004619 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004621 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004622 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004624 Note the double backslash: the `:set` command first halves them, then
4625 one remains it the value, where "\." matches a dot literally. For
4626 simple character replacements `tr()` avoids the need for escaping: >
4627 :setlocal includeexpr=tr(v:fname,'.','/')
4628<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004630 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 Also used for |<cfile>|.
4632
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004633 If the expression starts with s: or |<SID>|, then it is replaced with
4634 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004635 setlocal includeexpr=s:MyIncludeExpr()
4636 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004637< Otherwise, the expression is evaluated in the context of the script
4638 where the option was set, thus script-local items are available.
4639
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004640 It is more efficient if the value is just a function call without
4641 arguments, see |expr-option-function|.
4642
Bram Moolenaar30b65812012-07-12 22:01:11 +02004643 The expression will be evaluated in the |sandbox| when set from a
4644 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004645 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004646
4647 It is not allowed to change text or jump to another window while
4648 evaluating 'includeexpr' |textlock|.
4649
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004651'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004652 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004655 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004656 While typing a search command, show where the pattern, as it was typed
4657 so far, matches. The matched string is highlighted. If the pattern
4658 is invalid or not found, nothing is shown. The screen will be updated
4659 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004660 Also applies to the pattern in commands: >
4661 :global
4662 :lvimgrep
4663 :lvimgrepadd
4664 :smagic
4665 :snomagic
4666 :sort
4667 :substitute
4668 :vglobal
4669 :vimgrep
4670 :vimgrepadd
4671< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004672 original position when no match is found and when pressing <Esc>. You
4673 still need to finish the search command with <Enter> to move the
4674 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004675 You can use the CTRL-G and CTRL-T keys to move to the next and
4676 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004677 When compiled with the |+reltime| feature Vim only searches for about
4678 half a second. With a complicated pattern and/or a lot of text the
4679 match may not be found. This is to avoid that Vim hangs while you
4680 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004681 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004682 When 'hlsearch' is on, all matched strings are highlighted too while
4683 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004684 If you don't want to turn 'hlsearch' on, but want to highlight all
4685 matches while searching, you can turn on and off 'hlsearch' with
4686 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004687 augroup vimrc-incsearch-highlight
4688 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004689 autocmd CmdlineEnter /,\? :set hlsearch
4690 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004691 augroup END
4692<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004693 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004694 to the command line. If 'ignorecase' and 'smartcase' are set and the
4695 command line has no uppercase characters, the added character is
4696 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004697 CTRL-R CTRL-W can be used to add the word at the end of the current
4698 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 NOTE: This option is reset when 'compatible' is set.
4700
4701 *'indentexpr'* *'inde'*
4702'indentexpr' 'inde' string (default "")
4703 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004704 {not available when compiled without the |+eval|
4705 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 Expression which is evaluated to obtain the proper indent for a line.
4707 It is used when a new line is created, for the |=| operator and
4708 in Insert mode as specified with the 'indentkeys' option.
4709 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004710 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004711 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 When 'paste' is set this option is not used for indenting.
4713 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004714 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004716
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004717 If the expression starts with s: or |<SID>|, then it is replaced with
4718 the script ID (|local-function|). Example: >
4719 set indentexpr=s:MyIndentExpr()
4720 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004721< Otherwise, the expression is evaluated in the context of the script
4722 where the option was set, thus script-local items are available.
4723
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004724 The advantage of using a function call without arguments is that it is
4725 faster, see |expr-option-function|.
4726
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 The expression must return the number of spaces worth of indent. It
4728 can return "-1" to keep the current indent (this means 'autoindent' is
4729 used for the indent).
4730 Functions useful for computing the indent are |indent()|, |cindent()|
4731 and |lispindent()|.
4732 The evaluation of the expression must not have side effects! It must
4733 not change the text, jump to another window, etc. Afterwards the
4734 cursor position is always restored, thus the cursor may be moved.
4735 Normally this option would be set to call a function: >
4736 :set indentexpr=GetMyIndent()
4737< Error messages will be suppressed, unless the 'debug' option contains
4738 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004739 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004740 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741
Bram Moolenaar30b65812012-07-12 22:01:11 +02004742 The expression will be evaluated in the |sandbox| when set from a
4743 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004744 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004745
4746 It is not allowed to change text or jump to another window while
4747 evaluating 'indentexpr' |textlock|.
4748
4749
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004751'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 A list of keys that, when typed in Insert mode, cause reindenting of
4754 the current line. Only happens if 'indentexpr' isn't empty.
4755 The format is identical to 'cinkeys', see |indentkeys-format|.
4756 See |C-indenting| and |indent-expression|.
4757
4758 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4759'infercase' 'inf' boolean (default off)
4760 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004762 'ignorecase' is also on, the case of the match is adjusted depending
4763 on the typed text. If the typed text contains a lowercase letter
4764 where the match has an upper case letter, the completed part is made
4765 lowercase. If the typed text has no lowercase letters and the match
4766 has a lowercase letter where the typed text has an uppercase letter,
4767 and there is a letter before it, the completed part is made uppercase.
4768 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769
4770 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4771'insertmode' 'im' boolean (default off)
4772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 Makes Vim work in a way that Insert mode is the default mode. Useful
4774 if you want to use Vim as a modeless editor. Used for |evim|.
4775 These Insert mode commands will be useful:
4776 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004777 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 this is a mapping, it is executed as if 'insertmode' was off.
4779 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004781 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4782 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783
4784 These items change when 'insertmode' is set:
4785 - when starting to edit of a file, Vim goes to Insert mode.
4786 - <Esc> in Insert mode is a no-op and beeps.
4787 - <Esc> in Normal mode makes Vim go to Insert mode.
4788 - CTRL-L in Insert mode is a command, it is not inserted.
4789 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4790 However, when <Esc> is used inside a mapping, it behaves like
4791 'insertmode' was not set. This was done to be able to use the same
4792 mappings with 'insertmode' set or not set.
4793 When executing commands with |:normal| 'insertmode' is not used.
4794
4795 NOTE: This option is reset when 'compatible' is set.
4796
4797 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004798'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4800 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4801 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4802 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4803 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 The characters specified by this option are included in file names and
4806 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004807 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 Multi-byte characters 256 and above are always included, only the
4809 characters up to 255 are specified with this option.
4810 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004811 Think twice before adding white space to this option. Although a
4812 space may appear inside a file name, the effect will be that Vim
4813 doesn't know where a file name starts or ends when doing completion.
4814 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815
4816 Note that on systems using a backslash as path separator, Vim tries to
4817 do its best to make it work as you would expect. That is a bit
4818 tricky, since Vi originally used the backslash to escape special
4819 characters. Vim will not remove a backslash in front of a normal file
4820 name character on these systems, but it will on Unix and alikes. The
4821 '&' and '^' are not included by default, because these are special for
4822 cmd.exe.
4823
4824 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004825 Each part can be a single character number or a range. A range is two
4826 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827 decimal number between 0 and 255 or the ASCII character itself (does
4828 not work for digits). Example:
4829 "_,-,128-140,#-43" (include '_' and '-' and the range
4830 128 to 140 and '#' to 43)
4831 If a part starts with '^', the following character number or range
4832 will be excluded from the option. The option is interpreted from left
4833 to right. Put the excluded character after the range where it is
4834 included. To include '^' itself use it as the last character of the
4835 option or the end of a range. Example:
4836 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4837 If the character is '@', all characters where isalpha() returns TRUE
4838 are included. Normally these are the characters a to z and A to Z,
4839 plus accented characters. To include '@' itself use "@-@". Examples:
4840 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004841 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 "a-z,A-Z,@-@" All letters plus the '@' character.
4843 A comma can be included by using it where a character number is
4844 expected. Example:
4845 "48-57,,,_" Digits, comma and underscore.
4846 A comma can be excluded by prepending a '^'. Example:
4847 " -~,^,,9" All characters from space to '~', excluding
4848 comma, plus <Tab>.
4849 See |option-backslash| about including spaces and backslashes.
4850
4851 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004852'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 "@,48-57,_,128-167,224-235"
4854 otherwise: "@,48-57,_,192-255")
4855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 The characters given by this option are included in identifiers.
4857 Identifiers are used in recognizing environment variables and after a
4858 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004859 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004860 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004862 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4864
4865 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004866'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 "@,48-57,_,128-167,224-235"
4868 otherwise: "@,48-57,_,192-255"
4869 Vi default: "@,48-57,_")
4870 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004872 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004873 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004874 characters above 255 check the "word" character class (any character
4875 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004876 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 For a help file it is set to all non-blank printable characters except
4878 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4879 command).
4880 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004881 This option also influences syntax highlighting, unless the syntax
4882 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 NOTE: This option is set to the Vi default value when 'compatible' is
4884 set and to the Vim default value when 'compatible' is reset.
4885
4886 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004887'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 "@,~-255"; otherwise: "@,161-255")
4889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 The characters given by this option are displayed directly on the
4891 screen. It is also used for "\p" in a |pattern|. The characters from
4892 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4893 even when they are not included in 'isprint' or excluded. See
4894 'isfname' for a description of the format of this option.
4895
4896 Non-printable characters are displayed with two characters:
4897 0 - 31 "^@" - "^_"
4898 32 - 126 always single characters
4899 127 "^?"
4900 128 - 159 "~@" - "~_"
4901 160 - 254 "| " - "|~"
4902 255 "~?"
4903 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4904 displayed as <xx>, with the hexadecimal value of the byte.
4905 When 'display' contains "uhex" all unprintable characters are
4906 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004907 The SpecialKey highlighting will be used for unprintable characters.
4908 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909
4910 Multi-byte characters 256 and above are always included, only the
4911 characters up to 255 are specified with this option. When a character
4912 is printable but it is not available in the current font, a
4913 replacement character will be shown.
4914 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4915 There is no option to specify these characters.
4916
4917 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4918'joinspaces' 'js' boolean (default on)
4919 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 Insert two spaces after a '.', '?' and '!' with a join command.
4921 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4922 Otherwise only one space is inserted.
4923 NOTE: This option is set when 'compatible' is set.
4924
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004925 *'jumpoptions'* *'jop'*
4926'jumpoptions' 'jop' string (default "")
4927 global
4928 List of words that change the behavior of the |jumplist|.
4929 stack Make the jumplist behave like the tagstack.
4930 Relative location of entries in the jumplist is
4931 preserved at the cost of discarding subsequent entries
4932 when navigating backwards in the jumplist and then
4933 jumping to a location. |jumplist-stack|
4934
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 *'key'*
4936'key' string (default "")
4937 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004938 {only available when compiled with the |+cryptv|
4939 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004941 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 Careful: Do not set the key value by hand, someone might see the typed
4943 key. Use the |:X| command. But you can make 'key' empty: >
4944 :set key=
4945< It is not possible to get the value of this option with ":set key" or
4946 "echo &key". This is to avoid showing it to someone who shouldn't
4947 know. It also means you cannot see it yourself once you have set it,
4948 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004949 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4950 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004951 You can use "&key" in an expression to detect whether encryption is
4952 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953
4954 *'keymap'* *'kmp'* *E544*
4955'keymap' 'kmp' string (default "")
4956 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 {only available when compiled with the |+keymap|
4958 feature}
4959 Name of a keyboard mapping. See |mbyte-keymap|.
4960 Setting this option to a valid keymap name has the side effect of
4961 setting 'iminsert' to one, so that the keymap becomes effective.
4962 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004963 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964
4965 *'keymodel'* *'km'*
4966'keymodel' 'km' string (default "")
4967 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004968 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 can do. These values can be used:
4970 startsel Using a shifted special key starts selection (either
4971 Select mode or Visual mode, depending on "key" being
4972 present in 'selectmode').
4973 stopsel Using a not-shifted special key stops selection.
4974 Special keys in this context are the cursor keys, <End>, <Home>,
4975 <PageUp> and <PageDown>.
4976 The 'keymodel' option is set by the |:behave| command.
4977
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004978 *'keyprotocol'* *'kpc'*
4979'keyprotocol' 'kpc' string (default: see below)
4980 global
4981 Specifies what keyboard protocol to use depending on the value of
4982 'term'. The supported keyboard protocols names are:
4983 none whatever the terminal uses
4984 mok2 modifyOtherKeys level 2, as supported by xterm
4985 kitty Kitty keyboard protocol, as supported by Kitty
4986
Bram Moolenaara87749e2022-11-30 10:23:17 +00004987 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004988 a pattern that is matched against the 'term' option, a colon and the
4989 protocol name to be used. To illustrate this, the default value would
4990 be set with: >
4991 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
4992
4993< This means that when 'term' contains "kitty, "foot" or "wezterm"
4994 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00004995 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004996
4997 The first match is used, thus if you want to have "kitty" use the
4998 kitty protocol, but "badkitty" not, then you should match "badkitty"
4999 first and use the "none" value: >
5000 set keyprotocol=badkitty:none,kitty:kitty
5001<
5002 The option is used after 'term' has been changed. First the termcap
5003 entries are set, possibly using the builtin list, see |builtin-terms|.
5004 Then this option is inspected and if there is a match and a protocol
5005 is specified the following happens:
5006 none Nothing, the regular t_TE and t_TI values remain
5007
5008 mok2 The t_TE value is changed to:
5009 CSI >4;m disables modifyOtherKeys
5010 The t_TI value is changed to:
5011 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005012 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005013
5014 kitty The t_TE value is changed to:
5015 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005016 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005017 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005018 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005019 CSI ?u request kitty keyboard protocol state
5020 CSI >c request the termresponse
5021
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005022 If you notice problems, such as characters being displayed that
5023 disappear after `CTRL-L`, you might want to try making this option
5024 empty. Then set the 'term' option to have it take effect: >
5025 set keyprotocol=
5026 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005027<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005028
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029 *'keywordprg'* *'kp'*
5030'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005031 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 Program to use for the |K| command. Environment variables are
5034 expanded |:set_env|. ":help" may be used to access the Vim internal
5035 help. (Note that previously setting the global option to the empty
5036 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005037 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005038 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005039 When "man", "man -s" or an Ex command is used, Vim will automatically
5040 translate a count for the "K" command and pass it as the first
5041 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 See |option-backslash| about including spaces and backslashes.
5043 Example: >
5044 :set keywordprg=man\ -s
5045< This option cannot be set from a |modeline| or in the |sandbox|, for
5046 security reasons.
5047
5048 *'langmap'* *'lmap'* *E357* *E358*
5049'langmap' 'lmap' string (default "")
5050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 {only available when compiled with the |+langmap|
5052 feature}
5053 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005054 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005055 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 care of translating these special characters to the original meaning
5057 of the key. This means you don't have to change the keyboard mode to
5058 be able to execute Normal mode commands.
5059 This is the opposite of the 'keymap' option, where characters are
5060 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005061 Also consider setting 'langremap' to off, to prevent 'langmap' from
5062 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005063 This option cannot be set from a |modeline| or in the |sandbox|, for
5064 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005066 Example (for Greek, in UTF-8): *greek* >
5067 :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 +00005068< Example (exchanges meaning of z and y for commands): >
5069 :set langmap=zy,yz,ZY,YZ
5070<
5071 The 'langmap' option is a list of parts, separated with commas. Each
5072 part can be in one of two forms:
5073 1. A list of pairs. Each pair is a "from" character immediately
5074 followed by the "to" character. Examples: "aA", "aAbBcC".
5075 2. A list of "from" characters, a semi-colon and a list of "to"
5076 characters. Example: "abc;ABC"
5077 Example: "aA,fgh;FGH,cCdDeE"
5078 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005079 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080
5081 This will allow you to activate vim actions without having to switch
5082 back and forth between the languages. Your language characters will
5083 be understood as normal vim English characters (according to the
5084 langmap mappings) in the following cases:
5085 o Normal/Visual mode (commands, buffer/register names, user mappings)
5086 o Insert/Replace Mode: Register names after CTRL-R
5087 o Insert/Replace Mode: Mappings
5088 Characters entered in Command-line mode will NOT be affected by
5089 this option. Note that this option can be changed at any time
5090 allowing to switch between mappings for different languages/encodings.
5091 Use a mapping to avoid having to type it each time!
5092
5093 *'langmenu'* *'lm'*
5094'langmenu' 'lm' string (default "")
5095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 {only available when compiled with the |+menu| and
5097 |+multi_lang| features}
5098 Language to use for menu translation. Tells which file is loaded
5099 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005100 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101< (without the spaces). For example, to always use the Dutch menus, no
5102 matter what $LANG is set to: >
5103 :set langmenu=nl_NL.ISO_8859-1
5104< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005105 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 If your $LANG is set to a non-English language but you do want to use
5107 the English menus: >
5108 :set langmenu=none
5109< This option must be set before loading menus, switching on filetype
5110 detection or syntax highlighting. Once the menus are defined setting
5111 this option has no effect. But you could do this: >
5112 :source $VIMRUNTIME/delmenu.vim
5113 :set langmenu=de_DE.ISO_8859-1
5114 :source $VIMRUNTIME/menu.vim
5115< Warning: This deletes all menus that you defined yourself!
5116
Bram Moolenaard94464e2015-11-02 15:28:18 +01005117 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005118'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005119 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005120 {only available when compiled with the |+langmap|
5121 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005122 This is just like 'langremap' but with the value inverted. It only
5123 exists for backwards compatibility. When setting 'langremap' then
5124 'langnoremap' is set to the inverted value, and the other way around.
5125
5126 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005127'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005128 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005129 {only available when compiled with the |+langmap|
5130 feature}
5131 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005132 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005133 'langmap' disables some of your mappings, try resetting this option.
5134 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005135 that works for you to avoid mappings to break.
5136
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 *'laststatus'* *'ls'*
5138'laststatus' 'ls' number (default 1)
5139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 The value of this option influences when the last window will have a
5141 status line:
5142 0: never
5143 1: only if there are at least two windows
5144 2: always
5145 The screen looks nicer with a status line if you have several
5146 windows, but it takes another screen line. |status-line|
5147
5148 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5149'lazyredraw' 'lz' boolean (default off)
5150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 When this option is set, the screen will not be redrawn while
5152 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005153 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005155 This may occasionally cause display errors. It is only meant to be set
5156 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005157 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158
5159 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5160'linebreak' 'lbr' boolean (default off)
5161 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005162 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005164 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 than at the last character that fits on the screen. Unlike
5166 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005167 it only affects the way the file is displayed, not its contents.
5168 If 'breakindent' is set, line is visually indented. Then, the value
5169 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005170 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 Note that <Tab> characters after an <EOL> are mostly not displayed
5172 with the right amount of white space.
5173
5174 *'lines'* *E593*
5175'lines' number (default 24 or terminal height)
5176 global
5177 Number of lines of the Vim window.
5178 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005179 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 When Vim is running in the GUI or in a resizable window, setting this
5181 option will cause the window size to be changed. When you only want
5182 to use the size for the GUI, put the command in your |gvimrc| file.
5183 Vim limits the number of lines to what fits on the screen. You can
5184 use this command to get the tallest window possible: >
5185 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005186< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005187 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 When you set this option and Vim is unable to change the physical
5189 number of lines of the display, the display may be messed up.
5190
5191 *'linespace'* *'lsp'*
5192'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 {only in the GUI}
5195 Number of pixel lines inserted between characters. Useful if the font
5196 uses the full character cell height, making lines touch each other.
5197 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005198 With some fonts there can be too much room between lines (to have
5199 space for ascents and descents). Then it makes sense to set
5200 'linespace' to a negative value. This may cause display problems
5201 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202
5203 *'lisp'* *'nolisp'*
5204'lisp' boolean (default off)
5205 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 Lisp mode: When <Enter> is typed in insert mode set the indent for
5207 the next line to Lisp standards (well, sort of). Also happens with
5208 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5209 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5210 better. Also see 'lispwords'.
5211 The '-' character is included in keyword characters. Redefines the
5212 "=" operator to use this same indentation algorithm rather than
5213 calling an external program if 'equalprg' is empty.
5214 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005216 *'lispoptions'* *'lop'*
5217'lispoptions' 'lop' string (default "")
5218 local to buffer
5219 Comma-separated list of items that influence the Lisp indenting when
5220 enabled with the |'lisp'| option. Currently only one item is
5221 supported:
5222 expr:1 use 'indentexpr' for Lisp indenting when it is set
5223 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5224 Note that when using 'indentexpr' the `=` operator indents all the
5225 lines, otherwise the first line is not indented (Vi-compatible).
5226
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 *'lispwords'* *'lw'*
5228'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005229 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005230 Comma-separated list of words that influence the Lisp indenting when
5231 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232
5233 *'list'* *'nolist'*
5234'list' boolean (default off)
5235 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005236 List mode: By default show tabs as CTRL-I is displayed, display $
5237 after end of line. Useful to see the difference between tabs and
5238 spaces and for trailing blanks. Further changed by the 'listchars'
5239 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005240
5241 The cursor is displayed at the start of the space a Tab character
5242 occupies, not at the end as usual in Normal mode. To get this cursor
5243 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005244 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005245<
5246 Note that list mode will also affect formatting (set with 'textwidth'
5247 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 changing the way tabs are displayed.
5249
5250 *'listchars'* *'lcs'*
5251'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005252 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005253 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005254 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005255 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 eol:c Character to show at the end of each line. When
5257 omitted, there is no extra character at the end of the
5258 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005259 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005260 tab:xy[z] Two or three characters to be used to show a tab.
5261 The third character is optional.
5262
5263 tab:xy The 'x' is always used, then 'y' as many times as will
5264 fit. Thus "tab:>-" displays:
5265 >
5266 >-
5267 >--
5268 etc.
5269
5270 tab:xyz The 'z' is always used, then 'x' is prepended, and
5271 then 'y' is used as many times as will fit. Thus
5272 "tab:<->" displays:
5273 >
5274 <>
5275 <->
5276 <-->
5277 etc.
5278
5279 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005280 *lcs-space*
5281 space:c Character to show for a space. When omitted, spaces
5282 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005283 *lcs-multispace*
5284 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005285 One or more characters to use cyclically to show for
5286 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005287 setting, except for single spaces. When omitted, the
5288 "space" setting is used. For example,
5289 `:set listchars=multispace:---+` shows ten consecutive
5290 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005291 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005292 *lcs-lead*
5293 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005294 leading spaces are blank. Overrides the "space" and
5295 "multispace" settings for leading spaces. You can
5296 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005297 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005298< *lcs-leadmultispace*
5299 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005300 Like the |lcs-multispace| value, but for leading
5301 spaces only. Also overrides |lcs-lead| for leading
5302 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005303 `:set listchars=leadmultispace:---+` shows ten
5304 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005305 ---+---+--XXX ~
5306 Where "XXX" denotes the first non-blank characters in
5307 the line.
5308 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005309 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005310 trailing spaces are blank. Overrides the "space" and
5311 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005312 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 extends:c Character to show in the last column, when 'wrap' is
5314 off and the line continues beyond the right of the
5315 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005316 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005317 precedes:c Character to show in the first visible column of the
5318 physical line, when there is text preceding the
5319 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005320 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005321 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005322 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005323 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005324 nbsp:c Character to show for a non-breakable space character
5325 (0xA0 (160 decimal) and U+202F). Left blank when
5326 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005328 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005330 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005332 Each character can be specified as hex: >
5333 set listchars=eol:\\x24
5334 set listchars=eol:\\u21b5
5335 set listchars=eol:\\U000021b5
5336< Note that a double backslash is used. The number of hex characters
5337 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5338
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339 Examples: >
5340 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005341 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 :set lcs=extends:>,precedes:<
5343< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005344 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5345 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005346 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347
5348 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5349'loadplugins' 'lpl' boolean (default on)
5350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 When on the plugin scripts are loaded when starting up |load-plugins|.
5352 This option can be reset in your |vimrc| file to disable the loading
5353 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005354 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5355 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356
Bram Moolenaard94464e2015-11-02 15:28:18 +01005357 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005358'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005359 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005360 {only available when compiled with the |+lua/dyn|
5361 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005362 Specifies the name of the Lua shared library. The default is
5363 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005364 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005365 This option cannot be set from a |modeline| or in the |sandbox|, for
5366 security reasons.
5367
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005368 *'macatsui'* *'nomacatsui'*
5369'macatsui' boolean (default on)
5370 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005371 {not supported}
5372 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005373
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 *'magic'* *'nomagic'*
5375'magic' boolean (default on)
5376 global
5377 Changes the special characters that can be used in search patterns.
5378 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005379 WARNING: Switching this option off most likely breaks plugins! That
5380 is because many patterns assume it's on and will fail when it's off.
5381 Only switch it off when working with old Vi scripts. In any other
5382 situation write patterns that work when 'magic' is on. Include "\M"
5383 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005384 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5385 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386
5387 *'makeef'* *'mef'*
5388'makeef' 'mef' string (default: "")
5389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 {not available when compiled without the |+quickfix|
5391 feature}
5392 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5393 and the |:grep| command.
5394 When it is empty, an internally generated temp file will be used.
5395 When "##" is included, it is replaced by a number to make the name
5396 unique. This makes sure that the ":make" command doesn't overwrite an
5397 existing file.
5398 NOT used for the ":cf" command. See 'errorfile' for that.
5399 Environment variables are expanded |:set_env|.
5400 See |option-backslash| about including spaces and backslashes.
5401 This option cannot be set from a |modeline| or in the |sandbox|, for
5402 security reasons.
5403
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005404 *'makeencoding'* *'menc'*
5405'makeencoding' 'menc' string (default "")
5406 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005407 Encoding used for reading the output of external commands. When empty,
5408 encoding is not converted.
5409 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5410 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5411 and `:laddfile`.
5412
5413 This would be mostly useful when you use MS-Windows and set 'encoding'
5414 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5415 'makeencoding' to "char" has the same effect as setting to the system
5416 locale encoding. Example: >
5417 :set encoding=utf-8
5418 :set makeencoding=char " system locale is used
5419<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 *'makeprg'* *'mp'*
5421'makeprg' 'mp' string (default "make", VMS: "MMS")
5422 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005423 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005424 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5425 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005426 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005427 Environment variables are expanded |:set_env|. See |option-backslash|
5428 about including spaces and backslashes.
5429 Note that a '|' must be escaped twice: once for ":set" and once for
5430 the interpretation of a command. When you use a filter called
5431 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 :set makeprg=gmake\ \\\|\ myfilter
5433< The placeholder "$*" can be given (even multiple times) to specify
5434 where the arguments will be included, for example: >
5435 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5436< This option cannot be set from a |modeline| or in the |sandbox|, for
5437 security reasons.
5438
5439 *'matchpairs'* *'mps'*
5440'matchpairs' 'mps' string (default "(:),{:},[:]")
5441 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005443 other.
5444 Only character pairs are allowed that are different, thus you cannot
5445 jump between two double quotes.
5446 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005447 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005448 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 :set mps+=<:>
5450
5451< A more exotic example, to jump between the '=' and ';' in an
5452 assignment, useful for languages like C and Java: >
5453 :au FileType c,cpp,java set mps+==:;
5454
5455< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005456 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457
5458 *'matchtime'* *'mat'*
5459'matchtime' 'mat' number (default 5)
5460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 Tenths of a second to show the matching paren, when 'showmatch' is
5462 set. Note that this is not in milliseconds, like other options that
5463 set a time. This is to be compatible with Nvi.
5464
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005465 *'maxcombine'* *'mco'*
5466'maxcombine' 'mco' number (default 2)
5467 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005468 The maximum number of combining characters supported for displaying.
5469 Only used when 'encoding' is "utf-8".
5470 The default is OK for most languages. Hebrew may require 4.
5471 Maximum value is 6.
5472 Even when this option is set to 2 you can still edit text with more
5473 combining characters, you just can't see them. Use |g8| or |ga|.
5474 See |mbyte-combining|.
5475
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 *'maxfuncdepth'* *'mfd'*
5477'maxfuncdepth' 'mfd' number (default 100)
5478 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005479 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005480 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 Maximum depth of function calls for user functions. This normally
5482 catches endless recursion. When using a recursive function with
5483 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5484 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005485 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005486 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 See also |:function|.
5488
5489 *'maxmapdepth'* *'mmd'* *E223*
5490'maxmapdepth' 'mmd' number (default 1000)
5491 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 Maximum number of times a mapping is done without resulting in a
5493 character to be used. This normally catches endless mappings, like
5494 ":map x y" with ":map y x". It still does not catch ":map g wg",
5495 because the 'w' is used before the next mapping is done. See also
5496 |key-mapping|.
5497
5498 *'maxmem'* *'mm'*
5499'maxmem' 'mm' number (default between 256 to 5120 (system
5500 dependent) or half the amount of memory
5501 available)
5502 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5504 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005505 other memory to be freed.
5506 The maximum usable value is about 2000000. Use this to work without a
5507 limit.
5508 The value is ignored when 'swapfile' is off.
5509 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005511 *'maxmempattern'* *'mmp'*
5512'maxmempattern' 'mmp' number (default 1000)
5513 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005514 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005515 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005516 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005517 When Vim runs into the limit it gives an error message and mostly
5518 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005519 Running into the limit often means that the pattern is very
5520 inefficient or too complex. This may already happen with the pattern
5521 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005522 Might also happen on redraw, when syntax rules try to match a complex
5523 text structure.
5524 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5525 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005526
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527 *'maxmemtot'* *'mmt'*
5528'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5529 dependent) or half the amount of memory
5530 available)
5531 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005532 Maximum amount of memory in Kbyte to use for all buffers together.
5533 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005534 without a limit.
5535 On 64 bit machines higher values might work. But hey, do you really
5536 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005537 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005538 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005539 Buffers with 'swapfile' off still count to the total amount of memory
5540 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005541 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542
5543 *'menuitems'* *'mis'*
5544'menuitems' 'mis' number (default 25)
5545 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 {not available when compiled without the |+menu|
5547 feature}
5548 Maximum number of items to use in a menu. Used for menus that are
5549 generated from a list of items, e.g., the Buffers menu. Changing this
5550 option has no direct effect, the menu must be refreshed first.
5551
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005552 *'mkspellmem'* *'msm'*
5553'mkspellmem' 'msm' string (default "460000,2000,500")
5554 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005555 {not available when compiled without the |+syntax|
5556 feature}
5557 Parameters for |:mkspell|. This tunes when to start compressing the
5558 word tree. Compression can be slow when there are many words, but
5559 it's needed to avoid running out of memory. The amount of memory used
5560 per word depends very much on how similar the words are, that's why
5561 this tuning is complicated.
5562
5563 There are three numbers, separated by commas:
5564 {start},{inc},{added}
5565
5566 For most languages the uncompressed word tree fits in memory. {start}
5567 gives the amount of memory in Kbyte that can be used before any
5568 compression is done. It should be a bit smaller than the amount of
5569 memory that is available to Vim.
5570
5571 When going over the {start} limit the {inc} number specifies the
5572 amount of memory in Kbyte that can be allocated before another
5573 compression is done. A low number means compression is done after
5574 less words are added, which is slow. A high number means more memory
5575 will be allocated.
5576
5577 After doing compression, {added} times 1024 words can be added before
5578 the {inc} limit is ignored and compression is done when any extra
5579 amount of memory is needed. A low number means there is a smaller
5580 chance of hitting the {inc} limit, less memory is used but it's
5581 slower.
5582
5583 The languages for which these numbers are important are Italian and
5584 Hungarian. The default works for when you have about 512 Mbyte. If
5585 you have 1 Gbyte you could use: >
5586 :set mkspellmem=900000,3000,800
5587< If you have less than 512 Mbyte |:mkspell| may fail for some
5588 languages, no matter what you set 'mkspellmem' to.
5589
Bram Moolenaar07607392019-05-26 19:20:43 +02005590 This option cannot be set from a |modeline| or in the |sandbox|.
5591
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005593'modeline' 'ml' boolean (Vim default: on (off for root),
5594 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005596 If 'modeline' is on 'modelines' gives the number of lines that is
5597 checked for set commands. If 'modeline' is off or 'modelines' is zero
5598 no lines are checked. See |modeline|.
5599
5600 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5601'modelineexpr' 'mle' boolean (default: off)
5602 global
5603 When on allow some options that are an expression to be set in the
5604 modeline. Check the option for whether it is affected by
5605 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005606 This option cannot be set from a |modeline| or in the |sandbox|, for
5607 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005608
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 *'modelines'* *'mls'*
5610'modelines' 'mls' number (default 5)
5611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 If 'modeline' is on 'modelines' gives the number of lines that is
5613 checked for set commands. If 'modeline' is off or 'modelines' is zero
5614 no lines are checked. See |modeline|.
5615 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5616 set and to the Vim default value when 'compatible' is reset.
5617
5618 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005619 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620'modifiable' 'ma' boolean (default on)
5621 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 When off the buffer contents cannot be changed. The 'fileformat' and
5623 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005624 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625
5626 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5627'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005628 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 When on, the buffer is considered to be modified. This option is set
5630 when:
5631 1. A change was made to the text since it was last written. Using the
5632 |undo| command to go back to the original text will reset the
5633 option. But undoing changes that were made before writing the
5634 buffer will set the option again, since the text is different from
5635 when it was written.
5636 2. 'fileformat' or 'fileencoding' is different from its original
5637 value. The original value is set when the buffer is read or
5638 written. A ":set nomodified" command also resets the original
5639 values to the current values and the 'modified' option will be
5640 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005641 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005642 This option is not set when a change is made to the buffer as the
5643 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5644 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5645 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5647 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005648 Note that the text may actually be the same, e.g. 'modified' is set
5649 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650
5651 *'more'* *'nomore'*
5652'more' boolean (Vim default: on, Vi default: off)
5653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 When on, listings pause when the whole screen is filled. You will get
5655 the |more-prompt|. When this option is off there are no pauses, the
5656 listing continues until finished.
5657 NOTE: This option is set to the Vi default value when 'compatible' is
5658 set and to the Vim default value when 'compatible' is reset.
5659
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005660 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005661'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005662 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005664 Enable the use of the mouse. Works for most terminals (xterm, Win32
5665 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5666 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5667 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005668 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 v Visual mode
5670 i Insert mode
5671 c Command-line mode
5672 h all previous modes when editing a help file
5673 a all previous modes
5674 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005675 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005677< If your terminal can't overrule the mouse events going to the
5678 application, use: >
5679 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005680< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005681 back to Vim using the mouse events.
5682 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5683 "xterm".
5684
5685 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 modeless selection. This doesn't move the text cursor.
5687
5688 See |mouse-using|. Also see |'clipboard'|.
5689
5690 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005691 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 the mouse buttons can still be used by keeping the shift key pressed.
5693 Also see the 'clipboard' option.
5694
5695 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5696'mousefocus' 'mousef' boolean (default off)
5697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 {only works in the GUI}
5699 The window that the mouse pointer is on is automatically activated.
5700 When changing the window layout or window focus in another way, the
5701 mouse pointer is moved to the window with keyboard focus. Off is the
5702 default because it makes using the pull down menus a little goofy, as
5703 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005704 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005705 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706
5707 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5708'mousehide' 'mh' boolean (default on)
5709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 {only works in the GUI}
5711 When on, the mouse pointer is hidden when characters are typed.
5712 The mouse pointer is restored when the mouse is moved.
5713
5714 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005715'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 Sets the model to use for the mouse. The name mostly specifies what
5718 the right mouse button is used for:
5719 extend Right mouse button extends a selection. This works
5720 like in an xterm.
5721 popup Right mouse button pops up a menu. The shifted left
5722 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005723 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 popup_setpos Like "popup", but the cursor will be moved to the
5725 position where the mouse was clicked, and thus the
5726 selected operation will act upon the clicked object.
5727 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005728 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 course, that right clicking outside a selection will
5730 end Visual mode.
5731 Overview of what button does what for each model:
5732 mouse extend popup(_setpos) ~
5733 left click place cursor place cursor
5734 left drag start selection start selection
5735 shift-left search word extend selection
5736 right click extend selection popup menu (place cursor)
5737 right drag extend selection -
5738 middle click paste paste
5739
5740 In the "popup" model the right mouse button produces a pop-up menu.
5741 You need to define this first, see |popup-menu|.
5742
5743 Note that you can further refine the meaning of buttons with mappings.
5744 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5745 selection (because that's handled in the GUI code directly).
5746
5747 The 'mousemodel' option is set by the |:behave| command.
5748
Bram Moolenaar938ae282023-02-20 20:44:55 +00005749 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005750'mousemoveevent' 'mousemev' boolean (default off)
5751 global
5752 {only works in the GUI}
5753 When on, mouse move events are delivered to the input queue and are
5754 available for mapping. The default, off, avoids the mouse movement
5755 overhead except when needed. See |gui-mouse-mapping|.
5756 Warning: Setting this option can make pending mappings to be aborted
5757 when the mouse is moved.
5758 Currently only works in the GUI, may be made to work in a terminal
5759 later.
5760
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005762'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5763 vs:leftright,vd:lrsizing,m:no,
5764 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 {only available when compiled with the |+mouseshape|
5767 feature}
5768 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005769 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 like used for 'guicursor'. Each part consist of a mode/location-list
5771 and an argument-list:
5772 mode-list:shape,mode-list:shape,..
5773 The mode-list is a dash separated list of these modes/locations:
5774 In a normal window: ~
5775 n Normal mode
5776 v Visual mode
5777 ve Visual mode with 'selection' "exclusive" (same as 'v',
5778 if not specified)
5779 o Operator-pending mode
5780 i Insert mode
5781 r Replace mode
5782
5783 Others: ~
5784 c appending to the command-line
5785 ci inserting in the command-line
5786 cr replacing in the command-line
5787 m at the 'Hit ENTER' or 'More' prompts
5788 ml idem, but cursor in the last line
5789 e any mode, pointer below last window
5790 s any mode, pointer on a status line
5791 sd any mode, while dragging a status line
5792 vs any mode, pointer on a vertical separator line
5793 vd any mode, while dragging a vertical separator line
5794 a everywhere
5795
5796 The shape is one of the following:
5797 avail name looks like ~
5798 w x arrow Normal mouse pointer
5799 w x blank no pointer at all (use with care!)
5800 w x beam I-beam
5801 w x updown up-down sizing arrows
5802 w x leftright left-right sizing arrows
5803 w x busy The system's usual busy pointer
5804 w x no The system's usual 'no input' pointer
5805 x udsizing indicates up-down resizing
5806 x lrsizing indicates left-right resizing
5807 x crosshair like a big thin +
5808 x hand1 black hand
5809 x hand2 white hand
5810 x pencil what you write with
5811 x question big ?
5812 x rightup-arrow arrow pointing right-up
5813 w x up-arrow arrow pointing up
5814 x <number> any X11 pointer number (see X11/cursorfont.h)
5815
5816 The "avail" column contains a 'w' if the shape is available for Win32,
5817 x for X11.
5818 Any modes not specified or shapes not available use the normal mouse
5819 pointer.
5820
5821 Example: >
5822 :set mouseshape=s:udsizing,m:no
5823< will make the mouse turn to a sizing arrow over the status lines and
5824 indicate no input when the hit-enter prompt is displayed (since
5825 clicking the mouse has no effect in this state.)
5826
5827 *'mousetime'* *'mouset'*
5828'mousetime' 'mouset' number (default 500)
5829 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005830 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 time in msec between two mouse clicks for the second click to be
5832 recognized as a multi click.
5833
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005834 *'mzschemedll'*
5835'mzschemedll' string (default depends on the build)
5836 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005837 {only available when compiled with the |+mzscheme/dyn|
5838 feature}
5839 Specifies the name of the MzScheme shared library. The default is
5840 DYNAMIC_MZSCH_DLL which was specified at compile time.
5841 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005842 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005843 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005844 This option cannot be set from a |modeline| or in the |sandbox|, for
5845 security reasons.
5846
5847 *'mzschemegcdll'*
5848'mzschemegcdll' string (default depends on the build)
5849 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005850 {only available when compiled with the |+mzscheme/dyn|
5851 feature}
5852 Specifies the name of the MzScheme GC shared library. The default is
5853 DYNAMIC_MZGC_DLL which was specified at compile time.
5854 The value can be equal to 'mzschemedll' if it includes the GC code.
5855 Environment variables are expanded |:set_env|.
5856 This option cannot be set from a |modeline| or in the |sandbox|, for
5857 security reasons.
5858
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005859 *'mzquantum'* *'mzq'*
5860'mzquantum' 'mzq' number (default 100)
5861 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005862 {not available when compiled without the |+mzscheme|
5863 feature}
5864 The number of milliseconds between polls for MzScheme threads.
5865 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005866 NOTE: This option is set to the Vim default value when 'compatible'
5867 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005868
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005870'nrformats' 'nf' string (default "bin,octal,hex",
5871 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 This defines what bases Vim will consider for numbers when using the
5874 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5875 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005876 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005878 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005879 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005881 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 considered to be hexadecimal. Example: Using CTRL-X on
5883 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005884 bin If included, numbers starting with "0b" or "0B" will be
5885 considered to be binary. Example: Using CTRL-X on
5886 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005887 unsigned If included, numbers are recognized as unsigned. Thus a
5888 leading dash or negative sign won't be considered as part of
5889 the number. Examples:
5890 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5891 (without "unsigned" it would become "9-2021").
5892 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5893 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005894 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5895 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 Numbers which simply begin with a digit in the range 1-9 are always
5897 considered decimal. This also happens for numbers that are not
5898 recognized as octal or hex.
5899
5900 *'number'* *'nu'* *'nonumber'* *'nonu'*
5901'number' 'nu' boolean (default off)
5902 local to window
5903 Print the line number in front of each line. When the 'n' option is
5904 excluded from 'cpoptions' a wrapped line will not use the column of
5905 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005906 The 'numberwidth' option can be used to set the room used for the line
5907 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 When a long, wrapped line doesn't start with the first character, '-'
5909 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005910 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5911 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005912 *number_relativenumber*
5913 The 'relativenumber' option changes the displayed number to be
5914 relative to the cursor. Together with 'number' there are these
5915 four combinations (cursor in line 3):
5916
Bram Moolenaar3848e002016-03-19 18:42:29 +01005917 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005918 'nornu' 'nornu' 'rnu' 'rnu'
5919
5920 |apple | 1 apple | 2 apple | 2 apple
5921 |pear | 2 pear | 1 pear | 1 pear
5922 |nobody | 3 nobody | 0 nobody |3 nobody
5923 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005925 *'numberwidth'* *'nuw'*
5926'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5927 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005928 {only available when compiled with the |+linebreak|
5929 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005930 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005931 when the 'number' or 'relativenumber' option is set or printing lines
5932 with a line number. Since one space is always between the number and
5933 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005934 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005935 fit the highest line number in the buffer respectively the number of
5936 rows in the window, depending on whether 'number' or 'relativenumber'
5937 is set. Thus with the Vim default of 4 there is room for a line number
5938 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005939 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005940 NOTE: This option is set to the Vi default value when 'compatible' is
5941 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005942
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005943 *'omnifunc'* *'ofu'*
5944'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005945 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005946 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005947 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005948 This option specifies a function to be used for Insert mode omni
5949 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005950 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005951 invoked and what it should return. The value can be the name of a
5952 function, a |lambda| or a |Funcref|. See |option-value-function| for
5953 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005954 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005955 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005956 This option cannot be set from a |modeline| or in the |sandbox|, for
5957 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005958
5959
Bram Moolenaar02467872007-05-06 13:22:01 +00005960 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005961'opendevice' 'odev' boolean (default off)
5962 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005963 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005964 Enable reading and writing from devices. This may get Vim stuck on a
5965 device that can be opened but doesn't actually do the I/O. Therefore
5966 it is off by default.
5967 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5968 result in editing a device.
5969
5970
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005971 *'operatorfunc'* *'opfunc'*
5972'operatorfunc' 'opfunc' string (default: empty)
5973 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005974 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005975 See |:map-operator| for more info and an example. The value can be
5976 the name of a function, a |lambda| or a |Funcref|. See
5977 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005978
5979 This option cannot be set from a |modeline| or in the |sandbox|, for
5980 security reasons.
5981
5982
Bram Moolenaar251e1912011-06-19 05:09:16 +02005983 *'osfiletype'* *'oft'*
5984'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005986 This option was supported on RISC OS, which has been removed.
5987
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005989 *'packpath'* *'pp'*
5990'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005991 Directories used to find packages. See |packages|.
5992
5993
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005995'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 global
5997 Specifies the nroff macros that separate paragraphs. These are pairs
5998 of two letters (see |object-motions|).
5999
6000 *'paste'* *'nopaste'*
6001'paste' boolean (default off)
6002 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006003 Put Vim in Paste mode. This is useful if you want to cut or copy
6004 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 unexpected effects.
6006 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006007 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 knows about pasting and will mostly do the right thing without 'paste'
6009 being set. The same is true for a terminal where Vim handles the
6010 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006011 This option is reset when starting the GUI. Thus if you set it in
6012 your .vimrc it will work in a terminal, but not in the GUI. Setting
6013 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6014 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 When the 'paste' option is switched on (also when it was already on):
6016 - mapping in Insert mode and Command-line mode is disabled
6017 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006019 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006020 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021 - 'revins' is reset
6022 - 'ruler' is reset
6023 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006024 - 'smarttab' is reset
6025 - 'softtabstop' is set to 0
6026 - 'textwidth' is set to 0
6027 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006028 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006031 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006032 - 'indentexpr'
6033 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006034 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035 NOTE: When you start editing another file while the 'paste' option is
6036 on, settings from the modelines or autocommands may change the
6037 settings again, causing trouble when pasting text. You might want to
6038 set the 'paste' option again.
6039 When the 'paste' option is reset the mentioned options are restored to
6040 the value before the moment 'paste' was switched from off to on.
6041 Resetting 'paste' before ever setting it does not have any effect.
6042 Since mapping doesn't work while 'paste' is active, you need to use
6043 the 'pastetoggle' option to toggle the 'paste' option with some key.
6044
6045 *'pastetoggle'* *'pt'*
6046'pastetoggle' 'pt' string (default "")
6047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 When non-empty, specifies the key sequence that toggles the 'paste'
6049 option. This is like specifying a mapping: >
6050 :map {keys} :set invpaste<CR>
6051< Where {keys} is the value of 'pastetoggle'.
6052 The difference is that it will work even when 'paste' is set.
6053 'pastetoggle' works in Insert mode and Normal mode, but not in
6054 Command-line mode.
6055 Mappings are checked first, thus overrule 'pastetoggle'. However,
6056 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6057 this: >
6058 :map <F10> :set paste<CR>
6059 :map <F11> :set nopaste<CR>
6060 :imap <F10> <C-O>:set paste<CR>
6061 :imap <F11> <nop>
6062 :set pastetoggle=<F11>
6063< This will make <F10> start paste mode and <F11> stop paste mode.
6064 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6065 mode everything is inserted literally, except the 'pastetoggle' key
6066 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006067 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068
6069 *'pex'* *'patchexpr'*
6070'patchexpr' 'pex' string (default "")
6071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 {not available when compiled without the |+diff|
6073 feature}
6074 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006075 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076
Bram Moolenaardbc28022014-07-26 13:40:44 +02006077 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078'patchmode' 'pm' string (default "")
6079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006080 When non-empty the oldest version of a file is kept. This can be used
6081 to keep the original version of a file if you are changing files in a
6082 source distribution. Only the first time that a file is written a
6083 copy of the original file will be kept. The name of the copy is the
6084 name of the original file with the string in the 'patchmode' option
6085 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006086 ".orig" or ".org". 'backupdir' must not be empty for this to work
6087 (Detail: The backup file is renamed to the patchmode file after the
6088 new file has been successfully written, that's why it must be possible
6089 to write a backup file). If there was no file to be backed up, an
6090 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 When the 'backupskip' pattern matches, a patchmode file is not made.
6092 Using 'patchmode' for compressed files appends the extension at the
6093 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6094 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006095 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006097 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 other systems: ".,,")
6100 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006102 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6103 provided that the file being searched for has a relative path (not
6104 starting with "/", "./" or "../"). The directories in the 'path'
6105 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 - Use commas to separate directory names: >
6107 :set path=.,/usr/local/include,/usr/include
6108< - Spaces can also be used to separate directory names (for backwards
6109 compatibility with version 3.0). To have a space in a directory
6110 name, precede it with an extra backslash, and escape the space: >
6111 :set path=.,/dir/with\\\ space
6112< - To include a comma in a directory name precede it with an extra
6113 backslash: >
6114 :set path=.,/dir/with\\,comma
6115< - To search relative to the directory of the current file, use: >
6116 :set path=.
6117< - To search in the current directory use an empty string between two
6118 commas: >
6119 :set path=,,
6120< - A directory name may end in a ':' or '/'.
6121 - Environment variables are expanded |:set_env|.
6122 - When using |netrw.vim| URLs can be used. For example, adding
6123 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006124 - Search upwards and downwards in a directory tree using "*", "**" and
6125 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 - Careful with '\' characters, type two to get one in the option: >
6127 :set path=.,c:\\include
6128< Or just use '/' instead: >
6129 :set path=.,c:/include
6130< Don't forget "." or files won't even be found in the same directory as
6131 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006132 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 it is something like 256 or 1024 characters.
6134 You can check if all the include files are found, using the value of
6135 'path', see |:checkpath|.
6136 The use of |:set+=| and |:set-=| is preferred when adding or removing
6137 directories from the list. This avoids problems when a future version
6138 uses another default. To remove the current directory use: >
6139 :set path-=
6140< To add the current directory use: >
6141 :set path+=
6142< To use an environment variable, you probably need to replace the
6143 separator. Here is an example to append $INCL, in which directory
6144 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006145 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146< Replace the ';' with a ':' or whatever separator is used. Note that
6147 this doesn't work when $INCL contains a comma or white space.
6148
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006149 *'perldll'*
6150'perldll' string (default depends on the build)
6151 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006152 {only available when compiled with the |+perl/dyn|
6153 feature}
6154 Specifies the name of the Perl shared library. The default is
6155 DYNAMIC_PERL_DLL, which was specified at compile time.
6156 Environment variables are expanded |:set_env|.
6157 This option cannot be set from a |modeline| or in the |sandbox|, for
6158 security reasons.
6159
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6161'preserveindent' 'pi' boolean (default off)
6162 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 When changing the indent of the current line, preserve as much of the
6164 indent structure as possible. Normally the indent is replaced by a
6165 series of tabs followed by spaces as required (unless |'expandtab'| is
6166 enabled, in which case only spaces are used). Enabling this option
6167 means the indent will preserve as many existing characters as possible
6168 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006169 'expandtab' does not apply to the preserved white space, a Tab remains
6170 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 NOTE: When using ">>" multiple times the resulting indent is a mix of
6172 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006173 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 Also see 'copyindent'.
6175 Use |:retab| to clean up white space.
6176
6177 *'previewheight'* *'pvh'*
6178'previewheight' 'pvh' number (default 12)
6179 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006180 {not available when compiled without the |+quickfix|
6181 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006183 commands. Used for |CTRL-W_}| when no count is given. Not used when
6184 'previewpopup' is set.
6185
6186 *'previewpopup'* *'pvp'*
6187'previewpopup' 'pvp' string (default empty)
6188 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006189 {not available when compiled without the |+textprop|
6190 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006191 When not empty a popup window is used for commands that would open a
6192 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006193 Not used for the insert completion info, add "popup" to
6194 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195
6196 *'previewwindow'* *'nopreviewwindow'*
6197 *'pvw'* *'nopvw'* *E590*
6198'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006199 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006200 {not available when compiled without the |+quickfix|
6201 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006202 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203 set. It's normally not set directly, but by using one of the commands
6204 |:ptag|, |:pedit|, etc.
6205
6206 *'printdevice'* *'pdev'*
6207'printdevice' 'pdev' string (default empty)
6208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 {only available when compiled with the |+printer|
6210 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006211 The name of the printer to be used for |:hardcopy|.
6212 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006213 This option cannot be set from a |modeline| or in the |sandbox|, for
6214 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215
Bram Moolenaar8299df92004-07-10 09:47:34 +00006216 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006217'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 {only available when compiled with the |+printer|
6220 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006221 Sets the character encoding used when printing.
6222 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223
6224 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006225'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 {only available when compiled with the |+printer|
6228 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006229 Expression used to print the PostScript produced with |:hardcopy|.
6230 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006231 This option cannot be set from a |modeline| or in the |sandbox|, for
6232 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233
Bram Moolenaar8299df92004-07-10 09:47:34 +00006234 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235'printfont' 'pfn' string (default "courier")
6236 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 {only available when compiled with the |+printer|
6238 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006239 The name of the font that will be used for |:hardcopy|.
6240 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241
6242 *'printheader'* *'pheader'*
6243'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245 {only available when compiled with the |+printer|
6246 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006247 The format of the header produced in |:hardcopy| output.
6248 See |pheader-option|.
6249
6250 *'printmbcharset'* *'pmbcs'*
6251'printmbcharset' 'pmbcs' string (default "")
6252 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006253 {only available when compiled with the |+printer|
6254 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006255 The CJK character set to be used for CJK output from |:hardcopy|.
6256 See |pmbcs-option|.
6257
6258 *'printmbfont'* *'pmbfn'*
6259'printmbfont' 'pmbfn' string (default "")
6260 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006261 {only available when compiled with the |+printer|
6262 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006263 List of font names to be used for CJK output from |:hardcopy|.
6264 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265
6266 *'printoptions'* *'popt'*
6267'printoptions' 'popt' string (default "")
6268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006270 List of items that control the format of the output of |:hardcopy|.
6271 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006273 *'prompt'* *'noprompt'*
6274'prompt' boolean (default on)
6275 global
6276 When on a ":" prompt is used in Ex mode.
6277
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006278 *'pumheight'* *'ph'*
6279'pumheight' 'ph' number (default 0)
6280 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006281 Determines the maximum number of items to show in the popup menu for
6282 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006283 |ins-completion-menu|.
6284
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006285 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006286'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006287 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006288 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006289 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006290
Bram Moolenaard94464e2015-11-02 15:28:18 +01006291 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006292'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006293 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006294 {only available when compiled with the |+python/dyn|
6295 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006296 Specifies the name of the Python 2.x shared library. The default is
6297 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006298 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006299 This option cannot be set from a |modeline| or in the |sandbox|, for
6300 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006301
Bram Moolenaar94073162018-01-31 21:49:05 +01006302 *'pythonhome'*
6303'pythonhome' string (default "")
6304 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006305 {only available when compiled with the |+python/dyn|
6306 feature}
6307 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6308 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6309 which was specified at compile time, will be used for the Python 2.x
6310 home directory.
6311 Environment variables are expanded |:set_env|.
6312 This option cannot be set from a |modeline| or in the |sandbox|, for
6313 security reasons.
6314
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006315 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006316'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006317 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006318 {only available when compiled with the |+python3/dyn|
6319 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006320 Specifies the name of the Python 3 shared library. The default is
6321 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006322 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006323 This option cannot be set from a |modeline| or in the |sandbox|, for
6324 security reasons.
6325
Bram Moolenaar94073162018-01-31 21:49:05 +01006326 *'pythonthreehome'*
6327'pythonthreehome' string (default "")
6328 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006329 {only available when compiled with the |+python3/dyn|
6330 feature}
6331 Specifies the name of the Python 3 home directory. When
6332 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6333 PYTHON3_HOME, which was specified at compile time, will be used for
6334 the Python 3 home directory.
6335 Environment variables are expanded |:set_env|.
6336 This option cannot be set from a |modeline| or in the |sandbox|, for
6337 security reasons.
6338
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006339 *'pyxversion'* *'pyx'*
6340'pyxversion' 'pyx' number (default depends on the build)
6341 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006342 {only available when compiled with the |+python| or
6343 the |+python3| feature}
6344 Specifies the python version used for pyx* functions and commands
6345 |python_x|. The default value is as follows:
6346
6347 Compiled with Default ~
6348 |+python| and |+python3| 0
6349 only |+python| 2
6350 only |+python3| 3
6351
6352 Available values are 0, 2 and 3.
6353 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6354 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6355 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6356 to 2 if Python 2 is available.
6357 See also: |has-pythonx|
6358
6359 If Vim is compiled with only |+python| or |+python3| setting
6360 'pyxversion' has no effect. The pyx* functions and commands are
6361 always the same as the compiled version.
6362
6363 This option cannot be set from a |modeline| or in the |sandbox|, for
6364 security reasons.
6365
Bram Moolenaar858ba062020-05-31 23:11:59 +02006366 *'quickfixtextfunc'* *'qftf'*
6367'quickfixtextfunc' 'qftf' string (default "")
6368 global
6369 {only available when compiled with the |+quickfix|
6370 feature}
6371 This option specifies a function to be used to get the text to display
6372 in the quickfix and location list windows. This can be used to
6373 customize the information displayed in the quickfix or location window
6374 for each entry in the corresponding quickfix or location list. See
6375 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006376 function and an example. The value can be the name of a function, a
6377 |lambda| or a |Funcref|. See |option-value-function| for more
6378 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006379
6380 This option cannot be set from a |modeline| or in the |sandbox|, for
6381 security reasons.
6382
Bram Moolenaar677ee682005-01-27 14:41:15 +00006383 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006384'quoteescape' 'qe' string (default "\")
6385 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006386 The characters that are used to escape quotes in a string. Used for
6387 objects like a', a" and a` |a'|.
6388 When one of the characters in this option is found inside a string,
6389 the following character will be skipped. The default value makes the
6390 text "foo\"bar\\" considered to be one string.
6391
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6393'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006394 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 If on, writes fail unless you use a '!'. Protects you from
6396 accidentally overwriting a file. Default on when Vim is started
6397 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006398 When using ":w!" the 'readonly' option is reset for the current
6399 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006400 When using the ":view" command the 'readonly' option is set for the
6401 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006402 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006404 *'redrawtime'* *'rdt'*
6405'redrawtime' 'rdt' number (default 2000)
6406 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006407 {only available when compiled with the |+reltime|
6408 feature}
6409 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006410 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006411 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006412 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006413 matches will be highlighted.
6414 For syntax highlighting the time applies per window. When over the
6415 limit syntax highlighting is disabled until |CTRL-L| is used.
6416 This is used to avoid that Vim hangs when using a very complicated
6417 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006418
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006419 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006420'regexpengine' 're' number (default 0)
6421 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006422 This selects the default regexp engine. |two-engines|
6423 The possible values are:
6424 0 automatic selection
6425 1 old engine
6426 2 NFA engine
6427 Note that when using the NFA engine and the pattern contains something
6428 that is not supported the pattern will not match. This is only useful
6429 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006430 Using automatic selection enables Vim to switch the engine, if the
6431 default engine becomes too costly. E.g., when the NFA engine uses too
6432 many states. This should prevent Vim from hanging on a combination of
6433 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006434
Bram Moolenaar64486672010-05-16 15:46:46 +02006435 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6436'relativenumber' 'rnu' boolean (default off)
6437 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006438 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006439 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006440 precede some vertical motion commands (e.g. j k + -) with, without
6441 having to calculate it yourself. Especially useful in combination with
6442 other commands (e.g. y d c < > gq gw =).
6443 When the 'n' option is excluded from 'cpoptions' a wrapped
6444 line will not use the column of line numbers (this is the default when
6445 'compatible' isn't set).
6446 The 'numberwidth' option can be used to set the room used for the line
6447 number.
6448 When a long, wrapped line doesn't start with the first character, '-'
6449 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006450 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6451 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006452
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006453 The number in front of the cursor line also depends on the value of
6454 'number', see |number_relativenumber| for all combinations of the two
6455 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006456
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 *'remap'* *'noremap'*
6458'remap' boolean (default on)
6459 global
6460 Allows for mappings to work recursively. If you do not want this for
6461 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006462 NOTE: To avoid portability problems with Vim scripts, always keep
6463 this option at the default "on". Only switch it off when working with
6464 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006466 *'renderoptions'* *'rop'*
6467'renderoptions' 'rop' string (default: empty)
6468 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006469 {only available when compiled with GUI and DIRECTX on
6470 MS-Windows}
6471 Select a text renderer and set its options. The options depend on the
6472 renderer.
6473
6474 Syntax: >
6475 set rop=type:{renderer}(,{name}:{value})*
6476<
6477 Currently, only one optional renderer is available.
6478
6479 render behavior ~
6480 directx Vim will draw text using DirectX (DirectWrite). It makes
6481 drawn glyphs more beautiful than default GDI.
6482 It requires 'encoding' is "utf-8", and only works on
6483 MS-Windows Vista or newer version.
6484
6485 Options:
6486 name meaning type value ~
6487 gamma gamma float 1.0 - 2.2 (maybe)
6488 contrast enhancedContrast float (unknown)
6489 level clearTypeLevel float (unknown)
6490 geom pixelGeometry int 0 - 2 (see below)
6491 renmode renderingMode int 0 - 6 (see below)
6492 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006493 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006494
Bram Moolenaar92467d32017-12-05 13:22:16 +01006495 See this URL for detail (except for scrlines):
6496 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006497
6498 For geom: structure of a device pixel.
6499 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6500 1 - DWRITE_PIXEL_GEOMETRY_RGB
6501 2 - DWRITE_PIXEL_GEOMETRY_BGR
6502
6503 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006504 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006505
6506 For renmode: method of rendering glyphs.
6507 0 - DWRITE_RENDERING_MODE_DEFAULT
6508 1 - DWRITE_RENDERING_MODE_ALIASED
6509 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6510 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6511 4 - DWRITE_RENDERING_MODE_NATURAL
6512 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6513 6 - DWRITE_RENDERING_MODE_OUTLINE
6514
6515 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006516 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006517
6518 For taamode: antialiasing mode used for drawing text.
6519 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6520 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6521 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6522 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6523
6524 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006525 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6526
Bram Moolenaara338adc2018-01-31 20:51:47 +01006527 For scrlines:
6528 This was used for optimizing scrolling behavior, however this
6529 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006530
6531 Example: >
6532 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006533 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006534 set rop=type:directx
6535<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006536 If select a raster font (Courier, Terminal or FixedSys which
6537 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006538 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006539
6540 NOTE: It is known that some fonts and options combination
6541 causes trouble on drawing glyphs.
6542
Bram Moolenaar92467d32017-12-05 13:22:16 +01006543 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006544 special made fonts (True-Type fonts which includes only
6545 bitmap glyphs).
6546 - 'taamode:3' will not work with some vector fonts.
6547
6548 NOTE: With this option, you can display colored emoji
6549 (emoticon) in Windows 8.1 or later. To display colored emoji,
6550 there are some conditions which you should notice.
6551
6552 - If your font includes non-colored emoji already, it will
6553 be used.
6554 - If your font doesn't have emoji, the system chooses an
6555 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6556 will be used.
6557 - When this alternative font didn't have fixed width glyph,
6558 emoji might be rendered beyond the bounding box of drawing
6559 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006560
6561 Other render types are currently not supported.
6562
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 *'report'*
6564'report' number (default 2)
6565 global
6566 Threshold for reporting number of lines changed. When the number of
6567 changed lines is more than 'report' a message will be given for most
6568 ":" commands. If you want it always, set 'report' to 0.
6569 For the ":substitute" command the number of substitutions is used
6570 instead of the number of lines.
6571
6572 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6573'restorescreen' 'rs' boolean (default on)
6574 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006575 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 When set, the screen contents is restored when exiting Vim. This also
6577 happens when executing external commands.
6578
6579 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6580 options in your .vimrc. To disable restoring:
6581 set t_ti= t_te=
6582 To enable restoring (for an xterm):
6583 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6584 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6585
6586 *'revins'* *'ri'* *'norevins'* *'nori'*
6587'revins' 'ri' boolean (default off)
6588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589 {only available when compiled with the |+rightleft|
6590 feature}
6591 Inserting characters in Insert mode will work backwards. See "typing
6592 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6593 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006594 NOTE: This option is reset when 'compatible' is set.
6595 This option is reset when 'paste' is set and restored when 'paste' is
6596 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597
6598 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6599'rightleft' 'rl' boolean (default off)
6600 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 {only available when compiled with the |+rightleft|
6602 feature}
6603 When on, display orientation becomes right-to-left, i.e., characters
6604 that are stored in the file appear from the right to the left.
6605 Using this option, it is possible to edit files for languages that
6606 are written from the right to the left such as Hebrew and Arabic.
6607 This option is per window, so it is possible to edit mixed files
6608 simultaneously, or to view the same file in both ways (this is
6609 useful whenever you have a mixed text file with both right-to-left
6610 and left-to-right strings so that both sets are displayed properly
6611 in different windows). Also see |rileft.txt|.
6612
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006613 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614'rightleftcmd' 'rlc' string (default "search")
6615 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 {only available when compiled with the |+rightleft|
6617 feature}
6618 Each word in this option enables the command line editing to work in
6619 right-to-left mode for a group of commands:
6620
6621 search "/" and "?" commands
6622
6623 This is useful for languages such as Hebrew, Arabic and Farsi.
6624 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6625
Bram Moolenaard94464e2015-11-02 15:28:18 +01006626 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006627'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006628 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006629 {only available when compiled with the |+ruby/dyn|
6630 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006631 Specifies the name of the Ruby shared library. The default is
6632 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006633 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006634 This option cannot be set from a |modeline| or in the |sandbox|, for
6635 security reasons.
6636
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006638'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006641 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 text in the file is shown on the far right:
6643 Top first line is visible
6644 Bot last line is visible
6645 All first and last line are visible
6646 45% relative position in the file
6647 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006648 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006649 ruler is shown there. Otherwise it is shown in the last line of the
6650 screen. If the statusline is given by 'statusline' (i.e. not empty),
6651 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006653 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 the text column (byte number) and the screen column are shown,
6655 separated with a dash.
6656 For an empty line "0-1" is shown.
6657 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006658 This option is reset when 'paste' is set and restored when 'paste' is
6659 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 If you don't want to see the ruler all the time but want to know where
6661 you are, use "g CTRL-G" |g_CTRL-G|.
6662 NOTE: This option is reset when 'compatible' is set.
6663
6664 *'rulerformat'* *'ruf'*
6665'rulerformat' 'ruf' string (default empty)
6666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 {not available when compiled without the |+statusline|
6668 feature}
6669 When this option is not empty, it determines the content of the ruler
6670 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006671 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006672 This option cannot be set in a modeline when 'modelineexpr' is off.
6673
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 The default ruler width is 17 characters. To make the ruler 15
6675 characters wide, put "%15(" at the start and "%)" at the end.
6676 Example: >
6677 :set rulerformat=%15(%c%V\ %p%%%)
6678<
6679 *'runtimepath'* *'rtp'* *vimfiles*
6680'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006681 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 $VIM/vimfiles,
6683 $VIMRUNTIME,
6684 $VIM/vimfiles/after,
6685 $HOME/.vim/after"
6686 Amiga: "home:vimfiles,
6687 $VIM/vimfiles,
6688 $VIMRUNTIME,
6689 $VIM/vimfiles/after,
6690 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006691 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 $VIM/vimfiles,
6693 $VIMRUNTIME,
6694 $VIM/vimfiles/after,
6695 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006696 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 $VIMRUNTIME,
6698 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006699 Haiku: "$BE_USER_SETTINGS/vim,
6700 $VIM/vimfiles,
6701 $VIMRUNTIME,
6702 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006703 $BE_USER_SETTINGS/vim/after"
6704 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 $VIM/vimfiles,
6706 $VIMRUNTIME,
6707 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006708 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 This is a list of directories which will be searched for runtime
6711 files:
6712 filetype.vim filetypes by file name |new-filetype|
6713 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006714 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 colors/ color scheme files |:colorscheme|
6716 compiler/ compiler files |:compiler|
6717 doc/ documentation |write-local-help|
6718 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006719 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 indent/ indent scripts |indent-expression|
6721 keymap/ key mapping files |mbyte-keymap|
6722 lang/ menu translations |:menutrans|
6723 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006724 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 plugin/ plugin scripts |write-plugin|
6726 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006727 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 syntax/ syntax files |mysyntaxfile|
6729 tutor/ files for vimtutor |tutor|
6730
6731 And any other file searched for with the |:runtime| command.
6732
6733 The defaults for most systems are setup to search five locations:
6734 1. In your home directory, for your personal preferences.
6735 2. In a system-wide Vim directory, for preferences from the system
6736 administrator.
6737 3. In $VIMRUNTIME, for files distributed with Vim.
6738 *after-directory*
6739 4. In the "after" directory in the system-wide Vim directory. This is
6740 for the system administrator to overrule or add to the distributed
6741 defaults (rarely needed)
6742 5. In the "after" directory in your home directory. This is for
6743 personal preferences to overrule or add to the distributed defaults
6744 or system-wide settings (rarely needed).
6745
Bram Moolenaard0796902016-09-16 20:02:31 +02006746 More entries are added when using |packages|. If it gets very long
6747 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6748 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006749
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6751 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006752 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 wildcards.
6754 See |:runtime|.
6755 Example: >
6756 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6757< This will use the directory "~/vimruntime" first (containing your
6758 personal Vim runtime files), then "/mygroup/vim" (shared between a
6759 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6760 files).
6761 You probably should always include $VIMRUNTIME somewhere, to use the
6762 distributed runtime files. You can put a directory before $VIMRUNTIME
6763 to find files which replace a distributed runtime files. You can put
6764 a directory after $VIMRUNTIME to find files which add to distributed
6765 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006766 When Vim is started with |--clean| the home directory entries are not
6767 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 This option cannot be set from a |modeline| or in the |sandbox|, for
6769 security reasons.
6770
6771 *'scroll'* *'scr'*
6772'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006773 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6775 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006776 changes. This may happen when enabling the |status-line| or
6777 'tabline' option after setting the 'scroll' option.
6778 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006779 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006780 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781
6782 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6783'scrollbind' 'scb' boolean (default off)
6784 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006785 See also |scroll-binding|. When this option is set, scrolling the
6786 current window also scrolls other scrollbind windows (windows that
6787 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 differences between two versions of a file, see 'diff'.
6789 See |'scrollopt'| for options that determine how this option should be
6790 interpreted.
6791 This option is mostly reset when splitting a window to edit another
6792 file. This means that ":split | edit file" results in two windows
6793 with scroll-binding, but ":split file" does not.
6794
Bram Moolenaarae20f342019-11-05 21:09:23 +01006795 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6796'scrollfocus' 'scf' boolean (default off)
6797 global
6798 {only for MS-Windows GUI}
6799 When using the scroll wheel and this option is set, the window under
6800 the mouse pointer is scrolled. With this option off the current
6801 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006802 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006803
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 *'scrolljump'* *'sj'*
6805'scrolljump' 'sj' number (default 1)
6806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 Minimal number of lines to scroll when the cursor gets off the
6808 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6809 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006810 When set to a negative number from -1 to -100 this is used as the
6811 percentage of the window height. Thus -50 scrolls half the window
6812 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 NOTE: This option is set to 1 when 'compatible' is set.
6814
6815 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006816'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006817 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 Minimal number of screen lines to keep above and below the cursor.
6819 This will make some context visible around where you are working. If
6820 you set it to a very large value (999) the cursor line will always be
6821 in the middle of the window (except at the start or end of the file or
6822 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006823 After using the local value, go back the global value with one of
6824 these two: >
6825 setlocal scrolloff<
6826 setlocal scrolloff=-1
6827< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 NOTE: This option is set to 0 when 'compatible' is set.
6829
6830 *'scrollopt'* *'sbo'*
6831'scrollopt' 'sbo' string (default "ver,jump")
6832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006834 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6835 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 The following words are available:
6837 ver Bind vertical scrolling for 'scrollbind' windows
6838 hor Bind horizontal scrolling for 'scrollbind' windows
6839 jump Applies to the offset between two windows for vertical
6840 scrolling. This offset is the difference in the first
6841 displayed line of the bound windows. When moving
6842 around in a window, another 'scrollbind' window may
6843 reach a position before the start or after the end of
6844 the buffer. The offset is not changed though, when
6845 moving back the 'scrollbind' window will try to scroll
6846 to the desired position when possible.
6847 When now making that window the current one, two
6848 things can be done with the relative offset:
6849 1. When "jump" is not included, the relative offset is
6850 adjusted for the scroll position in the new current
6851 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006852 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 2. When "jump" is included, the other windows are
6854 scrolled to keep the same relative offset. When
6855 going back to the other window, it still uses the
6856 same relative offset.
6857 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006858 When 'diff' mode is active there always is vertical scroll binding,
6859 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860
6861 *'sections'* *'sect'*
6862'sections' 'sect' string (default "SHNHH HUnhsh")
6863 global
6864 Specifies the nroff macros that separate sections. These are pairs of
6865 two letters (See |object-motions|). The default makes a section start
6866 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6867
6868 *'secure'* *'nosecure'* *E523*
6869'secure' boolean (default off)
6870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 When on, ":autocmd", shell and write commands are not allowed in
6872 ".vimrc" and ".exrc" in the current directory and map commands are
6873 displayed. Switch it off only if you know that you will not run into
6874 problems, or when the 'exrc' option is off. On Unix this option is
6875 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006876 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 'secure' at the end of your ~/.vimrc then.
6878 This option cannot be set from a |modeline| or in the |sandbox|, for
6879 security reasons.
6880
6881 *'selection'* *'sel'*
6882'selection' 'sel' string (default "inclusive")
6883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 This option defines the behavior of the selection. It is only used
6885 in Visual and Select mode.
6886 Possible values:
6887 value past line inclusive ~
6888 old no yes
6889 inclusive yes yes
6890 exclusive yes no
6891 "past line" means that the cursor is allowed to be positioned one
6892 character past the line.
6893 "inclusive" means that the last character of the selection is included
6894 in an operation. For example, when "x" is used to delete the
6895 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006896 When "old" is used and 'virtualedit' allows the cursor to move past
6897 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 Note that when "exclusive" is used and selecting from the end
6899 backwards, you cannot include the last character of a line, when
6900 starting in Normal mode and 'virtualedit' empty.
6901
6902 The 'selection' option is set by the |:behave| command.
6903
6904 *'selectmode'* *'slm'*
6905'selectmode' 'slm' string (default "")
6906 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006907 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 Select mode instead of Visual mode, when a selection is started.
6909 Possible values:
6910 mouse when using the mouse
6911 key when using shifted special keys
6912 cmd when using "v", "V" or CTRL-V
6913 See |Select-mode|.
6914 The 'selectmode' option is set by the |:behave| command.
6915
6916 *'sessionoptions'* *'ssop'*
6917'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006918 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006920 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 feature}
6922 Changes the effect of the |:mksession| command. It is a comma
6923 separated list of words. Each word enables saving and restoring
6924 something:
6925 word save and restore ~
6926 blank empty windows
6927 buffers hidden and unloaded buffers, not just those in windows
6928 curdir the current directory
6929 folds manually created folds, opened/closed folds and local
6930 fold options
6931 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006932 and contain at least one lowercase letter. Only
6933 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 help the help window
6935 localoptions options and mappings local to a window or buffer (not
6936 global values for local options)
6937 options all options and mappings (also global values for local
6938 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006939 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 resize size of the Vim window: 'lines' and 'columns'
6941 sesdir the directory in which the session file is located
6942 will become the current directory (useful with
6943 projects accessed over a network from different
6944 systems)
6945 slash backslashes in file names replaced with forward
6946 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006947 tabpages all tab pages; without this only the current tab page
6948 is restored, so that you can make a session for each
6949 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006950 terminal include terminal windows where the command can be
6951 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 unix with Unix end-of-line format (single <NL>), even when
6953 on Windows or DOS
6954 winpos position of the whole Vim window
6955 winsize window sizes
6956
6957 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006958 When neither "curdir" nor "sesdir" is included, file names are stored
6959 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006960 If you leave out "options" many things won't work well after restoring
6961 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 "slash" and "unix" are useful on Windows when sharing session files
6963 with Unix. The Unix version of Vim cannot source dos format scripts,
6964 but the Windows version of Vim can source unix format scripts.
6965
6966 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006967'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 global
6969 Name of the shell to use for ! and :! commands. When changing the
6970 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6971 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006972 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 See |option-backslash| about including spaces and backslashes.
6974 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006975
Bram Moolenaara2baa732022-02-04 16:09:54 +00006976 In |restricted-mode| shell commands will not be possible. This mode
6977 is used if the value of $SHELL ends in "false" or "nologin".
6978
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006979 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006980 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6982< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006983 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006985 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006987 Example with escaped space (Vim will do this when initializing the
6988 option from $SHELL): >
6989 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006990< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006991 backslashes are consumed by `:set`.
6992
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 Under MS-Windows, when the executable ends in ".com" it must be
6994 included. Thus setting the shell to "command.com" or "4dos.com"
6995 works, but "command" and "4dos" do not work for all commands (e.g.,
6996 filtering).
6997 For unknown reasons, when using "4dos.com" the current directory is
6998 changed to "C:\". To avoid this set 'shell' like this: >
6999 :set shell=command.com\ /c\ 4dos
7000< This option cannot be set from a |modeline| or in the |sandbox|, for
7001 security reasons.
7002
7003 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007004'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007005 Win32, when 'shell' contains "powershell":
7006 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007007 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007010 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7011 For MS-Windows, the default is set according to the value of 'shell',
7012 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007013 On Unix it can have more than one flag. Each white space separated
7014 part is passed as an argument to the shell command.
7015 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007016 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 This option cannot be set from a |modeline| or in the |sandbox|, for
7018 security reasons.
7019
7020 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007021'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7022 "2>&1| tee", or
7023 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 {not available when compiled without the |+quickfix|
7026 feature}
7027 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007028 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 including spaces and backslashes.
7030 The name of the temporary file can be represented by "%s" if necessary
7031 (the file name is appended automatically if no %s appears in the value
7032 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007033 For the Amiga the default is ">". For MS-Windows using powershell the
7034 default is "2>&1 | Out-File -Encoding default", otherwise the default
7035 is ">%s 2>&1". The output is directly saved in a file and not echoed
7036 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007037 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 in a file and echoed to the screen. If the 'shell' option is "csh" or
7039 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007040 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007041 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7042 means that stderr is also included. Before using the 'shell' option a
7043 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007044 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7045 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 The initialization of this option is done after reading the ".vimrc"
7047 and the other initializations, so that when the 'shell' option is set
7048 there, the 'shellpipe' option changes automatically, unless it was
7049 explicitly set before.
7050 When 'shellpipe' is set to an empty string, no redirection of the
7051 ":make" output will be done. This is useful if you use a 'makeprg'
7052 that writes to 'makeef' by itself. If you want no piping, but do
7053 want to include the 'makeef', set 'shellpipe' to a single space.
7054 Don't forget to precede the space with a backslash: ":set sp=\ ".
7055 In the future pipes may be used for filtering and this option will
7056 become obsolete (at least for Unix).
7057 This option cannot be set from a |modeline| or in the |sandbox|, for
7058 security reasons.
7059
7060 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007061'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 Quoting character(s), put around the command passed to the shell, for
7064 the "!" and ":!" commands. The redirection is kept outside of the
7065 quoting. See 'shellxquote' to include the redirection. It's
7066 probably not useful to set both options.
7067 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007068 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007069 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 This option cannot be set from a |modeline| or in the |sandbox|, for
7071 security reasons.
7072
7073 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007074'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7075 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 String to be used to put the output of a filter command in a temporary
7078 file. See also |:!|. See |option-backslash| about including spaces
7079 and backslashes.
7080 The name of the temporary file can be represented by "%s" if necessary
7081 (the file name is appended automatically if no %s appears in the value
7082 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007083 The default is ">". For Unix, if the 'shell' option is "csh" or
7084 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007085 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007086 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7087 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007088 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7089 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007090 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7091 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 The initialization of this option is done after reading the ".vimrc"
7093 and the other initializations, so that when the 'shell' option is set
7094 there, the 'shellredir' option changes automatically unless it was
7095 explicitly set before.
7096 In the future pipes may be used for filtering and this option will
7097 become obsolete (at least for Unix).
7098 This option cannot be set from a |modeline| or in the |sandbox|, for
7099 security reasons.
7100
7101 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7102'shellslash' 'ssl' boolean (default off)
7103 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007104 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007106 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007107 powershell.exe. Backward slashes can still be typed, but they are
7108 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 Note that setting or resetting this option has no effect for some
7110 existing file names, thus this option needs to be set before opening
7111 any file for best results. This might change in the future.
7112 'shellslash' only works when a backslash can be used as a path
7113 separator. To test if this is so use: >
7114 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007115< Also see 'completeslash'.
7116
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007117 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7118'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7119 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007120 When on, use temp files for shell commands. When off use a pipe.
7121 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007122 Currently a pipe is only supported on Unix and MS-Windows 2K and
7123 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007124 :if has("filterpipe")
7125< The advantage of using a pipe is that nobody can read the temp file
7126 and the 'shell' command does not need to support redirection.
7127 The advantage of using a temp file is that the file type and encoding
7128 can be detected.
7129 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7130 |FilterWritePost| autocommands event are not triggered when
7131 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007132 The `system()` function does not respect this option and always uses
7133 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007134 NOTE: This option is set to the Vim default value when 'compatible'
7135 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007136
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 *'shelltype'* *'st'*
7138'shelltype' 'st' number (default 0)
7139 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007140 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 On the Amiga this option influences the way how the commands work
7142 which use a shell.
7143 0 and 1: always use the shell
7144 2 and 3: use the shell only to filter lines
7145 4 and 5: use shell only for ':sh' command
7146 When not using the shell, the command is executed directly.
7147
7148 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7149 1 and 3: use "shell cmd" to start external commands
7150
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007151 *'shellxescape'* *'sxe'*
7152'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007153 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007154 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007155 When 'shellxquote' is set to "(" then the characters listed in this
7156 option will be escaped with a '^' character. This makes it possible
7157 to execute most external commands with cmd.exe.
7158
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 *'shellxquote'* *'sxq'*
7160'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007161 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007162 for Win32, when 'shell' is
7163 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007164 for Win32, when 'shell' contains "sh"
7165 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 for Unix, when using system(): "\"")
7167 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 Quoting character(s), put around the command passed to the shell, for
7169 the "!" and ":!" commands. Includes the redirection. See
7170 'shellquote' to exclude the redirection. It's probably not useful
7171 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007172 When the value is '(' then ')' is appended. When the value is '"('
7173 then ')"' is appended.
7174 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007175 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007176 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7177 pwsh.exe which automatically strips off the first and last quote on a
7178 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7179 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007180 'shell', to reduce the need to set this option by the user. See
7181 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 This option cannot be set from a |modeline| or in the |sandbox|, for
7183 security reasons.
7184
7185 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7186'shiftround' 'sr' boolean (default off)
7187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 Round indent to multiple of 'shiftwidth'. Applies to > and <
7189 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7190 a multiple of 'shiftwidth' (this is Vi compatible).
7191 NOTE: This option is reset when 'compatible' is set.
7192
7193 *'shiftwidth'* *'sw'*
7194'shiftwidth' 'sw' number (default 8)
7195 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007196 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007197 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007198 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007199 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200
7201 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007202'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7203 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007204 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 This option helps to avoid all the |hit-enter| prompts caused by file
7206 messages, for example with CTRL-G, and to avoid some other messages.
7207 It is a list of flags:
7208 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007209 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7210 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7211 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7212 m use "[+]" instead of "[Modified]" *shm-m*
7213 n use "[New]" instead of "[New File]" *shm-n*
7214 r use "[RO]" instead of "[readonly]" *shm-r*
7215 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007217 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7218 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007219 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007220 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007221
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007222 o overwrite message for writing a file with subsequent *shm-o*
7223 message for reading a file (useful for ":wn" or when
7224 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007225 O message for reading a file overwrites any previous *shm-O*
7226 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007227 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7228 "search hit TOP, continuing at BOTTOM" messages; when using
7229 the search count do not show "W" after the count message (see
7230 S below)
7231 t truncate file message at the start if it is too long *shm-t*
7232 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007233 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007234 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007235 long to fit on the command line; "..." will appear in the
7236 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007237 W don't give "written" or "[w]" when writing a file *shm-W*
7238 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007239 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007240 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007241 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007242 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007243 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7244 match", "Pattern not found", "Back at original", etc.
7245 C don't give messages while scanning for ins-completion *shm-C*
7246 items, for instance "scanning tags"
7247 q use "recording" instead of "recording @a" *shm-q*
7248 F don't give the file info when editing a file, like *shm-F*
7249 `:silent` was used for the command; note that this also
7250 affects messages from autocommands
Bram Moolenaar938ae282023-02-20 20:44:55 +00007251 S do not show search count message when searching, e.g. *shm-S*
7252 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253
7254 This gives you the opportunity to avoid that a change between buffers
7255 requires you to hit <Enter>, but still gives as useful a message as
7256 possible for the space available. To get the whole message that you
7257 would have got with 'shm' empty, use ":file!"
7258 Useful values:
7259 shm= No abbreviation of message.
7260 shm=a Abbreviation, but no loss of information.
7261 shm=at Abbreviation, and truncate message when necessary.
7262
7263 NOTE: This option is set to the Vi default value when 'compatible' is
7264 set and to the Vim default value when 'compatible' is reset.
7265
7266 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7267'shortname' 'sn' boolean (default off)
7268 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 Filenames are assumed to be 8 characters plus one extension of 3
7270 characters. Multiple dots in file names are not allowed. When this
7271 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007272 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007274 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275
7276 *'showbreak'* *'sbr'* *E595*
7277'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007278 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007279 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 feature}
7281 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007282 values are "> " or "+++ ": >
7283 :set showbreak=>\
7284< Note the backslash to escape the trailing space. It's easier like
7285 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007286 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007287< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 comma (in a future version the comma might be used to separate the
7289 part that is shown at the end and at the start of a line).
7290 The characters are highlighted according to the '@' flag in
7291 'highlight'.
7292 Note that tabs after the showbreak will be displayed differently.
7293 If you want the 'showbreak' to appear in between line numbers, add the
7294 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007295 A window-local value overrules a global value. If the global value is
7296 set and you want no value in the current window use NONE: >
7297 :setlocal showbreak=NONE
7298<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007300'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7301 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007303 Show (partial) command in the last line of the screen. Set this
7304 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 In Visual mode the size of the selected area is shown:
7306 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007307 If the number of bytes is different it is also displayed: "2-6"
7308 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007310 - When selecting a block, the size in screen characters:
7311 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007312 This information can be displayed in an alternative location using the
7313 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 NOTE: This option is set to the Vi default value when 'compatible' is
7315 set and to the Vim default value when 'compatible' is reset.
7316
Luuk van Baalba936f62022-12-15 13:15:39 +00007317 *'showcmdloc'* *'sloc'*
7318'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007319 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007320 This option can be used to display the (partially) entered command in
7321 another location. Possible values are:
7322 last Last line of the screen (default).
7323 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007324 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007325 Setting this option to "statusline" or "tabline" means that these will
7326 be redrawn whenever the command changes, which can be on every key
7327 pressed.
7328 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7329 place the text. Without a custom 'statusline' or 'tabline' it will be
7330 displayed in a convenient location.
7331
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7333'showfulltag' 'sft' boolean (default off)
7334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 When completing a word in insert mode (see |ins-completion|) from the
7336 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007337 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 matched a C function, you can see a template for what arguments are
7339 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007340 Note that this doesn't work well together with having "longest" in
7341 'completeopt', because the completion from the search pattern may not
7342 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343
7344 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7345'showmatch' 'sm' boolean (default off)
7346 global
7347 When a bracket is inserted, briefly jump to the matching one. The
7348 jump is only done if the match can be seen on the screen. The time to
7349 show the match can be set with 'matchtime'.
7350 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007351 seen or not).
7352 This option is reset when 'paste' is set and restored when 'paste' is
7353 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 When the 'm' flag is not included in 'cpoptions', typing a character
7355 will immediately move the cursor back to where it belongs.
7356 See the "sm" field in 'guicursor' for setting the cursor shape and
7357 blinking when showing the match.
7358 The 'matchpairs' option can be used to specify the characters to show
7359 matches for. 'rightleft' and 'revins' are used to look for opposite
7360 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007361 Also see the matchparen plugin for highlighting the match when moving
7362 around |pi_paren.txt|.
7363 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364
7365 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7366'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7367 global
7368 If in Insert, Replace or Visual mode put a message on the last line.
7369 Use the 'M' flag in 'highlight' to set the type of highlighting for
7370 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007371 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 doesn't mean XIM is really active, especially when 'imactivatekey' is
7373 not set.
7374 NOTE: This option is set to the Vi default value when 'compatible' is
7375 set and to the Vim default value when 'compatible' is reset.
7376
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007377 *'showtabline'* *'stal'*
7378'showtabline' 'stal' number (default 1)
7379 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007380 The value of this option specifies when the line with tab page labels
7381 will be displayed:
7382 0: never
7383 1: only if there are at least two tab pages
7384 2: always
7385 This is both for the GUI and non-GUI implementation of the tab pages
7386 line.
7387 See |tab-page| for more information about tab pages.
7388
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 *'sidescroll'* *'ss'*
7390'sidescroll' 'ss' number (default 0)
7391 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 The minimal number of columns to scroll horizontally. Used only when
7393 the 'wrap' option is off and the cursor is moved off of the screen.
7394 When it is zero the cursor will be put in the middle of the screen.
7395 When using a slow terminal set it to a large number or 0. When using
7396 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7397 commands.
7398
7399 *'sidescrolloff'* *'siso'*
7400'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007401 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007403 right of the cursor if 'nowrap' is set. Setting this option to a
7404 value greater than 0 while having |'sidescroll'| also at a non-zero
7405 value makes some context visible in the line you are scrolling in
7406 horizontally (except at beginning of the line). Setting this option
7407 to a large value (like 999) has the effect of keeping the cursor
7408 horizontally centered in the window, as long as one does not come too
7409 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007410 After using the local value, go back the global value with one of
7411 these two: >
7412 setlocal sidescrolloff<
7413 setlocal sidescrolloff=-1
7414< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415
7416 Example: Try this together with 'sidescroll' and 'listchars' as
7417 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007418 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419
7420 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7421 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007422<
7423 *'signcolumn'* *'scl'*
7424'signcolumn' 'scl' string (default "auto")
7425 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007426 {not available when compiled without the |+signs|
7427 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007428 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007429 "auto" only when there is a sign to display
7430 "no" never
7431 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007432 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007433 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434
7435
7436 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7437'smartcase' 'scs' boolean (default off)
7438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 Override the 'ignorecase' option if the search pattern contains upper
7440 case characters. Only used when the search pattern is typed and
7441 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007442 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7444 recalling the search pattern from history and hitting <Enter>.
7445 NOTE: This option is reset when 'compatible' is set.
7446
7447 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7448'smartindent' 'si' boolean (default off)
7449 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 Do smart autoindenting when starting a new line. Works for C-like
7451 programs, but can also be used for other languages. 'cindent' does
7452 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007453 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007454 setting 'si' has no effect. 'indentexpr' is a more advanced
7455 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 Normally 'autoindent' should also be on when using 'smartindent'.
7457 An indent is automatically inserted:
7458 - After a line ending in '{'.
7459 - After a line starting with a keyword from 'cinwords'.
7460 - Before a line starting with '}' (only with the "O" command).
7461 When typing '}' as the first character in a new line, that line is
7462 given the same indent as the matching '{'.
7463 When typing '#' as the first character in a new line, the indent for
7464 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007465 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7467 When using the ">>" command, lines starting with '#' are not shifted
7468 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007469 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007470 This option is reset when 'paste' is set and restored when 'paste' is
7471 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472
7473 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7474'smarttab' 'sta' boolean (default off)
7475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007477 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7478 <BS> will delete a 'shiftwidth' worth of space at the start of the
7479 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007480 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007481 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7482 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007483 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007485 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007486 This option is reset when 'paste' is set and restored when 'paste' is
7487 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 NOTE: This option is reset when 'compatible' is set.
7489
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007490 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7491'smoothscroll' 'sms' boolean (default off)
7492 local to window
7493 Scrolling works with screen lines. When 'wrap' is set and the first
7494 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007495 above the window. "<<<" is displayed at the start of the first line,
7496 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007497 You may also want to add "lastline" to the 'display' option to show as
7498 much of the last line as possible.
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007499 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
7500 and scrolling with the mouse.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007501
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 *'softtabstop'* *'sts'*
7503'softtabstop' 'sts' number (default 0)
7504 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 Number of spaces that a <Tab> counts for while performing editing
7506 operations, like inserting a <Tab> or using <BS>. It "feels" like
7507 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7508 used. This is useful to keep the 'ts' setting at its standard value
7509 of 8, while being able to edit like it is set to 'sts'. However,
7510 commands like "x" still work on the actual characters.
7511 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007512 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007513 'softtabstop' is set to 0 when the 'paste' option is set and restored
7514 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7516 spaces is minimized by using <Tab>s.
7517 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7518 set.
7519 NOTE: This option is set to 0 when 'compatible' is set.
7520
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007521 If Vim is compiled with the |+vartabs| feature then the value of
7522 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7523 anything other than an empty string.
7524
Bram Moolenaar217ad922005-03-20 22:37:15 +00007525 *'spell'* *'nospell'*
7526'spell' boolean (default off)
7527 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007528 {not available when compiled without the |+syntax|
7529 feature}
7530 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007531 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007532
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007533 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007534'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007535 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007536 {not available when compiled without the |+syntax|
7537 feature}
7538 Pattern to locate the end of a sentence. The following word will be
7539 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007540 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007541 When this check is not wanted make this option empty.
7542 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007543 Be careful with special characters, see |option-backslash| about
7544 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007545 To set this option automatically depending on the language, see
7546 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007547
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007548 *'spellfile'* *'spf'*
7549'spellfile' 'spf' string (default empty)
7550 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007551 {not available when compiled without the |+syntax|
7552 feature}
7553 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007554 commands. It must end in ".{encoding}.add". You need to include the
7555 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007556 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007557 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007558 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007559 |zg| and |zw| commands can be used to access each. This allows using
7560 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007561 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007562 you: Using the first directory in 'runtimepath' that is writable. If
7563 there is no "spell" directory yet it will be created. For the file
7564 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007565 ignoring the region.
7566 The resulting ".spl" file will be used for spell checking, it does not
7567 have to appear in 'spelllang'.
7568 Normally one file is used for all regions, but you can add the region
7569 name if you want to. However, it will then only be used when
7570 'spellfile' is set to it, for entries in 'spelllang' only files
7571 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007572 This option cannot be set from a |modeline| or in the |sandbox|, for
7573 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007574
Bram Moolenaar217ad922005-03-20 22:37:15 +00007575 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007576'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007577 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007578 {not available when compiled without the |+syntax|
7579 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007580 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007581 on spellchecking will be done for these languages. Example: >
7582 set spelllang=en_us,nl,medical
7583< This means US English, Dutch and medical words are recognized. Words
7584 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007585 The word list name must consist of alphanumeric characters, a dash or
7586 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007587 recommended to separate the two letter language name from a
7588 specification. Thus "en-rare" is used for rare English words.
7589 A region name must come last and have the form "_xx", where "xx" is
7590 the two-letter, lower case region name. You can use more than one
7591 region by listing them: "en_us,en_ca" supports both US and Canadian
7592 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007593 Britain. (Note: currently en_au and en_nz dictionaries are older than
7594 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007595 If the name "cjk" is included East Asian characters are excluded from
7596 spell checking. This is useful when editing text that also has Asian
7597 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007598 Note that the "medical" dictionary does not exist, it is just an
7599 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007600 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007601 As a special case the name of a .spl file can be given as-is. The
7602 first "_xx" in the name is removed and used as the region name
7603 (_xx is an underscore, two letters and followed by a non-letter).
7604 This is mainly for testing purposes. You must make sure the correct
7605 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007606 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007607 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7608 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007609 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007610
Bram Moolenaar98692072006-02-04 00:57:42 +00007611 If the |spellfile.vim| plugin is active and you use a language name
7612 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7613 will ask you if you want to download the file.
7614
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007615 After this option has been set successfully, Vim will source the files
7616 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007617 up to the first character that is not an ASCII letter or number and
7618 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007619
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007620 *'spelloptions'* *'spo'*
7621'spelloptions' 'spo' string (default "")
7622 local to buffer
7623 {not available when compiled without the |+syntax|
7624 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007625 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007626 camel When a word is CamelCased, assume "Cased" is a
7627 separate word: every upper-case character in a word
7628 that comes after a lower case character indicates the
7629 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007630
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007631 *'spellsuggest'* *'sps'*
7632'spellsuggest' 'sps' string (default "best")
7633 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007634 {not available when compiled without the |+syntax|
7635 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007636 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007637 the |spellsuggest()| function. This is a comma-separated list of
7638 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007639
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007640 best Internal method that works best for English. Finds
7641 changes like "fast" and uses a bit of sound-a-like
7642 scoring to improve the ordering.
7643
7644 double Internal method that uses two methods and mixes the
7645 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007646 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007647 word. That only works when the language specifies
7648 sound folding. Can be slow and doesn't always give
7649 better results.
7650
7651 fast Internal method that only checks for simple changes:
7652 character inserts/deletes/swaps. Works well for
7653 simple typing mistakes.
7654
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007655 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007656 Not used for |spellsuggest()|. The number of
7657 suggestions is never more than the value of 'lines'
7658 minus two.
7659
Bram Moolenaar585ee072022-01-29 11:22:17 +00007660 timeout:{millisec} Limit the time searching for suggestions to
7661 {millisec} milli seconds. Applies to the following
7662 methods. When omitted the limit is 5000. When
7663 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007664 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007665
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007666 file:{filename} Read file {filename}, which must have two columns,
7667 separated by a slash. The first column contains the
7668 bad word, the second column the suggested good word.
7669 Example:
7670 theribal/terrible ~
7671 Use this for common mistakes that do not appear at the
7672 top of the suggestion list with the internal methods.
7673 Lines without a slash are ignored, use this for
7674 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007675 The word in the second column must be correct,
7676 otherwise it will not be used. Add the word to an
7677 ".add" file if it is currently flagged as a spelling
7678 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007679 The file is used for all languages.
7680
7681 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007682 trouble with spaces. Best is to call a function
7683 without arguments, see |expr-option-function|.
7684 |v:val| holds the badly spelled word. The expression
7685 must evaluate to a List of Lists, each with a
7686 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007687 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007688 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007689 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007690 internal methods use. A lower score is better.
7691 This may invoke |spellsuggest()| if you temporarily
7692 set 'spellsuggest' to exclude the "expr:" part.
7693 Errors are silently ignored, unless you set the
7694 'verbose' option to a non-zero value.
7695
7696 Only one of "best", "double" or "fast" may be used. The others may
7697 appear several times in any order. Example: >
7698 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7699<
7700 This option cannot be set from a |modeline| or in the |sandbox|, for
7701 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007702
7703
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7705'splitbelow' 'sb' boolean (default off)
7706 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 When on, splitting a window will put the new window below the current
7708 one. |:split|
7709
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007710 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007711'splitkeep' 'spk' string (default "cursor")
7712 global
7713 The value of this option determines the scroll behavior when opening,
7714 closing or resizing horizontal splits.
7715
7716 Possible values are:
7717 cursor Keep the same relative cursor position.
7718 screen Keep the text on the same screen line.
7719 topline Keep the topline the same.
7720
7721 For the "screen" and "topline" values, the cursor position will be
7722 changed when necessary. In this case, the jumplist will be populated
7723 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007724 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007725
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7727'splitright' 'spr' boolean (default off)
7728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 When on, splitting a window will put the new window right of the
7730 current one. |:vsplit|
7731
7732 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7733'startofline' 'sol' boolean (default on)
7734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007735 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007736 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007737 (if possible). This applies to the commands:
7738 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7739 - "d", "<<" and ">>" with a linewise operator
7740 - "%" with a count
7741 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7742 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743 In case of buffer changing commands the cursor is placed at the column
7744 where it was the last time the buffer was edited.
7745 NOTE: This option is set when 'compatible' is set.
7746
Bram Moolenaar00654022011-02-25 14:42:19 +01007747 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007749 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 {not available when compiled without the |+statusline|
7751 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007752 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 Also see |status-line|.
7754
7755 The option consists of printf style '%' items interspersed with
7756 normal text. Each status line item is of the form:
7757 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007758 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007759 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760
Bram Moolenaar238a5642006-02-21 22:12:05 +00007761 When the option starts with "%!" then it is used as an expression,
7762 evaluated and the result is used as the option value. Example: >
7763 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007764< The *g:statusline_winid* variable will be set to the |window-ID| of the
7765 window that the status line belongs to.
7766 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007767 Note that the "%!" expression is evaluated in the context of the
7768 current window and buffer, while %{} items are evaluated in the
7769 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007770
7771 When there is error while evaluating the option then it will be made
7772 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007773 When the result contains unprintable characters the result is
7774 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007775
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 Note that the only effect of 'ruler' when this option is set (and
7777 'laststatus' is 2) is controlling the output of |CTRL-G|.
7778
7779 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007780 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007782 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783 minwid Minimum width of the item, padding as set by '-' & '0'.
7784 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007785 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 on the left for text items. Numeric items will be
7787 shifted down to maxwid-2 digits followed by '>'number
7788 where number is the amount of missing digits, much like
7789 an exponential notation.
7790 item A one letter code as described below.
7791
7792 Following is a description of the possible statusline items. The
7793 second character in "item" is the type:
7794 N for number
7795 S for string
7796 F for flags as described below
7797 - not applicable
7798
7799 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007800 f S Path to the file in the buffer, as typed or relative to current
7801 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 F S Full path to the file in the buffer.
7803 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007804 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007806 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007808 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007810 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007812 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007813 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007814 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7816 being used: "<keymap>"
7817 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007818 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 B N As above, in hexadecimal.
7820 o N Byte number in file of byte under cursor, first byte is 1.
7821 Mnemonic: Offset from start of file (with one added)
7822 {not available when compiled without |+byte_offset| feature}
7823 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007824 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 l N Line number.
7826 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007827 c N Column number (byte index).
7828 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007829 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 p N Percentage through file in lines as in |CTRL-G|.
7831 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007832 percentage described for 'ruler'. Always 3 in length, unless
7833 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007834 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007835 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007837 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007838 Note that there is no '%' before the closing '}'. The
7839 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007840 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007841 {% - This is almost same as { except the result of the expression is
7842 re-evaluated as a statusline format string. Thus if the
7843 return value of expr contains % items they will get expanded.
7844 The expression can contain the } character, the end of
7845 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007846 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007847 func! Stl_filename() abort
7848 return "%t"
7849 endfunc
7850< `stl=%{Stl_filename()}` results in `"%t"`
7851 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007852 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 ( - Start of item group. Can be used for setting the width and
7854 alignment of a section. Must be followed by %) somewhere.
7855 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007856 T N For 'tabline': start of tab page N label. Use %T after the last
7857 label. This information is used for mouse clicks.
7858 X N For 'tabline': start of close tab N label. Use %X after the
7859 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7860 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 < - Where to truncate line if too long. Default is at the start.
7862 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007863 = - Separation point between alignment sections. Each section will
7864 be separated by an equal number of spaces. With one %= what
7865 comes after it will be right-aligned. With two %= there is a
7866 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007868 # - Set highlight group. The name must follow and then a # again.
7869 Thus use %#HLname# for highlight group HLname. The same
7870 highlighting is used, also for the statusline of non-current
7871 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007873 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007874 The difference between User{N} and StatusLine will be applied to
7875 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 The number N must be between 1 and 9. See |hl-User1..9|
7877
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007878 When displaying a flag, Vim removes the leading comma, if any, when
7879 that flag comes right after plaintext. This will make a nice display
7880 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881
Bram Moolenaar582fd852005-03-28 20:58:01 +00007882 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 not set) and a minwid is not set for the group, the whole group will
7884 become empty. This will make a group like the following disappear
7885 completely from the statusline when none of the flags are set. >
7886 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007887< Beware that an expression is evaluated each and every time the status
7888 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007889 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007890 While evaluating %{} the current buffer and current window will be set
7891 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007892 currently being drawn. The expression will evaluate in this context.
7893 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7894 real current buffer and "g:actual_curwin" to the |window-ID| of the
7895 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007896
Bram Moolenaar30b65812012-07-12 22:01:11 +02007897 The 'statusline' option will be evaluated in the |sandbox| if set from
7898 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007899 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007900
7901 It is not allowed to change text or jump to another window while
7902 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903
7904 If the statusline is not updated when you want it (e.g., after setting
7905 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007906 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007908 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 Otherwise the result is taken as flag text and applied to the rules
7910 described above.
7911
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007912 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007914 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915
7916 Examples:
7917 Emulate standard status line with 'ruler' set >
7918 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7919< Similar, but add ASCII value of char under the cursor (like "ga") >
7920 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7921< Display byte count and byte value, modified flag in red. >
7922 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7923 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7924< Display a ,GZ flag if a compressed file is loaded >
7925 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7926< In the |:autocmd|'s: >
7927 :let b:gzflag = 1
7928< And: >
7929 :unlet b:gzflag
7930< And define this function: >
7931 :function VarExists(var, val)
7932 : if exists(a:var) | return a:val | else | return '' | endif
7933 :endfunction
7934<
7935 *'suffixes'* *'su'*
7936'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 Files with these suffixes get a lower priority when multiple files
7939 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007940 suffixes. Spaces after the comma are ignored. A dot is also seen as
7941 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007942 separator, precede it with a backslash (see |option-backslash| about
7943 including spaces and backslashes).
7944 See 'wildignore' for completely ignoring files.
7945 The use of |:set+=| and |:set-=| is preferred when adding or removing
7946 suffixes from the list. This avoids problems when a future version
7947 uses another default.
7948
7949 *'suffixesadd'* *'sua'*
7950'suffixesadd' 'sua' string (default "")
7951 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007952 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 file for the "gf", "[I", etc. commands. Example: >
7954 :set suffixesadd=.java
7955<
7956 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7957'swapfile' 'swf' boolean (default on)
7958 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007959 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 swapfile is not wanted for a specific buffer. For example, with
7961 confidential information that even root must not be able to access.
7962 Careful: All text will be in memory:
7963 - Don't use this for big files.
7964 - Recovery will be impossible!
7965 A swapfile will only be present when |'updatecount'| is non-zero and
7966 'swapfile' is set.
7967 When 'swapfile' is reset, the swap file for the current buffer is
7968 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7969 non-zero, a swap file is immediately created.
7970 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007971 If you want to open a new buffer without creating a swap file for it,
7972 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007973 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974
7975 This option is used together with 'bufhidden' and 'buftype' to
7976 specify special kinds of buffers. See |special-buffers|.
7977
7978 *'swapsync'* *'sws'*
7979'swapsync' 'sws' string (default "fsync")
7980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007982 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 When this option is empty parts of the swap file may be in memory and
7984 not written to disk. When the system crashes you may lose more work.
7985 On Unix the system does a sync now and then without Vim asking for it,
7986 so the disadvantage of setting this option off is small. On some
7987 systems the swap file will not be written at all. For a unix system
7988 setting it to "sync" will use the sync() call instead of the default
7989 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007990 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991
7992 *'switchbuf'* *'swb'*
7993'switchbuf' 'swb' string (default "")
7994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01007996 This option is checked, when
7997 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
7998 etc.)
7999 - jumping to a tag using the |:stag| command.
8000 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8001 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8002 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008003 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008004 useopen If included, jump to the first open window in the
8005 current tab page that contains the specified buffer
8006 (if there is one). Otherwise: Do not examine other
8007 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008008 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008009 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008011 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008012 Otherwise: do not split, use current window (when used
8013 in the quickfix window: the previously used window or
8014 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008015 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008016 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008017 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008018 uselast If included, jump to the previously used window when
8019 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008021 *'synmaxcol'* *'smc'*
8022'synmaxcol' 'smc' number (default 3000)
8023 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008024 {not available when compiled without the |+syntax|
8025 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008026 Maximum column in which to search for syntax items. In long lines the
8027 text after this column is not highlighted and following lines may not
8028 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008029 This helps to avoid very slow redrawing for an XML file that is one
8030 long line.
8031 Set to zero to remove the limit.
8032
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 *'syntax'* *'syn'*
8034'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008035 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 {not available when compiled without the |+syntax|
8037 feature}
8038 When this option is set, the syntax with this name is loaded, unless
8039 syntax highlighting has been switched off with ":syntax off".
8040 Otherwise this option does not always reflect the current syntax (the
8041 b:current_syntax variable does).
8042 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008043 not automatically recognized. Example, in an IDL file:
8044 /* vim: set syntax=idl : */ ~
8045 When a dot appears in the value then this separates two filetype
8046 names. Example:
8047 /* vim: set syntax=c.doxygen : */ ~
8048 This will use the "c" syntax first, then the "doxygen" syntax.
8049 Note that the second one must be prepared to be loaded as an addition,
8050 otherwise it will be skipped. More than one dot may appear.
8051 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 :set syntax=OFF
8053< To switch syntax highlighting on according to the current value of the
8054 'filetype' option: >
8055 :set syntax=ON
8056< What actually happens when setting the 'syntax' option is that the
8057 Syntax autocommand event is triggered with the value as argument.
8058 This option is not copied to another buffer, independent of the 's' or
8059 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008060 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008062 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008063'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008064 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008065 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008066 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008067 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008068
8069 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008070 option and only when there is no GUI tab line. When 'e' is in
8071 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008072 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008073
8074 The value is evaluated like with 'statusline'. You can use
8075 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008076 the text to be displayed. Use "%1T" for the first label, "%2T" for
8077 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008078
Bram Moolenaare12bab32019-01-08 22:02:56 +01008079 When changing something that is used in 'tabline' that does not
8080 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008081 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008082
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008083 Keep in mind that only one of the tab pages is the current one, others
8084 are invisible and you can't jump to their windows.
8085
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008086
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008087 *'tabpagemax'* *'tpm'*
8088'tabpagemax' 'tpm' number (default 10)
8089 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008090 Maximum number of tab pages to be opened by the |-p| command line
8091 argument or the ":tab all" command. |tabpage|
8092
8093
8094 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095'tabstop' 'ts' number (default 8)
8096 local to buffer
8097 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008098 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099
8100 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008101 appear wrong in many places, e.g., when printing it.
8102 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103
8104 There are four main ways to use tabs in Vim:
8105 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8106 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008107 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008109 This is the recommended way, the file will look the same with other
8110 tools and when listing it in a terminal.
8111 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8112 'expandtab'. This way you will always insert spaces. The
8113 formatting will never be messed up when 'tabstop' is changed (leave
8114 it at 8 just in case). The file will be a bit larger.
8115 You do need to check if no Tabs exist in the file. You can get rid
8116 of them by first setting 'expandtab' and using `%retab!`, making
8117 sure the value of 'tabstop' is set correctly.
8118 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008119 'expandtab'. This way you will always insert spaces. The
8120 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008121 You do need to check if no Tabs exist in the file, just like in the
8122 item just above.
8123 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008124 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008125 works when using Vim to edit the file, other tools assume a tabstop
8126 is worth 8 spaces.
8127 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 'noexpandtab'. This should then work (for initial indents only)
8129 for any tabstop setting that people use. It might be nice to have
8130 tabs after the first non-blank inserted as spaces if you do this
8131 though. Otherwise aligned comments will be wrong when 'tabstop' is
8132 changed.
8133
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008134 If Vim is compiled with the |+vartabs| feature then the value of
8135 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8136 than an empty string.
8137
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8139'tagbsearch' 'tbs' boolean (default on)
8140 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008142 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 searching makes searching for a tag a LOT faster, but a linear search
8144 will find more tags if the tags file wasn't properly sorted.
8145 Vim normally assumes that your tags files are sorted, or indicate that
8146 they are not sorted. Only when this is not the case does the
8147 'tagbsearch' option need to be switched off.
8148
8149 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008150 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151 certain files, or retry all files with a linear search. When
8152 'tagbsearch' is off, only a linear search is done.
8153
8154 Linear searching is done anyway, for one file, when Vim finds a line
8155 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008156 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157< [The whitespace before and after the '0' must be a single <Tab>]
8158
8159 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008160 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161 instead of a normal tag name, a retry is done with a linear search.
8162 Tags in unsorted tags files, and matches with different case will only
8163 be found in the retry.
8164
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008165 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008166 linear search can be avoided when case is ignored. Use a value of '2'
8167 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8168 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008169 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8170 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8171 used for this as well. Note that case must be folded to uppercase for
8172 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008173
8174 By default, tag searches are case-sensitive. Case is ignored when
8175 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8176 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008177 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8178 'tagcase' is "smart", and the pattern contains only lowercase
8179 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008180
8181 When 'tagbsearch' is off, tags searching is slower when a full match
8182 exists, but faster when no full match exists. Tags in unsorted tags
8183 files may only be found with 'tagbsearch' off.
8184 When the tags file is not sorted, or sorted in a wrong way (not on
8185 ASCII byte value), 'tagbsearch' should be off, or the line given above
8186 must be included in the tags file.
8187 This option doesn't affect commands that find all matching tags (e.g.,
8188 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008190 *'tagcase'* *'tc'*
8191'tagcase' 'tc' string (default "followic")
8192 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008193 This option specifies how case is handled when searching the tags
8194 file:
8195 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008196 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008197 ignore Ignore case
8198 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008199 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008200 NOTE: This option is set to the Vi default value when 'compatible' is
8201 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008202
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008203 *'tagfunc'* *'tfu'*
8204'tagfunc' 'tfu' string (default: empty)
8205 local to buffer
8206 {not available when compiled without the |+eval|
8207 feature}
8208 This option specifies a function to be used to perform tag searches.
8209 The function gets the tag pattern and should return a List of matching
8210 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008211 function and an example. The value can be the name of a function, a
8212 |lambda| or a |Funcref|. See |option-value-function| for more
8213 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008214
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215 *'taglength'* *'tl'*
8216'taglength' 'tl' number (default 0)
8217 global
8218 If non-zero, tags are significant up to this number of characters.
8219
8220 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8221'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8222 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008223 If on and using a tags file in another directory, file names in that
8224 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 NOTE: This option is set to the Vi default value when 'compatible' is
8226 set and to the Vim default value when 'compatible' is reset.
8227
8228 *'tags'* *'tag'* *E433*
8229'tags' 'tag' string (default "./tags,tags", when compiled with
8230 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8231 global or local to buffer |global-local|
8232 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008233 include a space or comma in a file name, precede it with backslashes
8234 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 When a file name starts with "./", the '.' is replaced with the path
8236 of the current file. But only when the 'd' flag is not included in
8237 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8238 |tags-option|.
8239 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008240 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8241 find all files named "tags" below "/lib". The filename itself cannot
8242 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008243 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008244 The |tagfiles()| function can be used to get a list of the file names
8245 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008246 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8247 files are also supported. They are automatically recognized. The
8248 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8249 differences are ignored (MS-Windows). |emacs-tags|
8250 The use of |:set+=| and |:set-=| is preferred when adding or removing
8251 file names from the list. This avoids problems when a future version
8252 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253
8254 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8255'tagstack' 'tgst' boolean (default on)
8256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257 When on, the |tagstack| is used normally. When off, a ":tag" or
8258 ":tselect" command with an argument will not push the tag onto the
8259 tagstack. A following ":tag" without an argument, a ":pop" command or
8260 any other command that uses the tagstack will use the unmodified
8261 tagstack, but does change the pointer to the active entry.
8262 Resetting this option is useful when using a ":tag" command in a
8263 mapping which should not change the tagstack.
8264
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008265 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008266'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008267 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008268 {only available when compiled with the |+tcl/dyn|
8269 feature}
8270 Specifies the name of the Tcl shared library. The default is
8271 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008272 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008273 This option cannot be set from a |modeline| or in the |sandbox|, for
8274 security reasons.
8275
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 *'term'* *E529* *E530* *E531*
8277'term' string (default is $TERM, if that fails:
8278 in the GUI: "builtin_gui"
8279 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008280 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008281 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 on Unix: "ansi"
8283 on VMS: "ansi"
8284 on Win 32: "win32")
8285 global
8286 Name of the terminal. Used for choosing the terminal control
8287 characters. Environment variables are expanded |:set_env|.
8288 For example: >
8289 :set term=$TERM
8290< See |termcap|.
8291
8292 *'termbidi'* *'tbidi'*
8293 *'notermbidi'* *'notbidi'*
8294'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 {only available when compiled with the |+arabic|
8297 feature}
8298 The terminal is in charge of Bi-directionality of text (as specified
8299 by Unicode). The terminal is also expected to do the required shaping
8300 that some languages (such as Arabic) require.
8301 Setting this option implies that 'rightleft' will not be set when
8302 'arabic' is set and the value of 'arabicshape' will be ignored.
8303 Note that setting 'termbidi' has the immediate effect that
8304 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8305 This option is reset when the GUI is started.
8306 For further details see |arabic.txt|.
8307
8308 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008309'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 Encoding used for the terminal. This specifies what character
8312 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008313 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008314 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008315 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008316 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8318 Any attempts to set a different value will be rejected, and an error
8319 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008320 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 because the Win32 system always passes Unicode characters.
8322 When empty, the same encoding is used as for the 'encoding' option.
8323 This is the normal value.
8324 Not all combinations for 'termencoding' and 'encoding' are valid. See
8325 |encoding-table|.
8326 The value for this option must be supported by internal conversions or
8327 iconv(). When this is not possible no conversion will be done and you
8328 will probably experience problems with non-ASCII characters.
8329 Example: You are working with the locale set to euc-jp (Japanese) and
8330 want to edit a UTF-8 file: >
8331 :let &termencoding = &encoding
8332 :set encoding=utf-8
8333< You need to do this when your system has no locale support for UTF-8.
8334
Bram Moolenaar938ae282023-02-20 20:44:55 +00008335 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008336'termguicolors' 'tgc' boolean (default off)
8337 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008338 {not available when compiled without the
8339 |+termguicolors| feature}
8340 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008341 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008342
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008343 Requires a ISO-8613-3 compatible terminal. If setting this option
8344 does not work (produces a colorless UI) reading |xterm-true-color|
8345 might help.
8346
8347 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8348 is required. Use this check to find out: >
8349 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008350< This requires Vim to be built with the |+vtp| feature.
8351
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008352 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008353
8354 When using Vim with Windows Terminal, the background of Windows
8355 Terminal is normally filled with the Vim background color. Setting
8356 'termguicolors' and the guibg of the Normal highlight group to NONE
8357 will make the background transparent: >
8358 :hi Normal guibg=NONE
8359<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008360 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008361
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008362 *'termwinkey'* *'twk'*
8363'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008364 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008365 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008366 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008367 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008368 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008369< The string must be one key stroke but can be multiple bytes.
8370 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008371 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008372 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008373
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008374 *'termwinscroll'* *'twsl'*
8375'termwinscroll' 'twsl' number (default 10000)
8376 local to buffer
8377 {not available when compiled without the
8378 |+terminal| feature}
8379 Number of scrollback lines to keep. When going over this limit the
8380 first 10% of the scrollback lines are deleted. This is just to reduce
8381 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008382 Also used as a limit for text sent to the terminal in one write,
8383 multiplied by the number of columns times 3 (average number of bytes
8384 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008385
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008386 *'termwinsize'* *'tws'*
8387'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008388 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008389 Size used when opening the |terminal| window. Format:
8390 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008391 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008392 - When set with a "x" (e.g., "24x80") the terminal size is not
8393 adjusted to the window size. If the window is smaller only the
8394 top-left part is displayed.
8395 - When set with a "*" (e.g., "10*50") the terminal size follows the
8396 window size, but will not be smaller than the specified rows and/or
8397 columns.
8398 - When rows is zero then use the height of the window.
8399 - When columns is zero then use the width of the window.
8400 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008401 - Can be overruled in the |term_start()| options with "term_rows" and
8402 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008403
8404 Examples:
8405 "30x0" uses 30 rows and the current window width.
8406 "20*0" uses at least 20 rows and the current window width.
8407 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008408 Note that the command running in the terminal window may still change
8409 the size of the terminal. In that case the Vim window will be
8410 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008411
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008412 *'termwintype'* *'twt'*
8413'termwintype' 'twt' string (default "")
8414 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008415 {only available when compiled with the |terminal|
8416 feature on MS-Windows}
8417 Specify the virtual console (pty) used when opening the terminal
8418 window.
8419
8420 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008421 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008422 "winpty" use winpty, fail if not supported
8423 "conpty" use |ConPTY|, fail if not supported
8424
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008425 |ConPTY| support depends on the platform. Windows 10 October 2018
8426 Update is the first version that supports ConPTY, however it is still
8427 considered unstable. ConPTY might become stable in the next release
8428 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008429 supported then you cannot open a terminal window.
8430
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 *'terse'* *'noterse'*
8432'terse' boolean (default off)
8433 global
8434 When set: Add 's' flag to 'shortmess' option (this makes the message
8435 for a search that hits the start or end of the file not being
8436 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8437 shortens a lot of messages}
8438
8439 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8440'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8441 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 This option is obsolete. Use 'fileformats'.
8443 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8444 set to the default value for the current system. When 'textauto' is
8445 reset, 'fileformats' is made empty.
8446 NOTE: This option is set to the Vi default value when 'compatible' is
8447 set and to the Vim default value when 'compatible' is reset.
8448
8449 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008450'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451 others: default off)
8452 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 This option is obsolete. Use 'fileformat'.
8454 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8455 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8456 "unix".
8457
8458 *'textwidth'* *'tw'*
8459'textwidth' 'tw' number (default 0)
8460 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 Maximum width of text that is being inserted. A longer line will be
8462 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008463 this.
8464 'textwidth' is set to 0 when the 'paste' option is set and restored
8465 when 'paste' is reset.
8466 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008468 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469 NOTE: This option is set to 0 when 'compatible' is set.
8470
8471 *'thesaurus'* *'tsr'*
8472'thesaurus' 'tsr' string (default "")
8473 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008475 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8476 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008477
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008478 This option is not used if 'thesaurusfunc' is set, either for the
8479 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008480
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008481 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008483 name. See |option-backslash| about using backslashes. The use of
8484 |:set+=| and |:set-=| is preferred when adding or removing directories
8485 from the list. This avoids problems when a future version uses
8486 another default. Backticks cannot be used in this option for security
8487 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008489 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008490'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008491 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008492 {not available when compiled without the |+eval|
8493 feature}
8494 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008495 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008496 The value can be the name of a function, a |lambda| or a |Funcref|.
8497 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008498
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008499 This option cannot be set from a |modeline| or in the |sandbox|, for
8500 security reasons.
8501
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8503'tildeop' 'top' boolean (default off)
8504 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 When on: The tilde command "~" behaves like an operator.
8506 NOTE: This option is reset when 'compatible' is set.
8507
8508 *'timeout'* *'to'* *'notimeout'* *'noto'*
8509'timeout' 'to' boolean (default on)
8510 global
8511 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008512'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 These two options together determine the behavior when part of a
8515 mapped key sequence or keyboard code has been received:
8516
8517 'timeout' 'ttimeout' action ~
8518 off off do not time out
8519 on on or off time out on :mappings and key codes
8520 off on time out on key codes
8521
8522 If both options are off, Vim will wait until either the complete
8523 mapping or key sequence has been received, or it is clear that there
8524 is no mapping or key sequence for the received characters. For
8525 example: if you have mapped "vl" and Vim has received 'v', the next
8526 character is needed to see if the 'v' is followed by an 'l'.
8527 When one of the options is on, Vim will wait for about 1 second for
8528 the next character to arrive. After that the already received
8529 characters are interpreted as single characters. The waiting time can
8530 be changed with the 'timeoutlen' option.
8531 On slow terminals or very busy systems timing out may cause
8532 malfunctioning cursor keys. If both options are off, Vim waits
8533 forever after an entered <Esc> if there are key codes that start
8534 with <Esc>. You will have to type <Esc> twice. If you do not have
8535 problems with key codes, but would like to have :mapped key
8536 sequences not timing out in 1 second, set the 'ttimeout' option and
8537 reset the 'timeout' option.
8538
8539 NOTE: 'ttimeout' is reset when 'compatible' is set.
8540
8541 *'timeoutlen'* *'tm'*
8542'timeoutlen' 'tm' number (default 1000)
8543 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008544
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008546'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008547 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008548 The time in milliseconds that is waited for a key code or mapped key
8549 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8550 when part of a command has been typed.
8551 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8552 different timeout value for key codes is desired set 'ttimeoutlen' to
8553 a non-negative number.
8554
8555 ttimeoutlen mapping delay key code delay ~
8556 < 0 'timeoutlen' 'timeoutlen'
8557 >= 0 'timeoutlen' 'ttimeoutlen'
8558
8559 The timeout only happens when the 'timeout' and 'ttimeout' options
8560 tell so. A useful setting would be >
8561 :set timeout timeoutlen=3000 ttimeoutlen=100
8562< (time out on mapping after three seconds, time out on key codes after
8563 a tenth of a second).
8564
8565 *'title'* *'notitle'*
8566'title' boolean (default off, on when title can be restored)
8567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 When on, the title of the window will be set to the value of
8569 'titlestring' (if it is not empty), or to:
8570 filename [+=-] (path) - VIM
8571 Where:
8572 filename the name of the file being edited
8573 - indicates the file cannot be modified, 'ma' off
8574 + indicates the file was modified
8575 = indicates the file is read-only
8576 =+ indicates the file is read-only and modified
8577 (path) is the path of the file being edited
8578 - VIM the server name |v:servername| or "VIM"
8579 Only works if the terminal supports setting window titles
8580 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008581 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8583 *X11*
8584 When Vim was compiled with HAVE_X11 defined, the original title will
8585 be restored if possible. The output of ":version" will include "+X11"
8586 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8587 works for the icon name |'icon'|.
8588 But: When Vim was started with the |-X| argument, restoring the title
8589 will not work (except in the GUI).
8590 If the title cannot be restored, it is set to the value of 'titleold'.
8591 You might want to restore the title outside of Vim then.
8592 When using an xterm from a remote machine you can use this command:
8593 rsh machine_name xterm -display $DISPLAY &
8594 then the WINDOWID environment variable should be inherited and the
8595 title of the window should change back to what it should be after
8596 exiting Vim.
8597
8598 *'titlelen'*
8599'titlelen' number (default 85)
8600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008602 title. When the title is longer, only the end of the path name is
8603 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 Using a percentage makes this adapt to the width of the window. But
8605 it won't work perfectly, because the actual number of characters
8606 available also depends on the font used and other things in the title
8607 bar. When 'titlelen' is zero the full path is used. Otherwise,
8608 values from 1 to 30000 percent can be used.
8609 'titlelen' is also used for the 'titlestring' option.
8610
8611 *'titleold'*
8612'titleold' string (default "Thanks for flying Vim")
8613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 This option will be used for the window title when exiting Vim if the
8615 original title cannot be restored. Only happens if 'title' is on or
8616 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008617 This option cannot be set from a |modeline| or in the |sandbox|, for
8618 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 *'titlestring'*
8620'titlestring' string (default "")
8621 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 When this option is not empty, it will be used for the title of the
8623 window. This happens only when the 'title' option is on.
8624 Only works if the terminal supports setting window titles (currently
8625 Amiga console, Win32 console, all GUI versions and terminals with a
8626 non-empty 't_ts' option).
8627 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008628 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008629
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 When this option contains printf-style '%' items, they will be
8631 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008632 This option cannot be set in a modeline when 'modelineexpr' is off.
8633
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008635 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8637< The value of 'titlelen' is used to align items in the middle or right
8638 of the available space.
8639 Some people prefer to have the file name first: >
8640 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8641< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008642 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 separating space only when needed.
8644 NOTE: Use of special characters in 'titlestring' may cause the display
8645 to be garbled (e.g., when it contains a CR or NL character).
8646 {not available when compiled without the |+statusline| feature}
8647
8648 *'toolbar'* *'tb'*
8649'toolbar' 'tb' string (default "icons,tooltips")
8650 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008651 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008652 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 possible values are:
8654 icons Toolbar buttons are shown with icons.
8655 text Toolbar buttons shown with text.
8656 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008657 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 tooltips Tooltips are active for toolbar buttons.
8659 Tooltips refer to the popup help text which appears after the mouse
8660 cursor is placed over a toolbar button for a brief moment.
8661
8662 If you want the toolbar to be shown with icons as well as text, do the
8663 following: >
8664 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008665< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 will show icons if both are requested.
8667
8668 If none of the strings specified in 'toolbar' are valid or if
8669 'toolbar' is empty, this option is ignored. If you want to disable
8670 the toolbar, you need to set the 'guioptions' option. For example: >
8671 :set guioptions-=T
8672< Also see |gui-toolbar|.
8673
8674 *'toolbariconsize'* *'tbis'*
8675'toolbariconsize' 'tbis' string (default "small")
8676 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008677 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008678 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008679 tiny Use tiny icons.
8680 small Use small icons (default).
8681 medium Use medium-sized icons.
8682 large Use large icons.
8683 huge Use even larger icons.
8684 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008686 the current theme. Common dimensions are giant=48x48, huge=32x32,
8687 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688
8689 If 'toolbariconsize' is empty, the global default size as determined
8690 by user preferences or the current theme is used.
8691
8692 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8693'ttybuiltin' 'tbi' boolean (default on)
8694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 When on, the builtin termcaps are searched before the external ones.
8696 When off the builtin termcaps are searched after the external ones.
8697 When this option is changed, you should set the 'term' option next for
8698 the change to take effect, for example: >
8699 :set notbi term=$TERM
8700< See also |termcap|.
8701 Rationale: The default for this option is "on", because the builtin
8702 termcap entries are generally better (many systems contain faulty
8703 xterm entries...).
8704
8705 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008706'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008708 Indicates a fast terminal connection. More characters will be sent to
8709 the screen for redrawing, instead of using insert/delete line
8710 commands. Improves smoothness of redrawing when there are multiple
8711 windows and the terminal does not support a scrolling region.
8712 Also enables the extra writing of characters at the end of each screen
8713 line for lines that wrap. This helps when using copy/paste with the
8714 mouse in an xterm and other terminals.
8715
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008716 The default used to be set only for some terminal names, but these
8717 days nearly all terminals are fast, therefore the default is now "on".
8718 If you have a slow connection you may want to set this option off,
8719 e.g. depending on the host name: >
8720 if hostname() =~ 'faraway'
8721 set nottyfast
8722 endif
8723<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 *'ttymouse'* *'ttym'*
8725'ttymouse' 'ttym' string (default depends on 'term')
8726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 {only in Unix and VMS, doesn't work in the GUI; not
8728 available when compiled without |+mouse|}
8729 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008730 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 *xterm-mouse*
8732 xterm xterm-like mouse handling. The mouse generates
8733 "<Esc>[Mscr", where "scr" is three bytes:
8734 "s" = button state
8735 "c" = column plus 33
8736 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008737 This only works up to 223 columns! See "dec",
8738 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008739 xterm2 Works like "xterm", but with the xterm reporting the
8740 mouse position while the mouse is dragged. This works
8741 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008742 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 work. See below for how Vim detects this
8744 automatically.
8745 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008746 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008748 for the row and column. No other mouse events are
8749 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 *dec-mouse*
8751 dec DEC terminal mouse handling. The mouse generates a
8752 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008753 This is also available for an Xterm, if it was
8754 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 *jsbterm-mouse*
8756 jsbterm JSB term mouse handling.
8757 *pterm-mouse*
8758 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008759 *urxvt-mouse*
8760 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008761 The mouse works only if the terminal supports this
8762 encoding style, but it does not have 223 columns limit
8763 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008764 *sgr-mouse*
8765 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008766 mouse reporting. The mouse works even in columns
8767 beyond 223. This option is backward compatible with
8768 "xterm2" because it can also decode "xterm2" style
8769 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770
8771 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008772 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8773 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8775 recognized, if enabled at compile time. DEC terminal mouse codes
8776 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008777 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8778 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008780 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8781 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8782 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008783 If the terminfo/termcap entry "XM" exists and the first number is
8784 "1006" then 'ttymouse' will be set to "sgr". This works for many
8785 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008786 Additionally, if vim is compiled with the |+termresponse| feature and
8787 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008788 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008790 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8791 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8792 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008793 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8794 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795 :set t_RV=
8796<
8797 *'ttyscroll'* *'tsl'*
8798'ttyscroll' 'tsl' number (default 999)
8799 global
8800 Maximum number of lines to scroll the screen. If there are more lines
8801 to scroll the window is redrawn. For terminals where scrolling is
8802 very slow and redrawing is not slow this can be set to a small number,
8803 e.g., 3, to speed up displaying.
8804
8805 *'ttytype'* *'tty'*
8806'ttytype' 'tty' string (default from $TERM)
8807 global
8808 Alias for 'term', see above.
8809
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008810 *'undodir'* *'udir'*
8811'undodir' 'udir' string (default ".")
8812 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008813 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008814 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008815 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008816 "." means using the directory of the file. The undo file name for
8817 "file.txt" is ".file.txt.un~".
8818 For other directories the file name is the full path of the edited
8819 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008820 When writing: The first directory that exists is used. "." always
8821 works, no directories after "." will be used for writing.
8822 When reading all entries are tried to find an undo file. The first
8823 undo file that exists is used. When it cannot be read an error is
8824 given, no further entry is used.
8825 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008826 This option cannot be set from a |modeline| or in the |sandbox|, for
8827 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008828
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008829 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008830'undofile' 'udf' boolean (default off)
8831 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008832 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008833 When on, Vim automatically saves undo history to an undo file when
8834 writing a buffer to a file, and restores undo history from the same
8835 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008836 The directory where the undo file is stored is specified by 'undodir'.
8837 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008838 The undo file is not read when 'undoreload' causes the buffer from
8839 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008840 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008841 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008842
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008844'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008845 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008847 is kept in memory, higher numbers will cause more memory to be used.
8848 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8850 itself: >
8851 set ul=0
8852< But you can also get Vi compatibility by including the 'u' flag in
8853 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008854 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008855 Set to -1 for no undo at all. You might want to do this only for the
8856 current buffer: >
8857 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008859
8860 The local value is set to -123456 when the global value is to be used.
8861
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008862 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008864 *'undoreload'* *'ur'*
8865'undoreload' 'ur' number (default 10000)
8866 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008867 Save the whole buffer for undo when reloading it. This applies to the
8868 ":e!" command and reloading for when the buffer changed outside of
8869 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008870 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008871 of lines is smaller than the value of this option.
8872 Set this option to zero to disable undo for a reload.
8873
8874 When saving undo for a reload, any undo file is not read.
8875
8876 Note that this causes the whole buffer to be stored in memory. Set
8877 this option to a lower value if you run out of memory.
8878
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879 *'updatecount'* *'uc'*
8880'updatecount' 'uc' number (default: 200)
8881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882 After typing this many characters the swap file will be written to
8883 disk. When zero, no swap file will be created at all (see chapter on
8884 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8885 Vim with the "-n" option, see |startup|. When editing in readonly
8886 mode this option will be initialized to 10000.
8887 The swapfile can be disabled per buffer with |'swapfile'|.
8888 When 'updatecount' is set from zero to non-zero, swap files are
8889 created for all buffers that have 'swapfile' set. When 'updatecount'
8890 is set to zero, existing swap files are not deleted.
8891 Also see |'swapsync'|.
8892 This option has no meaning in buffers where |'buftype'| is "nofile"
8893 or "nowrite".
8894
8895 *'updatetime'* *'ut'*
8896'updatetime' 'ut' number (default 4000)
8897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 If this many milliseconds nothing is typed the swap file will be
8899 written to disk (see |crash-recovery|). Also used for the
8900 |CursorHold| autocommand event.
8901
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008902 *'varsofttabstop'* *'vsts'*
8903'varsofttabstop' 'vsts' string (default "")
8904 local to buffer
8905 {only available when compiled with the |+vartabs|
8906 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008907 A list of the number of spaces that a <Tab> counts for while editing,
8908 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8909 width <Tab>s are being inserted, while in fact a mixture of spaces
8910 and <Tab>s is used. Tab widths are separated with commas, with the
8911 final value applying to all subsequent tabs.
8912
8913 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008914 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008915 to use the following: >
8916 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008917< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8918 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008919
8920 Note that the value of |'softtabstop'| will be ignored while
8921 'varsofttabstop' is set.
8922
8923 *'vartabstop'* *'vts'*
8924'vartabstop' 'vts' string (default "")
8925 local to buffer
8926 {only available when compiled with the |+vartabs|
8927 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008928 A list of the number of spaces that a <Tab> in the file counts for,
8929 separated by commas. Each value corresponds to one tab, with the
8930 final value applying to all subsequent tabs. For example: >
8931 :set vartabstop=4,20,10,8
8932< This will make the first tab 4 spaces wide, the second 20 spaces,
8933 the third 10 spaces, and all following tabs 8 spaces.
8934
8935 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8936 is set.
8937
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938 *'verbose'* *'vbs'*
8939'verbose' 'vbs' number (default 0)
8940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 When bigger than zero, Vim will give messages about what it is doing.
8942 Currently, these messages are given:
8943 >= 1 When the viminfo file is read or written.
8944 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008945 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008946 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008947 >= 8 Files for which a group of autocommands is executed.
8948 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008949 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950 >= 12 Every executed function.
8951 >= 13 When an exception is thrown, caught, finished, or discarded.
8952 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008953 >= 15 Every executed Ex command from a script (truncated at 200
8954 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008955 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956
8957 This option can also be set with the "-V" argument. See |-V|.
8958 This option is also set by the |:verbose| command.
8959
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008960 When the 'verbosefile' option is set then the verbose messages are not
8961 displayed.
8962
8963 *'verbosefile'* *'vfile'*
8964'verbosefile' 'vfile' string (default empty)
8965 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008966 When not empty all messages are written in a file with this name.
8967 When the file exists messages are appended.
8968 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008969 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008970 Setting 'verbosefile' to a new value is like making it empty first.
8971 The difference with |:redir| is that verbose messages are not
8972 displayed when 'verbosefile' is set.
8973
Bram Moolenaar071d4272004-06-13 20:20:40 +00008974 *'viewdir'* *'vdir'*
Christian Brabandtb8b1c8e2023-06-23 22:23:01 +01008975'viewdir' 'vdir' string (default for Amiga "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008976 for Win32: "$HOME/vimfiles/view",
Christian Brabandtb8b1c8e2023-06-23 22:23:01 +01008977 for Unix: "$HOME/.vim/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008978 for macOS: "$VIM/vimfiles/view"
8979 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008981 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008982 feature}
8983 Name of the directory where to store files for |:mkview|.
8984 This option cannot be set from a |modeline| or in the |sandbox|, for
8985 security reasons.
8986
8987 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008988'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008989 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008990 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008992 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008993 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008994 word save and restore ~
8995 cursor cursor position in file and in window
8996 folds manually created folds, opened/closed folds and local
8997 fold options
8998 options options and mappings local to a window or buffer (not
8999 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009000 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 slash backslashes in file names replaced with forward
9002 slashes
9003 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009004 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009005 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009007 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009009 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010
9011 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009012'viminfo' 'vi' string (Vi default: "", Vim default for
9013 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009014 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9015 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009017 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009018 feature}
9019 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009020 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9021 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009022 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009023 consisting of a single character identifying the particular parameter,
9024 followed by a number or string which specifies the value of that
9025 parameter. If a particular character is left out, then the default
9026 value is used for that parameter. The following is a list of the
9027 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009029 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 ! When included, save and restore global variables that start
9031 with an uppercase letter, and don't contain a lowercase
9032 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009033 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009034 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009035 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 " Maximum number of lines saved for each register. Old name of
9037 the '<' item, with the disadvantage that you need to put a
9038 backslash before the ", otherwise it will be recognized as the
9039 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009040 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009041 % When included, save and restore the buffer list. If Vim is
9042 started with a file name argument, the buffer list is not
9043 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009044 buffer list is restored from the viminfo file. Quickfix
9045 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9046 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009047 When followed by a number, the number specifies the maximum
9048 number of buffers that are stored. Without a number all
9049 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009050 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009051 ' Maximum number of previously edited files for which the marks
9052 are remembered. This parameter must always be included when
9053 'viminfo' is non-empty.
9054 Including this item also means that the |jumplist| and the
9055 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009056 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009057 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009058 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059 patterns are also saved. When not included, the value of
9060 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009061 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009062 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009063 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009064 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009065 < Maximum number of lines saved for each register. If zero then
9066 registers are not saved. When not included, all lines are
9067 saved. '"' is the old name for this item.
9068 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009069 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009071 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009072 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009073 c When included, convert the text in the viminfo file from the
9074 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009075 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009076 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 f Whether file marks need to be stored. If zero, file marks ('0
9078 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009079 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009081 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082 h Disable the effect of 'hlsearch' when loading the viminfo
9083 file. When not included, it depends on whether ":nohlsearch"
9084 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009085 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009087 the 'n'. Must be at the end of the option! If the
9088 'viminfofile' option is set, that file name overrides the one
9089 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009090 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009091 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009092 r Removable media. The argument is a string (up to the next
9093 ','). This parameter can be given several times. Each
9094 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009095 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009096 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9097 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9098 ignored. Maximum length of each 'r' argument is 50
9099 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009100 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009101 s Maximum size of an item in Kbyte. If zero then registers are
9102 not saved. Currently only applies to registers. The default
9103 "s10" will exclude registers with more than 10 Kbyte of text.
9104 Also see the '<' item above: line count limit.
9105
9106 Example: >
9107 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9108<
9109 '50 Marks will be remembered for the last 50 files you
9110 edited.
9111 <1000 Contents of registers (up to 1000 lines each) will be
9112 remembered.
9113 s100 Registers with more than 100 Kbyte text are skipped.
9114 :0 Command-line history will not be saved.
9115 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9116 no / Since '/' is not specified, the default will be used,
9117 that is, save all of the search history, and also the
9118 previous search and substitute patterns.
9119 no % The buffer list will not be saved nor read back.
9120 no h 'hlsearch' highlighting will be restored.
9121
9122 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9123 load the contents of the file, this is not done automatically.
9124
9125 This option cannot be set from a |modeline| or in the |sandbox|, for
9126 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009127 NOTE: This option is set to the Vim default value when 'compatible'
9128 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009129
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009130 *'viminfofile'* *'vif'*
9131'viminfofile' 'vif' string (default: "")
9132 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009133 {not available when compiled without the |+viminfo|
9134 feature}
9135 When non-empty, overrides the file name used for viminfo.
9136 When equal to "NONE" no viminfo file will be read or written.
9137 This option can be set with the |-i| command line flag. The |--clean|
9138 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009139 This option cannot be set from a |modeline| or in the |sandbox|, for
9140 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009141
Bram Moolenaar071d4272004-06-13 20:20:40 +00009142 *'virtualedit'* *'ve'*
9143'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009144 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009145 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146 block Allow virtual editing in Visual block mode.
9147 insert Allow virtual editing in Insert mode.
9148 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009149 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009150 none When used as the local value, do not allow virtual
9151 editing even when the global value is set. When used
9152 as the global value, "none" is the same as "".
9153 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009154
Bram Moolenaar071d4272004-06-13 20:20:40 +00009155 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009156 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157 of the line. Useful for selecting a rectangle in Visual mode and
9158 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009159 "onemore" is not the same, it will only allow moving the cursor just
9160 after the last character of the line. This makes some commands more
9161 consistent. Previously the cursor was always past the end of the line
9162 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009163 break some plugins or Vim scripts. For example because |l| can move
9164 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009165 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009166 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009167 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009168 It doesn't make sense to combine "all" with "onemore", but you will
9169 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009170 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009171 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172
9173 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9174'visualbell' 'vb' boolean (default off)
9175 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009176 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009177 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009178 use: >
9179 :set vb t_vb=
9180< If you want a short flash, you can use this on many terminals: >
9181 :set vb t_vb=[?5h$<100>[?5l
9182< Here $<100> specifies the time, you can use a smaller or bigger value
9183 to get a shorter or longer flash.
9184
9185 Note: Vim will limit the bell to once per half a second. This avoids
9186 having to wait for the flashing to finish when there are lots of
9187 bells, e.g. on key repeat. This also happens without 'visualbell'
9188 set.
9189
Bram Moolenaar071d4272004-06-13 20:20:40 +00009190 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9191 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9192 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009193
9194 Note: When the GUI starts, 't_vb' is reset to its default value. You
9195 might want to set it again in your |gvimrc|.
9196
Bram Moolenaar071d4272004-06-13 20:20:40 +00009197 Does not work on the Amiga, you always get a screen flash.
9198 Also see 'errorbells'.
9199
9200 *'warn'* *'nowarn'*
9201'warn' boolean (default on)
9202 global
9203 Give a warning message when a shell command is used while the buffer
9204 has been changed.
9205
9206 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9207'weirdinvert' 'wiv' boolean (default off)
9208 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009209 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009210 It is provided for backwards compatibility with version 4.x.
9211 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9212 vice versa. Has no effect when the GUI is running.
9213
9214 *'whichwrap'* *'ww'*
9215'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009217 Allow specified keys that move the cursor left/right to move to the
9218 previous/next line when the cursor is on the first/last character in
9219 the line. Concatenate characters to allow this for these keys:
9220 char key mode ~
9221 b <BS> Normal and Visual
9222 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009223 h "h" Normal and Visual (not recommended)
9224 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009225 < <Left> Normal and Visual
9226 > <Right> Normal and Visual
9227 ~ "~" Normal
9228 [ <Left> Insert and Replace
9229 ] <Right> Insert and Replace
9230 For example: >
9231 :set ww=<,>,[,]
9232< allows wrap only when cursor keys are used.
9233 When the movement keys are used in combination with a delete or change
9234 operator, the <EOL> also counts for a character. This makes "3h"
9235 different from "3dh" when the cursor crosses the end of a line. This
9236 is also true for "x" and "X", because they do the same as "dl" and
9237 "dh". If you use this, you may also want to use the mapping
9238 ":map <BS> X" to make backspace delete the character in front of the
9239 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009240 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009241 line (not an empty line) then it will not move to the next line. This
9242 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009243 NOTE: This option is set to the Vi default value when 'compatible' is
9244 set and to the Vim default value when 'compatible' is reset.
9245
9246 *'wildchar'* *'wc'*
9247'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249 Character you have to type to start wildcard expansion in the
9250 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009251 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009252 The character is not recognized when used inside a macro. See
9253 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009254 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009255 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009256 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009257< NOTE: This option is set to the Vi default value when 'compatible' is
9258 set and to the Vim default value when 'compatible' is reset.
9259
9260 *'wildcharm'* *'wcm'*
9261'wildcharm' 'wcm' number (default: none (0))
9262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009263 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009264 recognized when used inside a macro. You can find "spare" command-line
9265 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009266 you'll never actually type 'wildcharm', just use it in mappings that
9267 automatically invoke completion mode, e.g.: >
9268 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009269 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009270< Then after typing :ss you can use CTRL-P & CTRL-N.
9271
9272 *'wildignore'* *'wig'*
9273'wildignore' 'wig' string (default "")
9274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009275 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009276 patterns is ignored when expanding |wildcards|, completing file or
9277 directory names, and influences the result of |expand()|, |glob()| and
9278 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009279 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9280 Also see 'suffixes'.
9281 Example: >
9282 :set wildignore=*.o,*.obj
9283< The use of |:set+=| and |:set-=| is preferred when adding or removing
9284 a pattern from the list. This avoids problems when a future version
9285 uses another default.
9286
Bram Moolenaar94950a92010-12-02 16:01:29 +01009287
Bram Moolenaar81af9252010-12-10 20:35:50 +01009288 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009289'wildignorecase' 'wic' boolean (default off)
9290 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009291 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009292 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009293 Does not apply when the shell is used to expand wildcards, which
9294 happens when there are special characters.
9295
9296
Bram Moolenaar071d4272004-06-13 20:20:40 +00009297 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009298'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009299 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009300 When 'wildmenu' is on, command-line completion operates in an enhanced
9301 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009302 the possible matches are shown.
9303 When 'wildoptions' contains "pum", then the completion matches are
9304 shown in a popup menu. Otherwise they are displayed just above the
9305 command line, with the first match highlighted (overwriting the status
9306 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009307 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009308 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9309 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9310 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009311 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009312 If there are more matches than can fit in the line, a ">" is shown on
9313 the right and/or a "<" is shown on the left. The status line scrolls
9314 as needed.
9315 The "wildmenu" mode is abandoned when a key is hit that is not used
9316 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009317 While the "wildmenu" is active, not using the popup menu, the
9318 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009319
9320 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9321 <Down> - in filename/menu name completion: move into a
9322 subdirectory or submenu.
9323 <CR> - in menu completion, when the cursor is just after a
9324 dot: move into a submenu.
9325 <Up> - in filename/menu name completion: move up into
9326 parent directory or parent menu.
9327
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009328 When using the popup menu for command line completion, the following
9329 keys have special meanings:
9330 <Down> - select next match (like CTRL-N)
9331 <Left> - in filename/menu name completion: move up into
9332 parent directory or parent menu.
9333 <Right> - in filename/menu name completion: move into a
9334 subdirectory or submenu.
9335 <Up> - select previous match (like CTRL-P)
9336 CTRL-E - end completion, go back to what was there before
9337 selecting a match.
9338 CTRL-N - go to the next entry
9339 CTRL-P - go to the previous entry
9340 CTRL-Y - accept the currently selected match and stop
9341 completion.
9342
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343 This makes the menus accessible from the console |console-menus|.
9344
9345 If you prefer the <Left> and <Right> keys to move the cursor instead
9346 of selecting a different match, use this: >
9347 :cnoremap <Left> <Space><BS><Left>
9348 :cnoremap <Right> <Space><BS><Right>
9349<
9350 The "WildMenu" highlighting is used for displaying the current match
9351 |hl-WildMenu|.
9352
9353 *'wildmode'* *'wim'*
9354'wildmode' 'wim' string (Vim default: "full")
9355 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009356 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009357 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009358 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009359 first part specifies the behavior for the first use of 'wildchar',
9360 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009361
9362 Each part consists of a colon separated list consisting of the
9363 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009364 "" Complete only the first match.
9365 "full" Complete the next full match. After the last match,
9366 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009367 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009368 "longest" Complete till longest common string. If this doesn't
9369 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009370 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009371 "lastused" When completing buffer names and more than one buffer
9372 matches, sort buffers by time last used (other than
9373 the current buffer).
9374 When there is only a single match, it is fully completed in all cases.
9375
9376 Examples of useful colon-separated values:
9377 "longest:full" Like "longest", but also start 'wildmenu' if it is
9378 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009379 "list:full" When more than one match, list all matches and
9380 complete first match.
9381 "list:longest" When more than one match, list all matches and
9382 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009383 "list:lastused" When more than one buffer matches, list all matches
9384 and sort buffers by time last used (other than the
9385 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009386
9387 Examples: >
9388 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009389< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009390 :set wildmode=longest,full
9391< Complete longest common string, then each full match >
9392 :set wildmode=list:full
9393< List all matches and complete each full match >
9394 :set wildmode=list,full
9395< List all matches without completing, then each full match >
9396 :set wildmode=longest,list
9397< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009398 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009399
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009400 *'wildoptions'* *'wop'*
9401'wildoptions' 'wop' string (default "")
9402 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009403 A list of words that change how |cmdline-completion| is done.
9404 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009405 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009406 this value is specified, wildcard expansion will not
9407 be used for completion. The matches will be sorted by
9408 the "best match" rather than alphabetically sorted.
9409 This will find more matches than the wildcard
9410 expansion. Currently fuzzy matching based completion
9411 is not supported for file and directory names and
9412 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009413 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009414 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009415 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009416 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009417 is displayed per line. Often used tag kinds are:
9418 d #define
9419 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009420
Bram Moolenaar071d4272004-06-13 20:20:40 +00009421 *'winaltkeys'* *'wak'*
9422'winaltkeys' 'wak' string (default "menu")
9423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009424 {only used in Win32, Motif, GTK and Photon GUI}
9425 Some GUI versions allow the access to menu entries by using the ALT
9426 key in combination with a character that appears underlined in the
9427 menu. This conflicts with the use of the ALT key for mappings and
9428 entering special characters. This option tells what to do:
9429 no Don't use ALT keys for menus. ALT key combinations can be
9430 mapped, but there is no automatic handling. This can then be
9431 done with the |:simalt| command.
9432 yes ALT key handling is done by the windowing system. ALT key
9433 combinations cannot be mapped.
9434 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009435 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009436 keys can be mapped.
9437 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9438 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009439 This option is not used for <F10>; on Win32 and with GTK <F10> will
9440 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009441
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009442 *'wincolor'* *'wcr'*
9443'wincolor' 'wcr' string (default empty)
9444 local to window
9445 Highlight group name to use for this window instead of the Normal
9446 color |hl-Normal|.
9447
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009448 *'window'* *'wi'*
9449'window' 'wi' number (default screen height - 1)
9450 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009451 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9452 window and the value is smaller than 'lines' minus one. The screen
9453 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009454 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9455 in a much smarter way, taking care of wrapping lines.
9456 When resizing the Vim window, the value is smaller than 1 or more than
9457 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009458 Note: Do not confuse this with the height of the Vim window, use
9459 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009460
Bram Moolenaar071d4272004-06-13 20:20:40 +00009461 *'winheight'* *'wh'* *E591*
9462'winheight' 'wh' number (default 1)
9463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009464 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009465 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009466 focus goes to a window that is smaller, its size is increased, at the
9467 cost of the height of other windows.
9468 Set 'winheight' to a small number for normal editing.
9469 Set it to 999 to make the current window fill most of the screen.
9470 Other windows will be only 'winminheight' high. This has the drawback
9471 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9472 to create only two windows, set the option after startup is done,
9473 using the |VimEnter| event: >
9474 au VimEnter * set winheight=999
9475< Minimum value is 1.
9476 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009477 height of the current window.
9478 'winheight' applies to the current window. Use 'winminheight' to set
9479 the minimal height for other windows.
9480
9481 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9482'winfixheight' 'wfh' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02009483 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009484 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009485 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9486 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009487 The height may be changed anyway when running out of room.
9488
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009489 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9490'winfixwidth' 'wfw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02009491 local to window |local-noglobal|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009492 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009493 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009494 The width may be changed anyway when running out of room.
9495
Bram Moolenaar071d4272004-06-13 20:20:40 +00009496 *'winminheight'* *'wmh'*
9497'winminheight' 'wmh' number (default 1)
9498 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009499 The minimal height of a window, when it's not the current window.
9500 This is a hard minimum, windows will never become smaller.
9501 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9502 status bar) if necessary. They will return to at least one line when
9503 they become active (since the cursor has to have somewhere to go.)
9504 Use 'winheight' to set the minimal height of the current window.
9505 This option is only checked when making a window smaller. Don't use a
9506 large number, it will cause errors when opening more than a few
9507 windows. A value of 0 to 3 is reasonable.
9508
9509 *'winminwidth'* *'wmw'*
9510'winminwidth' 'wmw' number (default 1)
9511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009512 The minimal width of a window, when it's not the current window.
9513 This is a hard minimum, windows will never become smaller.
9514 When set to zero, windows may be "squashed" to zero columns (i.e. just
9515 a vertical separator) if necessary. They will return to at least one
9516 line when they become active (since the cursor has to have somewhere
9517 to go.)
9518 Use 'winwidth' to set the minimal width of the current window.
9519 This option is only checked when making a window smaller. Don't use a
9520 large number, it will cause errors when opening more than a few
9521 windows. A value of 0 to 12 is reasonable.
9522
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009523 *'winptydll'*
9524'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9525 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009526 {only available when compiled with the |terminal|
9527 feature on MS-Windows}
9528 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009529 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009530 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009531 a fallback.
9532 Environment variables are expanded |:set_env|.
9533 This option cannot be set from a |modeline| or in the |sandbox|, for
9534 security reasons.
9535
Bram Moolenaar071d4272004-06-13 20:20:40 +00009536 *'winwidth'* *'wiw'* *E592*
9537'winwidth' 'wiw' number (default 20)
9538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009539 Minimal number of columns for the current window. This is not a hard
9540 minimum, Vim will use fewer columns if there is not enough room. If
9541 the current window is smaller, its size is increased, at the cost of
9542 the width of other windows. Set it to 999 to make the current window
9543 always fill the screen. Set it to a small number for normal editing.
9544 The width is not adjusted after one of the commands to change the
9545 width of the current window.
9546 'winwidth' applies to the current window. Use 'winminwidth' to set
9547 the minimal width for other windows.
9548
9549 *'wrap'* *'nowrap'*
9550'wrap' boolean (default on)
9551 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009552 This option changes how text is displayed. It doesn't change the text
9553 in the buffer, see 'textwidth' for that.
9554 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009555 displaying continues on the next line. When off lines will not wrap
9556 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 moved to a part that is not shown, the screen will scroll
9558 horizontally.
9559 The line will be broken in the middle of a word if necessary. See
9560 'linebreak' to get the break at a word boundary.
9561 To make scrolling horizontally a bit more useful, try this: >
9562 :set sidescroll=5
9563 :set listchars+=precedes:<,extends:>
9564< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009565 This option can't be set from a |modeline| when the 'diff' option is
9566 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009567
9568 *'wrapmargin'* *'wm'*
9569'wrapmargin' 'wm' number (default 0)
9570 local to buffer
9571 Number of characters from the right window border where wrapping
9572 starts. When typing text beyond this limit, an <EOL> will be inserted
9573 and inserting continues on the next line.
9574 Options that add a margin, such as 'number' and 'foldcolumn', cause
9575 the text width to be further reduced. This is Vi compatible.
9576 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009577 This option is set to 0 when 'paste' is set and restored when 'paste'
9578 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009579 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009580
9581 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9582'wrapscan' 'ws' boolean (default on) *E384* *E385*
9583 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009584 Searches wrap around the end of the file. Also applies to |]s| and
9585 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009586
9587 *'write'* *'nowrite'*
9588'write' boolean (default on)
9589 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009590 Allows writing files. When not set, writing a file is not allowed.
9591 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009592 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009593 argument. Filtering text is still possible, even though this requires
9594 writing a temporary file.
9595
9596 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9597'writeany' 'wa' boolean (default off)
9598 global
9599 Allows writing to any file with no need for "!" override.
9600
9601 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9602'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9603 otherwise)
9604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009605 Make a backup before overwriting a file. The backup is removed after
9606 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009607 also on.
9608 WARNING: Switching this option off means that when Vim fails to write
9609 your buffer correctly and then, for whatever reason, Vim exits, you
9610 lose both the original file and what you were writing. Only reset
9611 this option if your file system is almost full and it makes the write
9612 fail (and make sure not to exit Vim until the write was successful).
9613 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009614 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009615 Depending on 'backupcopy' the backup is a new file or the original
9616 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009617 NOTE: This option is set to the default value when 'compatible' is
9618 set.
9619
9620 *'writedelay'* *'wd'*
9621'writedelay' 'wd' number (default 0)
9622 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009623 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009624 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009625 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009626
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009627 *'xtermcodes'* *'noxtermcodes'*
9628'xtermcodes' boolean (default on)
9629 global
9630 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009631 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009632 key codes and number of colors from the terminal. This takes care of
9633 various configuration options of the terminal that cannot be obtained
9634 from the termlib/terminfo entry, see |xterm-codes|.
9635 A side effect may be that t_Co changes and Vim will redraw the
9636 display.
9637
9638
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009639 vim:tw=78:ts=8:noet:ft=help:norl: