blob: 493fa879e5c11d9baf593f8f3d2ec261153eff65 [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).
195A few examples: >
196 :set tags=tags\ /usr/tags results in "tags /usr/tags"
197 :set tags=tags\\,file results in "tags\,file"
198 :set tags=tags\\\ file results in "tags\ file"
199
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000200The "|" character separates a ":set" command from a following command. To
201include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000202'titlestring' option to "hi|there": >
203 :set titlestring=hi\|there
204This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
205 :set titlestring=hi|set iconstring=there
206
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200207Similarly, in legacy script the double quote character starts a comment. To
208include the '"' in the option value, use '\"' instead. This example sets the
209'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000210 :set titlestring=hi\ \"there\"
211
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200212In |Vim9| script it's simpler, comments start with a '#' character, and only
213when preceded by white space. A backslash is needed less often: >
214 vim9script
215 set titlestring=hi\ "there"
216 set titlestring=hi#there#
217 set titlestring=hi\ \#there#
218
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100219For Win32 backslashes in file names are mostly not removed. More precise: For
220options that expect a file name (those where environment variables are
221expanded) a backslash before a normal file name character is not removed. But
222a backslash before a special character (space, backslash, comma, etc.) is used
223like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224There is one special situation, when the value starts with "\\": >
225 :set dir=\\machine\path results in "\\machine\path"
226 :set dir=\\\\machine\\path results in "\\machine\path"
227 :set dir=\\path\\file results in "\\path\file" (wrong!)
228For the first one the start is kept, but for the second one the backslashes
229are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000230halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231result which is probably not what you want. Avoid it.
232
233 *add-option-flags* *remove-option-flags*
234 *E539* *E550* *E551* *E552*
235Some options are a list of flags. When you want to add a flag to such an
236option, without changing the existing ones, you can do it like this: >
237 :set guioptions+=a
238Remove a flag from an option like this: >
239 :set guioptions-=a
240This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000241Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
243doesn't appear.
244
245 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000246Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000247environment variable exists the '$' and the following environment variable
248name is replaced with its value. If it does not exist the '$' and the name
249are not modified. Any non-id character (not a letter, digit or '_') may
250follow the environment variable name. That character and what follows is
251appended to the value of the environment variable. Examples: >
252 :set term=$TERM.new
253 :set path=/usr/$INCLUDE,$HOME/include,.
254When adding or removing a string from an option with ":set opt-=val" or ":set
255opt+=val" the expansion is done before the adding or removing.
256
257
258Handling of local options *local-options*
259
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200260Note: The following also applies to |global-local| options.
261
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100263has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264allows you to set 'list' in one window but not in another. And set
265'shiftwidth' to 3 in one buffer and 4 in another.
266
267The following explains what happens to these local options in specific
268situations. You don't really need to know all of this, since Vim mostly uses
269the option values you would expect. Unfortunately, doing what the user
270expects is a bit complicated...
271
272When splitting a window, the local options are copied to the new window. Thus
273right after the split the contents of the two windows look the same.
274
275When editing a new buffer, its local option values must be initialized. Since
276the local options of the current buffer might be specifically for that buffer,
277these are not used. Instead, for each buffer-local option there also is a
278global value, which is used for new buffers. With ":set" both the local and
279global value is changed. With "setlocal" only the local value is changed,
280thus this value is not used when editing a new buffer.
281
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200282When editing a buffer that has been edited before, the options from the window
283that was last closed are used again. If this buffer has been edited in this
284window, the values from back then are used. Otherwise the values from the
285last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286
287It's possible to set a local window option specifically for a type of buffer.
288When you edit another buffer in the same window, you don't want to keep
289using these local window options. Therefore Vim keeps a global value of the
290local window options, which is used when editing another buffer. Each window
291has its own copy of these values. Thus these are local to the window, but
292global to all buffers in the window. With this you can do: >
293 :e one
294 :set list
295 :e two
296Now the 'list' option will also be set in "two", since with the ":set list"
297command you have also set the global value. >
298 :set nolist
299 :e one
300 :setlocal list
301 :e two
302Now the 'list' option is not set, because ":set nolist" resets the global
303value, ":setlocal list" only changes the local value and ":e two" gets the
304global value. Note that if you do this next: >
305 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200306You will get back the 'list' value as it was the last time you edited "one".
307The options local to a window are remembered for each buffer. This also
308happens when the buffer is not loaded, but they are lost when the buffer is
309wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
Christian Brabandt596ad662023-08-16 00:11:09 +0200311Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200312
313The following local window options won't be copied over when new windows are
314created, thus they behave slightly differently:
315
316 Option Reason ~
317 'previewwindow' there can only be a single one
318 'scroll' specific to existing window
319 'winfixheight' specific to existing window
320 'winfixwidth' specific to existing window
321
Christian Brabandt596ad662023-08-16 00:11:09 +0200322Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200323
324The following local buffer options won't be copied over when new buffers are
325created, thus they behave slightly differently:
326
327 Option Reason ~
328 'filetype' explicitly set by autocommands
329 'syntax' explicitly set by autocommands
330 'bufhidden' denote |special-buffers|
331 'buftype' denote |special-buffers|
332 'readonly' will be detected automatically
333 'modified' will be detected automatically
334
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100336:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337 current buffer or window. Not all options have a
338 local value. If the option does not have a local
339 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200340 With the "all" argument: display local values for all
341 local options.
342 Without argument: Display local values for all local
343 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000345 local value. For a global/local boolean option, when
346 the global value is being used, "--" is displayed
347 before the option name.
348 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000351:setl[ocal] {option}< Set the local value of {option} to its global value by
352 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000353
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100354:se[t] {option}< For |global-local| options: Remove the local value of
355 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356
357 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100358:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 option without changing the local value.
360 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200361 With the "all" argument: display global values for all
362 local options.
363 Without argument: display global values for all local
364 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365
366For buffer-local and window-local options:
367 Command global value local value ~
368 :set option=value set set
369 :setlocal option=value - set
370:setglobal option=value set -
371 :set option? - display
372 :setlocal option? - display
373:setglobal option? display -
374
375
376Global options with a local value *global-local*
377
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000378Options are global when you mostly use one value for all buffers and windows.
379For some global options it's useful to sometimes have a different local value.
380You can set the local value with ":setlocal". That buffer or window will then
381use the local value, while other buffers and windows continue using the global
382value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383
384For example, you have two windows, both on C source code. They use the global
385'makeprg' option. If you do this in one of the two windows: >
386 :set makeprg=gmake
387then the other window will switch to the same value. There is no need to set
388the 'makeprg' option in the other C source window too.
389However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000390another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000391files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392 :setlocal makeprg=perlmake
393You can switch back to using the global value by making the local value empty: >
394 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100395This only works for a string option. For a number or boolean option you need
396to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100398Note that for non-boolean and non-number options using "<" copies the global
399value to the local value, it doesn't switch back to using the global value
400(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000401 :set path<
402This will make the local value of 'path' empty, so that the global value is
403used. Thus it does the same as: >
404 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000405Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406":setlocal" on a global option might work differently then.
407
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000408 *option-value-function*
409Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000410'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000411a function name or a function reference or a lambda function. When using a
412lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000413>
414 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000415 set opfunc=function('MyOpFunc')
416 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000417 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000418
419Set to a script-local function: >
420 set opfunc=s:MyLocalFunc
421 set opfunc=<SID>MyLocalFunc
422In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
423the script: >
424 set opfunc=MyLocalFunc
425
426Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000427 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000428 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000429
430Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000431 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000432
433Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000434 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000435 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000436
437In Vim9 script, in a compiled function, you can use a lambda, but a
438closured does not work, because the function will be called without the
439context of where it was defined.
440
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000441
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442Setting the filetype
443
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200444:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445 Set the 'filetype' option to {filetype}, but only if
446 not done yet in a sequence of (nested) autocommands.
447 This is short for: >
448 :if !did_filetype()
449 : setlocal filetype={filetype}
450 :endif
451< This command is used in a filetype.vim file to avoid
452 setting the 'filetype' option twice, causing different
453 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200454
455 When the optional FALLBACK argument is present, a
456 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100457 'filetype'. This is to be used for filetype
458 detections that are just a guess. |did_filetype()|
459 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200460
Bram Moolenaard58e9292011-02-09 17:07:58 +0100461 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
463:opt[ions] Open a window for viewing and setting all options.
464 Options are grouped by function.
465 Offers short help for each option. Hit <CR> on the
466 short help to open a help window with more help for
467 the option.
468 Modify the value of the option and hit <CR> on the
469 "set" line to set the new value. For window and
470 buffer specific options, the last accessed window is
471 used to set the option value in, unless this is a help
472 window, in which case the window below help window is
473 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100474 {not available when compiled without the |+eval|
475 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476
477 *$HOME*
478Using "~" is like using "$HOME", but it is only recognized at the start of an
479option and after a space or comma.
480
481On Unix systems "~user" can be used too. It is replaced by the home directory
482of user "user". Example: >
483 :set path=~mool/include,/usr/include,.
484
485On Unix systems the form "${HOME}" can be used too. The name between {} can
486contain non-id characters then. Note that if you want to use this for the
487"gf" command, you need to add the '{' and '}' characters to 'isfname'.
488
489NOTE: expanding environment variables and "~/" is only done with the ":set"
490command, not when assigning a value to an option with ":let".
491
Bram Moolenaarc572da52017-08-27 16:52:01 +0200492 *$HOME-windows*
493On MS-Windows, if $HOME is not defined as an environment variable, then
494at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200495If $HOMEDRIVE is not set then $USERPROFILE is used.
496
497This expanded value is not exported to the environment, this matters when
498running an external command: >
499 :echo system('set | findstr ^HOME=')
500and >
501 :echo luaeval('os.getenv("HOME")')
502should echo nothing (an empty string) despite exists('$HOME') being true.
503When setting $HOME to a non-empty string it will be exported to the
504subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200505
Bram Moolenaar071d4272004-06-13 20:20:40 +0000506
507Note the maximum length of an expanded option is limited. How much depends on
508the system, mostly it is something like 256 or 1024 characters.
509
510 *:fix* *:fixdel*
511:fix[del] Set the value of 't_kD':
512 't_kb' is 't_kD' becomes ~
513 CTRL-? CTRL-H
514 not CTRL-? CTRL-?
515
Bram Moolenaar82be4842021-01-11 19:40:15 +0100516 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
518 If your delete key terminal code is wrong, but the
519 code for backspace is alright, you can put this in
520 your .vimrc: >
521 :fixdel
522< This works no matter what the actual code for
523 backspace is.
524
525 If the backspace key terminal code is wrong you can
526 use this: >
527 :if &term == "termname"
528 : set t_kb=^V<BS>
529 : fixdel
530 :endif
531< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000532 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533 with your terminal name.
534
535 If your <Delete> key sends a strange key sequence (not
536 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
537 :if &term == "termname"
538 : set t_kD=^V<Delete>
539 :endif
540< Where "^V" is CTRL-V and "<Delete>" is the delete key
541 (don't type eight characters!). Replace "termname"
542 with your terminal name.
543
544 *Linux-backspace*
545 Note about Linux: By default the backspace key
546 produces CTRL-?, which is wrong. You can fix it by
547 putting this line in your rc.local: >
548 echo "keycode 14 = BackSpace" | loadkeys
549<
550 *NetBSD-backspace*
551 Note about NetBSD: If your backspace doesn't produce
552 the right code, try this: >
553 xmodmap -e "keycode 22 = BackSpace"
554< If this works, add this in your .Xmodmap file: >
555 keysym 22 = BackSpace
556< You need to restart for this to take effect.
557
558==============================================================================
5592. Automatically setting options *auto-setting*
560
561Besides changing options with the ":set" command, there are three alternatives
562to set options automatically for one or more files:
563
5641. When starting Vim initializations are read from various places. See
565 |initialization|. Most of them are performed for all editing sessions,
566 and some of them depend on the directory where Vim is started.
567 You can create an initialization file with |:mkvimrc|, |:mkview| and
568 |:mksession|.
5692. If you start editing a new file, the automatic commands are executed.
570 This can be used to set options for files matching a particular pattern and
571 many other things. See |autocommand|.
5723. If you start editing a new file, and the 'modeline' option is on, a
573 number of lines at the beginning and end of the file are checked for
574 modelines. This is explained here.
575
576 *modeline* *vim:* *vi:* *ex:* *E520*
577There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100578 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100580[text{white}] empty or any text followed by at least one blank
581 character (<Space> or <Tab>); "ex:" always requires at
582 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200583{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200584[white] optional white space
585{options} a list of option settings, separated with white space
586 or ':', where each part between ':' is the argument
587 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588
Bram Moolenaar14b69452013-06-29 23:05:20 +0200589Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000590 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200591 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593The second form (this is compatible with some versions of Vi):
594
Bram Moolenaarade0d392020-01-21 22:33:58 +0100595 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596
Bram Moolenaarade0d392020-01-21 22:33:58 +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 Moolenaar22dbc772013-06-28 18:44:48 +0200600{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
601[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200602se[t] the string "set " or "se " (note the space); When
603 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200604{options} a list of options, separated with white space, which
605 is the argument for a ":set" command
606: a colon
607[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608
Bram Moolenaar14b69452013-06-29 23:05:20 +0200609Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000610 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200611 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200613The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
614chance that a normal word like "lex:" is caught. There is one exception:
615"vi:" and "vim:" can also be at the start of the line (for compatibility with
616version 3.0). Using "ex:" at the start of the line will be ignored (this
617could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618
Hu Jialun9dcd3492021-08-28 20:42:50 +0200619If the modeline is disabled within a modeline, subsequent modelines will be
620ignored. This is to allow turning off modeline on a per-file basis. This is
621useful when a line looks like a modeline but isn't. For example, it would be
622good to start a YAML file containing strings like "vim:" with
623 # vim: nomodeline ~
624so as to avoid modeline misdetection. Following options on the same line
625after modeline deactivation, if any, are still evaluated (but you would
626normally not have any).
627
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628 *modeline-local*
629The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000630buffer and window that contain the file. Although it's possible to set global
631options from a modeline, this is unusual. If you have two windows open and
632the files in it set the same global option to a different value, the result
633depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000635When editing a file that was already loaded, only the window-local options
636from the modeline are used. Thus if you manually changed a buffer-local
637option after opening the file, it won't be changed if you edit the same buffer
638in another window. But window-local options will be set.
639
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640 *modeline-version*
641If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200642number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643 vim{vers}: version {vers} or later
644 vim<{vers}: version before {vers}
645 vim={vers}: version {vers}
646 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100647{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
648For example, to use a modeline only for Vim 7.0:
649 /* vim700: set foldmethod=marker */ ~
650To use a modeline for Vim after version 7.2:
651 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652There can be no blanks between "vim" and the ":".
653
654
655The number of lines that are checked can be set with the 'modelines' option.
656If 'modeline' is off or 'modelines' is 0 no lines are checked.
657
658Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000659like:
660 /* vi:ts=4: */ ~
661will give an error message for the trailing "*/". This line is OK:
662 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663
664If an error is detected the rest of the line is skipped.
665
666If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000667backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100668 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
669This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
670before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200671 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000673might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200674can be set. For some options a flag is set, so that when the value is used
675the |sandbox| is effective. Some options can only be set from the modeline
676when 'modelineexpr' is set (the default is off).
677
678Still, there is always a small risk that a modeline causes trouble. E.g.,
679when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
680So disable modelines before editing untrusted text. The mail ftplugin does
681this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682
683Hint: If you would like to do something else than setting an option, you could
684define an autocommand that checks the file for a specific string. For
685example: >
686 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
687And define a function SetVar() that does something with the line containing
688"VAR".
689
690==============================================================================
6913. Options summary *option-summary*
692
693In the list below all the options are mentioned with their full name and with
694an abbreviation if there is one. Both forms may be used.
695
696In this document when a boolean option is "set" that means that ":set option"
697is entered. When an option is "reset", ":set nooption" is used.
698
699For some options there are two default values: The "Vim default", which is
700used when 'compatible' is not set, and the "Vi default", which is used when
701'compatible' is set.
702
703Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000704are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705different value in each window. For example the 'list' option can be set in
706one window and reset in another for the same text, giving both types of view
707at the same time. There are a few options that are specific to a certain
708file. These can have a different value for each file or buffer. For example
709the 'textwidth' option can be 78 for a normal text file and 0 for a C
710program.
711
712 global one option for all buffers and windows
713 local to window each window has its own copy of this option
714 local to buffer each buffer has its own copy of this option
715
716When creating a new window the option values from the currently active window
717are used as a default value for the window-specific options. For the
718buffer-specific options this depends on the 's' and 'S' flags in the
719'cpoptions' option. If 's' is included (which is the default) the values for
720buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000721first entered. If 'S' is present the options are copied each time the buffer
722is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723present, the options are copied from the currently active buffer when the
724buffer is created.
725
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000726Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000728Not all options are supported in all versions. This depends on the supported
729features and sometimes on the system. A remark about this is in curly braces
730below. When an option is not supported it may still be set without getting an
731error, this is called a hidden option. You can't get the value of a hidden
732option though, it is not stored.
733
734To test if option "foo" can be used with ":set" use something like this: >
735 if exists('&foo')
736This also returns true for a hidden option. To test if option "foo" is really
737supported use something like this: >
738 if exists('+foo')
739<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740 *E355*
741A jump table for the options with a short description can be found at |Q_op|.
742
743 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100744'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 {only available when compiled with the |+rightleft|
747 feature}
748 The ASCII code for the first letter of the Hebrew alphabet. The
749 routine that maps the keyboard in Hebrew mode, both in Insert mode
750 (when hkmap is set) and on the command-line (when hitting CTRL-_)
751 outputs the Hebrew characters in the range [aleph..aleph+26].
752 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
753 See |rileft.txt|.
754
755 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
756'allowrevins' 'ari' boolean (default off)
757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758 {only available when compiled with the |+rightleft|
759 feature}
760 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
761 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
762 into reverse Insert mode, and don't know how to get out. See
763 'revins'.
764 NOTE: This option is reset when 'compatible' is set.
765
766 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
767'altkeymap' 'akm' boolean (default off)
768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 {only available when compiled with the |+farsi|
770 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100771 This option was for using Farsi, which has been removed. See
772 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773
774 *'ambiwidth'* *'ambw'*
775'ambiwidth' 'ambw' string (default: "single")
776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
778 Tells Vim what to do with characters with East Asian Width Class
779 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
780 letters, Cyrillic letters).
781
782 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000783 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 expected by most users.
785 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200786 *E834* *E835*
787 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100788 contains a character that would be double width. These errors may
789 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200790
791 The values are overruled for characters specified with
792 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 There are a number of CJK fonts for which the width of glyphs for
795 those characters are solely based on how many octets they take in
796 legacy/traditional CJK encodings. In those encodings, Euro,
797 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000798 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000800 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 Vim is running inside a terminal (emulators) that uses a CJK font
802 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
803 this option should be set to "double" to match the width perceived
804 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100805 to be set to "double" under CJK MS-Windows when the system locale is
806 set to one of CJK locales. See Unicode Standard Annex #11
807 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100809 Vim may set this option automatically at startup time when Vim is
810 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200811 escape sequence to request cursor position report. The response can
812 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100813
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
815'antialias' 'anti' boolean (default: off)
816 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200818 on macOS}
819 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
821 which can be easier to read at certain sizes on certain displays.
822 Setting this option can sometimes cause problems if 'guifont' is set
823 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100824 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
827'autochdir' 'acd' boolean (default off)
828 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200829 {only available when compiled with it, use
830 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000831 When on, Vim will change the current working directory whenever you
832 open a file, switch buffers, delete a buffer or open/close a window.
833 It will change to the directory containing the file which was opened
Bram Moolenaare8008642022-08-19 17:15:35 +0100834 or selected. When a buffer has no name it also has no directory, thus
835 the current directory won't change when navigating to it.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000836 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200838 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
839'autoshelldir' 'asd' boolean (default off)
840 global
841 When on, Vim will change the current working directory whenever you
842 change the directory of the shell running in a terminal window. You
843 need proper setting-up, so whenever the shell's pwd changes an OSC 7
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100844 escape sequence will be emitted. For example, on Linux, you can
845 source /etc/profile.d/vte.sh in your shell profile if you use bash or
846 zsh. For bash this should work (put it in a bash init file): >
847 if [[ -n "$VIM_TERMINAL" ]]; then
848 PROMPT_COMMAND='_vim_sync_PWD'
849 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100850 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100851 }
852 fi
853<
854 Or, in a zsh init file: >
855 if [[ -n "$VIM_TERMINAL" ]]; then
856 autoload -Uz add-zsh-hook
857 add-zsh-hook -Uz chpwd _vim_sync_PWD
858 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100859 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100860 }
861 fi
862<
863 In a fish init file: >
864 if test -n "$VIM_TERMINAL"
865 function _vim_sync_PWD --on-variable=PWD
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100866 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100867 end
868 end
869<
870 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000871 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200872
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
874'arabic' 'arab' boolean (default off)
875 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 {only available when compiled with the |+arabic|
877 feature}
878 This option can be set to start editing Arabic text.
879 Setting this option will:
880 - Set the 'rightleft' option, unless 'termbidi' is set.
881 - Set the 'arabicshape' option, unless 'termbidi' is set.
882 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
883 between typing English and Arabic key mapping.
884 - Set the 'delcombine' option
885 Note that 'encoding' must be "utf-8" for working with Arabic text.
886
887 Resetting this option will:
888 - Reset the 'rightleft' option.
889 - Disable the use of 'keymap' (without changing its value).
890 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200891 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100892 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 Also see |arabic.txt|.
894
895 *'arabicshape'* *'arshape'*
896 *'noarabicshape'* *'noarshape'*
897'arabicshape' 'arshape' boolean (default on)
898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 {only available when compiled with the |+arabic|
900 feature}
901 When on and 'termbidi' is off, the required visual character
902 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200903 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 one which encompasses:
905 a) the changing/morphing of characters based on their location
906 within a word (initial, medial, final and stand-alone).
907 b) the enabling of the ability to compose characters
908 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100909 When disabled the display shows each character's true stand-alone
910 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 Arabic is a complex language which requires other settings, for
912 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100913 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914
915 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
916'autoindent' 'ai' boolean (default off)
917 local to buffer
918 Copy indent from current line when starting a new line (typing <CR>
919 in Insert mode or when using the "o" or "O" command). If you do not
920 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000921 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
922 to another line has the same effect, unless the 'I' flag is included
923 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000924 When autoindent is on, formatting (with the "gq" command or when you
925 reach 'textwidth' in Insert mode) uses the indentation of the first
926 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 When 'smartindent' or 'cindent' is on the indent is changed in
928 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200929 The 'autoindent' option is reset when the 'paste' option is set and
930 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931
932 *'autoread'* *'ar'* *'noautoread'* *'noar'*
933'autoread' 'ar' boolean (default off)
934 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 When a file has been detected to have been changed outside of Vim and
936 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200937 When the file has been deleted this is not done, so you have the text
938 from before it was deleted. When it appears again then it is read.
939 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 If this option has a local value, use this command to switch back to
941 using the global value: >
942 :set autoread<
943<
944 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
945'autowrite' 'aw' boolean (default off)
946 global
947 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000948 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000949 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
950 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000951 to another file.
952 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000953 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 Note that for some commands the 'autowrite' option is not used, see
955 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200956 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200957 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100958 USE WITH CARE: If you make temporary changes to a buffer that you
959 don't want to be saved this option may cause it to be saved anyway.
960 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961
962 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
963'autowriteall' 'awa' boolean (default off)
964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
966 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
967 Setting this option also implies that Vim behaves like 'autowrite' has
968 been set.
969
970 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200971'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973 When set to "dark", Vim will try to use colors that look good on a
974 dark background. When set to "light", Vim will try to use colors that
975 look good on a light background. Any other value is illegal.
976 Vim tries to set the default value according to the terminal used.
977 This will not always be correct.
978 Setting this option does not change the background color, it tells Vim
979 what the background color looks like. For changing the background
980 color, see |:hi-normal|.
981
982 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000983 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000984 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100985 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 setting 'background' will cause the color scheme to be reloaded. If
987 the color scheme adjusts to the value of 'background' this will work.
988 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100989 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990
991 When setting 'background' to the default value with: >
992 :set background&
993< Vim will guess the value. In the GUI this should work correctly,
994 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200995 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200996 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200998 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200999 color from the terminal. If the returned RGB value is dark/light and
1000 'background' is not dark/light, 'background' will be set and the
1001 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001002 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001003 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001004
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 When starting the GUI, the default value for 'background' will be
1006 "light". When the value is not set in the .gvimrc, and Vim detects
1007 that the background is actually quite dark, 'background' is set to
1008 "dark". But this happens only AFTER the .gvimrc file has been read
1009 (because the window needs to be opened to find the actual background
1010 color). To get around this, force the GUI window to be opened by
1011 putting a ":gui" command in the .gvimrc file, before where the value
1012 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001013
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001014 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001015 For other systems "dark" is used when 'term' is "linux",
1016 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1017 background. Otherwise the default is "light".
1018
Bram Moolenaarc572da52017-08-27 16:52:01 +02001019 The |:terminal| command and the |term_start()| function use the
1020 'background' value to decide whether the terminal window will start
1021 with a white or black background.
1022
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 Normally this option would be set in the .vimrc file. Possibly
1024 depending on the terminal name. Example: >
1025 :if &term == "pcterm"
1026 : set background=dark
1027 :endif
1028< When this option is set, the default settings for the highlight groups
1029 will change. To use other settings, place ":highlight" commands AFTER
1030 the setting of the 'background' option.
1031 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1032 to select the colors for syntax highlighting. After changing this
1033 option, you must load syntax.vim again to see the result. This can be
1034 done with ":syntax on".
1035
1036 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001037'backspace' 'bs' string (default "", set to "indent,eol,start"
1038 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1041 mode. This is a list of items, separated by commas. Each item allows
1042 a way to backspace over something:
1043 value effect ~
1044 indent allow backspacing over autoindent
1045 eol allow backspacing over line breaks (join lines)
1046 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1047 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001048 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1049 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
Bram Moolenaar46eea442022-03-30 10:51:39 +01001051 When the value is empty, Vi compatible backspacing is used, none of
1052 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053
1054 For backwards compatibility with version 5.4 and earlier:
1055 value effect ~
1056 0 same as ":set backspace=" (Vi compatible)
1057 1 same as ":set backspace=indent,eol"
1058 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001059 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060
1061 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1062 NOTE: This option is set to "" when 'compatible' is set.
1063
1064 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1065'backup' 'bk' boolean (default off)
1066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 Make a backup before overwriting a file. Leave it around after the
1068 file has been successfully written. If you do not want to keep the
1069 backup file, but you do want a backup while the file is being
1070 written, reset this option and set the 'writebackup' option (this is
1071 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001072 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 |backup-table| for more explanations.
1074 When the 'backupskip' pattern matches, a backup is not made anyway.
1075 When 'patchmode' is set, the backup may be renamed to become the
1076 oldest version of a file.
1077 NOTE: This option is reset when 'compatible' is set.
1078
1079 *'backupcopy'* *'bkc'*
1080'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001081 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001083 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
1085 The main values are:
1086 "yes" make a copy of the file and overwrite the original one
1087 "no" rename the file and write a new one
1088 "auto" one of the previous, what works best
1089
1090 Extra values that can be combined with the ones above are:
1091 "breaksymlink" always break symlinks when writing
1092 "breakhardlink" always break hardlinks when writing
1093
1094 Making a copy and overwriting the original file:
1095 - Takes extra time to copy the file.
1096 + When the file has special attributes, is a (hard/symbolic) link or
1097 has a resource fork, all this is preserved.
1098 - When the file is a link the backup will have the name of the link,
1099 not of the real file.
1100
1101 Renaming the file and writing a new one:
1102 + It's fast.
1103 - Sometimes not all attributes of the file can be copied to the new
1104 file.
1105 - When the file is a link the new file will not be a link.
1106
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001107 The "auto" value is the middle way: When Vim sees that renaming the
1108 file is possible without side effects (the attributes can be passed on
1109 and the file is not a link) that is used. When problems are expected,
1110 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111
1112 The "breaksymlink" and "breakhardlink" values can be used in
1113 combination with any of "yes", "no" and "auto". When included, they
1114 force Vim to always break either symbolic or hard links by doing
1115 exactly what the "no" option does, renaming the original file to
1116 become the backup and writing a new file in its place. This can be
1117 useful for example in source trees where all the files are symbolic or
1118 hard links and any changes should stay in the local source tree, not
1119 be propagated back to the original source.
1120 *crontab*
1121 One situation where "no" and "auto" will cause problems: A program
1122 that opens a file, invokes Vim to edit that file, and then tests if
1123 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001124 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 example.
1126
1127 When a copy is made, the original file is truncated and then filled
1128 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001129 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001130 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 group of the backup is set to the group of the original file. If this
1132 fails, the protection bits for the group are made the same as for
1133 others.
1134
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001135 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 the same attributes of the original file, and the newly written file
1137 is owned by the current user. When the file was a (hard/symbolic)
1138 link, the new file will not! That's why the "auto" value doesn't
1139 rename when the file is a link. The owner and group of the newly
1140 written file will be set to the same ones as the original file, but
1141 the system may refuse to do this. In that case the "auto" value will
1142 again not rename the file.
1143
Bram Moolenaar036986f2017-03-16 17:41:02 +01001144 NOTE: This option is set to the Vi default value when 'compatible' is
1145 set and to the Vim default value when 'compatible' is reset.
1146
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 *'backupdir'* *'bdir'*
1148'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001149 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 for Unix: ".,~/tmp,~/")
1151 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 List of directories for the backup file, separated with commas.
1153 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001154 where this is possible. The directory must exist, Vim will not
1155 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001156 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157 impossible!). Writing may fail because of this.
1158 - A directory "." means to put the backup file in the same directory
1159 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001160 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1161 the backup file relative to where the edited file is. The leading
1162 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 ("." inside a directory name has no special meaning).
1164 - Spaces after the comma are ignored, other spaces are considered part
1165 of the directory name. To have a space at the start of a directory
1166 name, precede it with a backslash.
1167 - To include a comma in a directory name precede it with a backslash.
1168 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001169 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001170 the backup file name will be built from the complete path to the
1171 file with all path separators changed to percent '%' signs. This
1172 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001173 On Win32, it is also possible to end with "\\". However, When a
1174 separating comma is following, you must use "//", since "\\" will
1175 include the comma in the file name. Therefore it is recommended to
1176 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177 - Environment variables are expanded |:set_env|.
1178 - Careful with '\' characters, type one before a space, type two to
1179 get one in the option (see |option-backslash|), for example: >
1180 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1181< - For backwards compatibility with Vim version 3.0 a '>' at the start
1182 of the option is removed.
1183 See also 'backup' and 'writebackup' options.
1184 If you want to hide your backup files on Unix, consider this value: >
1185 :set backupdir=./.backup,~/.backup,.,/tmp
1186< You must create a ".backup" directory in each directory and in your
1187 home directory for this to work properly.
1188 The use of |:set+=| and |:set-=| is preferred when adding or removing
1189 directories from the list. This avoids problems when a future version
1190 uses another default.
1191 This option cannot be set from a |modeline| or in the |sandbox|, for
1192 security reasons.
1193
1194 *'backupext'* *'bex'* *E589*
1195'backupext' 'bex' string (default "~", for VMS: "_")
1196 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 String which is appended to a file name to make the name of the
1198 backup file. The default is quite unusual, because this avoids
1199 accidentally overwriting existing files with a backup file. You might
1200 prefer using ".bak", but make sure that you don't have files with
1201 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001202 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001204 If you like to keep a lot of backups, you could use a BufWritePre
1205 autocommand to change 'backupext' just before writing the file to
1206 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001207 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001208< Use 'backupdir' to put the backup in a different directory.
1209
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001211'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1212 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1213 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 A list of file patterns. When one of the patterns matches with the
1216 name of the file which is written, no backup file is created. Both
1217 the specified file name and the full path name of the file are used.
1218 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1219 Watch out for special characters, see |option-backslash|.
1220 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001221 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001222
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001223 WARNING: Not having a backup file means that when Vim fails to write
1224 your buffer correctly and then, for whatever reason, Vim exits, you
1225 lose both the original file and what you were writing. Only disable
1226 backups if you don't care about losing the file.
1227
Bram Moolenaar02467872007-05-06 13:22:01 +00001228 Note that environment variables are not expanded. If you want to use
1229 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001230 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001231
1232< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001233 backup would be made by renaming the original file crontab won't see
1234 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235
1236 *'balloondelay'* *'bdlay'*
1237'balloondelay' 'bdlay' number (default: 600)
1238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239 {only available when compiled with the |+balloon_eval|
1240 feature}
1241 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1242
1243 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1244'ballooneval' 'beval' boolean (default off)
1245 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001247 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001248 Switch on the |balloon-eval| functionality for the GUI.
1249
1250 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1251 *'nobevalterm'*
1252'balloonevalterm' 'bevalterm' boolean (default off)
1253 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001254 {only available when compiled with the
1255 |+balloon_eval_term| feature}
1256 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001258 *'balloonexpr'* *'bexpr'*
1259'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001260 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001261 {only available when compiled with the |+balloon_eval|
1262 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001263 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001264 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1265 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001266
1267 v:beval_bufnr number of the buffer in which balloon is going to show
1268 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001269 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001270 v:beval_lnum line number
1271 v:beval_col column number (byte index)
1272 v:beval_text word under or after the mouse pointer
1273
Bram Moolenaar54775062019-07-31 21:07:14 +02001274 Instead of showing a balloon, which is limited to plain text, consider
1275 using a popup window, see |popup_beval_example|. A popup window can
1276 use highlighting and show a border.
1277
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001278 The evaluation of the expression must not have side effects!
1279 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001280 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001281 return 'Cursor is at line ' .. v:beval_lnum ..
1282 \ ', column ' .. v:beval_col ..
1283 \ ' of file ' .. bufname(v:beval_bufnr) ..
1284 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001285 endfunction
1286 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001287 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001288<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001289 Also see |balloon_show()|, it can be used if the content of the balloon
1290 is to be fetched asynchronously. In that case evaluating
1291 'balloonexpr' should result in an empty string. If you get a balloon
1292 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001293
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001294 NOTE: The balloon is displayed only if the cursor is on a text
1295 character. If the result of evaluating 'balloonexpr' is not empty,
1296 Vim does not try to send a message to an external debugger (Netbeans
1297 or Sun Workshop).
1298
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001299 If the expression starts with s: or |<SID>|, then it is replaced with
1300 the script ID (|local-function|). Example: >
1301 set bexpr=s:MyBalloonExpr()
1302 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001303< Otherwise, the expression is evaluated in the context of the script
1304 where the option was set, thus script-local items are available.
1305
Bram Moolenaar30b65812012-07-12 22:01:11 +02001306 The expression will be evaluated in the |sandbox| when set from a
1307 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001308 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001309
1310 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001311 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001312
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001313 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001314 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001315< When they are supported "\n" characters will start a new line. If the
1316 expression evaluates to a |List| this is equal to using each List item
1317 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001318 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001319
Bram Moolenaar165bc692015-07-21 17:53:25 +02001320 *'belloff'* *'bo'*
1321'belloff' 'bo' string (default "")
1322 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001323 Specifies for which events the bell will not be rung. It is a comma
1324 separated list of items. For each item that is present, the bell
1325 will be silenced. This is most useful to specify specific events in
1326 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001327 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001328
1329 item meaning when present ~
1330 all All events.
1331 backspace When hitting <BS> or <Del> and deleting results in an
1332 error.
1333 cursor Fail to move around using the cursor keys or
1334 <PageUp>/<PageDown> in |Insert-mode|.
1335 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1336 |i_CTRL-X_CTRL-T|.
1337 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1338 |i_CTRL-E|.
1339 ctrlg Unknown Char after <C-G> in Insert mode.
1340 error Other Error occurred (e.g. try to join last line)
1341 (mostly used in |Normal-mode| or |Cmdline-mode|).
1342 esc hitting <Esc> in |Normal-mode|.
1343 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001344 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001345 insertmode Pressing <Esc> in 'insertmode'.
1346 lang Calling the beep module for Lua/Mzscheme/TCL.
1347 mess No output available for |g<|.
1348 showmatch Error occurred for 'showmatch' function.
1349 operator Empty region error |cpo-E|.
1350 register Unknown register after <C-R> in |Insert-mode|.
1351 shell Bell from shell output |:!|.
1352 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001353 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001354 wildmode More matches in |cmdline-completion| available
1355 (depends on the 'wildmode' setting).
1356
Bram Moolenaar036986f2017-03-16 17:41:02 +01001357 This is most useful to fine tune when in Insert mode the bell should
1358 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001359 indicate that an error occurred. It can be silenced by adding the
1360 "error" keyword.
1361
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1363'binary' 'bin' boolean (default off)
1364 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 This option should be set before editing a binary file. You can also
1366 use the |-b| Vim argument. When this option is switched on a few
1367 options will be changed (also when it already was on):
1368 'textwidth' will be set to 0
1369 'wrapmargin' will be set to 0
1370 'modeline' will be off
1371 'expandtab' will be off
1372 Also, 'fileformat' and 'fileformats' options will not be used, the
1373 file is read and written like 'fileformat' was "unix" (a single <NL>
1374 separates lines).
1375 The 'fileencoding' and 'fileencodings' options will not be used, the
1376 file is read without conversion.
1377 NOTE: When you start editing a(nother) file while the 'bin' option is
1378 on, settings from autocommands may change the settings again (e.g.,
1379 'textwidth'), causing trouble when editing. You might want to set
1380 'bin' again when the file has been loaded.
1381 The previous values of these options are remembered and restored when
1382 'bin' is switched from on to off. Each buffer has its own set of
1383 saved option values.
1384 To edit a file with 'binary' set you can use the |++bin| argument.
1385 This avoids you have to do ":set bin", which would have effect for all
1386 files you edit.
1387 When writing a file the <EOL> for the last line is only written if
1388 there was one in the original file (normally Vim appends an <EOL> to
1389 the last line if there is none; this would make the file longer). See
1390 the 'endofline' option.
1391
1392 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1393'bioskey' 'biosk' boolean (default on)
1394 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001395 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001396 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397
1398 *'bomb'* *'nobomb'*
1399'bomb' boolean (default off)
1400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 When writing a file and the following conditions are met, a BOM (Byte
1402 Order Mark) is prepended to the file:
1403 - this option is on
1404 - the 'binary' option is off
1405 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1406 endian variants.
1407 Some applications use the BOM to recognize the encoding of the file.
1408 Often used for UCS-2 files on MS-Windows. For other applications it
1409 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001410 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1412 check for the presence of the BOM is done and 'bomb' set accordingly.
1413 Unless 'binary' is set, it is removed from the first line, so that you
1414 don't see it when editing. When you don't change the options, the BOM
1415 will be restored when writing the file.
1416
1417 *'breakat'* *'brk'*
1418'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1419 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001420 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421 feature}
1422 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001423 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1424 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001426 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001427'breakindent' 'bri' boolean (default off)
1428 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001429 {not available when compiled without the |+linebreak|
1430 feature}
1431 Every wrapped line will continue visually indented (same amount of
1432 space as the beginning of that line), thus preserving horizontal blocks
1433 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001434 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001435
1436 *'breakindentopt'* *'briopt'*
1437'breakindentopt' 'briopt' string (default empty)
1438 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001439 {not available when compiled without the |+linebreak|
1440 feature}
1441 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001442 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001443 min:{n} Minimum text width that will be kept after
1444 applying 'breakindent', even if the resulting
1445 text should normally be narrower. This prevents
1446 text indented almost to the right window border
1447 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001448 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001449 shift:{n} After applying 'breakindent', the wrapped line's
1450 beginning will be shifted by the given number of
1451 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001452 indentation (negative) or emphasizing the line
1453 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001454 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001455 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001456 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001457 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001458 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001459 numbered or bulleted list (using the
1460 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001461 list:-1 Uses the length of a match with 'formatlistpat'
1462 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001463 (default: 0)
1464 column:{n} Indent at column {n}. Will overrule the other
1465 sub-options. Note: an additional indent may be
1466 added for the 'showbreak' setting.
1467 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001468
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001470'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001472 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001474 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001475 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476 buffer Use the directory of the related buffer.
1477 current Use the current directory.
1478 {path} Use the specified directory
1479
1480 *'bufhidden'* *'bh'*
1481'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001482 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483 This option specifies what happens when a buffer is no longer
1484 displayed in a window:
1485 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001486 hide hide the buffer (don't unload it), even if 'hidden' is
1487 not set
1488 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001489 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001490 delete delete the buffer from the buffer list, even if
1491 'hidden' is set; the |:hide| command will also delete
1492 the buffer, making it behave like |:bdelete|
1493 wipe wipe the buffer from the buffer list, even if
1494 'hidden' is set; the |:hide| command will also wipe
1495 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001497 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001498 are lost without a warning. Also, these values may break autocommands
1499 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 This option is used together with 'buftype' and 'swapfile' to specify
1501 special kinds of buffers. See |special-buffers|.
1502
1503 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1504'buflisted' 'bl' boolean (default: on)
1505 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 When this option is set, the buffer shows up in the buffer list. If
1507 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1508 This option is reset by Vim for buffers that are only used to remember
1509 a file name or marks. Vim sets it when starting to edit a buffer.
1510 But not when moving to a buffer with ":buffer".
1511
1512 *'buftype'* *'bt'* *E382*
1513'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001514 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515 The value of this option specifies the type of a buffer:
1516 <empty> normal buffer
1517 nofile buffer which is not related to a file and will not be
1518 written
1519 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001520 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001521 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001523 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524 help help buffer (you are not supposed to set this
1525 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001526 terminal buffer for a |terminal| (you are not supposed to set
1527 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001528 prompt buffer where only the last line can be edited, meant
1529 to be used by a plugin, see |prompt-buffer|
1530 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001531 popup buffer used in a popup window, see |popup|.
1532 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533
1534 This option is used together with 'bufhidden' and 'swapfile' to
1535 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001536 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537
1538 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001539 One such effect is that Vim will not check the timestamp of the file,
1540 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541
Bram Moolenaar280f1262006-01-30 00:14:18 +00001542 A "quickfix" buffer is only used for the error list and the location
1543 list. This value is set by the |:cwindow| and |:lwindow| commands and
1544 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545
1546 "nofile" and "nowrite" buffers are similar:
1547 both: The buffer is not to be written to disk, ":w" doesn't
1548 work (":w filename" does work though).
1549 both: The buffer is never considered to be |'modified'|.
1550 There is no warning when the changes will be lost, for
1551 example when you quit Vim.
1552 both: A swap file is only created when using too much memory
1553 (when 'swapfile' has been reset there is never a swap
1554 file).
1555 nofile only: The buffer name is fixed, it is not handled like a
1556 file name. It is not modified in response to a |:cd|
1557 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001558 both: When using ":e bufname" and already editing "bufname"
1559 the buffer is made empty and autocommands are
1560 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001561 *E676*
1562 "acwrite" implies that the buffer name is not related to a file, like
1563 "nofile", but it will be written. Thus, in contrast to "nofile" and
1564 "nowrite", ":w" does work and a modified buffer can't be abandoned
1565 without saving. For writing there must be matching |BufWriteCmd|,
1566 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567
1568 *'casemap'* *'cmp'*
1569'casemap' 'cmp' string (default: "internal,keepascii")
1570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 Specifies details about changing the case of letters. It may contain
1572 these words, separated by a comma:
1573 internal Use internal case mapping functions, the current
1574 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001575 matters when 'encoding' is a Unicode encoding,
1576 "latin1" or "iso-8859-15". When "internal" is
1577 omitted, the towupper() and towlower() system library
1578 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1580 case mapping, the current locale is not effective.
1581 This probably only matters for Turkish.
1582
Bram Moolenaar938ae282023-02-20 20:44:55 +00001583 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001584'cdhome' 'cdh' boolean (default: off)
1585 global
1586 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1587 current working directory to the |$HOME| directory like in Unix.
1588 When off, those commands just print the current directory name.
1589 On Unix this option has no effect.
1590 NOTE: This option is reset when 'compatible' is set.
1591
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 *'cdpath'* *'cd'* *E344* *E346*
1593'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001596 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1597 searched for has a relative path, not an absolute part starting with
1598 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 The 'cdpath' option's value has the same form and semantics as
1600 |'path'|. Also see |file-searching|.
1601 The default value is taken from $CDPATH, with a "," prepended to look
1602 in the current directory first.
1603 If the default value taken from $CDPATH is not what you want, include
1604 a modified version of the following command in your vimrc file to
1605 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001606 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607< This option cannot be set from a |modeline| or in the |sandbox|, for
1608 security reasons.
1609 (parts of 'cdpath' can be passed to the shell to expand file names).
1610
1611 *'cedit'*
1612'cedit' string (Vi default: "", Vim default: CTRL-F)
1613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 The key used in Command-line Mode to open the command-line window.
1615 The default is CTRL-F when 'compatible' is off.
1616 Only non-printable keys are allowed.
1617 The key can be specified as a single character, but it is difficult to
1618 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001619 :exe "set cedit=\<C-Y>"
1620 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621< |Nvi| also has this option, but it only uses the first character.
1622 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001623 NOTE: This option is set to the Vim default value when 'compatible'
1624 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625
1626 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1627'charconvert' 'ccv' string (default "")
1628 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001629 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 An expression that is used for character encoding conversion. It is
1631 evaluated when a file that is to be read or has been written has a
1632 different encoding from what is desired.
1633 'charconvert' is not used when the internal iconv() function is
1634 supported and is able to do the conversion. Using iconv() is
1635 preferred, because it is much faster.
1636 'charconvert' is not used when reading stdin |--|, because there is no
1637 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001638 The expression must return zero, false or an empty string for success,
1639 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 The possible encoding names encountered are in 'encoding'.
1641 Additionally, names given in 'fileencodings' and 'fileencoding' are
1642 used.
1643 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1644 is done internally by Vim, 'charconvert' is not used for this.
1645 'charconvert' is also used to convert the viminfo file, if the 'c'
1646 flag is present in 'viminfo'. Also used for Unicode conversion.
1647 Example: >
1648 set charconvert=CharConvert()
1649 fun CharConvert()
1650 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001651 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1652 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 return v:shell_error
1654 endfun
1655< The related Vim variables are:
1656 v:charconvert_from name of the current encoding
1657 v:charconvert_to name of the desired encoding
1658 v:fname_in name of the input file
1659 v:fname_out name of the output file
1660 Note that v:fname_in and v:fname_out will never be the same.
1661 Note that v:charconvert_from and v:charconvert_to may be different
1662 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001663
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001664 The advantage of using a function call without arguments is that it is
1665 faster, see |expr-option-function|.
1666
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 Encryption is not done by Vim when using 'charconvert'. If you want
1668 to encrypt the file after conversion, 'charconvert' should take care
1669 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001670
1671 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1672 replaced with the script ID (|local-function|). Example: >
1673 set charconvert=s:MyConvert()
1674 set charconvert=<SID>SomeConvert()
1675< Otherwise the expression is evaluated in the context of the script
1676 where the option was set, thus script-local items are available.
1677
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 This option cannot be set from a |modeline| or in the |sandbox|, for
1679 security reasons.
1680
1681 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1682'cindent' 'cin' boolean (default off)
1683 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001684 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685 that trigger reindenting in insert mode and 'cinoptions' to set your
1686 preferred indent style.
1687 If 'indentexpr' is not empty, it overrules 'cindent'.
1688 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1689 the "=" operator indents using this algorithm rather than calling an
1690 external program.
1691 See |C-indenting|.
1692 When you don't like the way 'cindent' works, try the 'smartindent'
1693 option or 'indentexpr'.
1694 This option is not used when 'paste' is set.
1695 NOTE: This option is reset when 'compatible' is set.
1696
1697 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001698'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 A list of keys that, when typed in Insert mode, cause reindenting of
1701 the current line. Only used if 'cindent' is on and 'indentexpr' is
1702 empty.
1703 For the format of this option see |cinkeys-format|.
1704 See |C-indenting|.
1705
1706 *'cinoptions'* *'cino'*
1707'cinoptions' 'cino' string (default "")
1708 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1710 program. See |cinoptions-values| for the values of this option, and
1711 |C-indenting| for info on C indenting in general.
1712
1713
1714 *'cinwords'* *'cinw'*
1715'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1716 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 These keywords start an extra indent in the next line when
1718 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1719 an appropriate place (inside {}).
1720 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1721 matter, include the keyword both the uppercase and lowercase:
1722 "if,If,IF".
1723
Tom Praschan3506cf32022-04-07 12:39:08 +01001724 *'cinscopedecls'* *'cinsd'*
1725'cinscopedecls' 'cinsd' string (default "public,protected,private")
1726 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001727 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1728 Useful e.g. for working with the Qt framework that defines additional
1729 scope declarations "signals", "public slots" and "private slots": >
1730 set cinscopedecls+=signals,public\ slots,private\ slots
1731
1732< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1734 for X-windows, "" otherwise)
1735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736 {only in GUI versions or when the |+xterm_clipboard|
1737 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001738 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001739 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001740 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001741 prepend, e.g.: >
1742 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001743< When using the GUI see |'go-A'|.
1744 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001746 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747 unnamed When included, Vim will use the clipboard register '*'
1748 for all yank, delete, change and put operations which
1749 would normally go to the unnamed register. When a
1750 register is explicitly specified, it will always be
1751 used regardless of whether "unnamed" is in 'clipboard'
1752 or not. The clipboard register can always be
1753 explicitly accessed using the "* notation. Also see
1754 |gui-clipboard|.
1755
Bram Moolenaar30b65812012-07-12 22:01:11 +02001756 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001757 unnamedplus A variant of the "unnamed" flag which uses the
1758 clipboard register '+' (|quoteplus|) instead of
1759 register '*' for all yank, delete, change and put
1760 operations which would normally go to the unnamed
1761 register. When "unnamed" is also included to the
1762 option, yank operations (but not delete, change or
1763 put) will additionally copy the text into register
1764 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001765 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001766 Availability can be checked with: >
1767 if has('unnamedplus')
1768<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001769 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770 autoselect Works like the 'a' flag in 'guioptions': If present,
1771 then whenever Visual mode is started, or the Visual
1772 area extended, Vim tries to become the owner of the
1773 windowing system's global selection or put the
1774 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001775 register "*. See |'go-a'| and |quotestar| for details.
1776 When the GUI is active, the 'a' flag in 'guioptions'
1777 is used, when the GUI is not active, this "autoselect"
1778 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 Also applies to the modeless selection.
1780
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001781 *clipboard-autoselectplus*
1782 autoselectplus Like "autoselect" but using the + register instead of
1783 the * register. Compare to the 'P' flag in
1784 'guioptions'.
1785
1786 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 autoselectml Like "autoselect", but for the modeless selection
1788 only. Compare to the 'A' flag in 'guioptions'.
1789
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001790 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001791 html When the clipboard contains HTML, use this when
1792 pasting. When putting text on the clipboard, mark it
1793 as HTML. This works to copy rendered HTML from
1794 Firefox, paste it as raw HTML in Vim, select the HTML
1795 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001796 You probably want to add this only temporarily,
1797 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001798 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001799
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001800 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 exclude:{pattern}
1802 Defines a pattern that is matched against the name of
1803 the terminal 'term'. If there is a match, no
1804 connection will be made to the X server. This is
1805 useful in this situation:
1806 - Running Vim in a console.
1807 - $DISPLAY is set to start applications on another
1808 display.
1809 - You do not want to connect to the X server in the
1810 console, but do want this in a terminal emulator.
1811 To never connect to the X server use: >
1812 exclude:.*
1813< This has the same effect as using the |-X| argument.
1814 Note that when there is no connection to the X server
1815 the window title won't be restored and the clipboard
1816 cannot be accessed.
1817 The value of 'magic' is ignored, {pattern} is
1818 interpreted as if 'magic' was on.
1819 The rest of the option value will be used for
1820 {pattern}, this must be the last entry.
1821
1822 *'cmdheight'* *'ch'*
1823'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001824 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001825 Number of screen lines to use for the command-line. A larger value
1826 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001827 The value of this option is stored with the tab page, so that each tab
1828 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829
1830 *'cmdwinheight'* *'cwh'*
1831'cmdwinheight' 'cwh' number (default 7)
1832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 Number of screen lines to use for the command-line window. |cmdwin|
1834
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001835 *'colorcolumn'* *'cc'*
1836'colorcolumn' 'cc' string (default "")
1837 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001838 {not available when compiled without the |+syntax|
1839 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001840 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001841 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1842 text. Will make screen redrawing slower.
1843 The screen column can be an absolute number, or a number preceded with
1844 '+' or '-', which is added to or subtracted from 'textwidth'. >
1845
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001846 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001847 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1848 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1849<
1850 When 'textwidth' is zero then the items with '-' and '+' are not used.
1851 A maximum of 256 columns are highlighted.
1852
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 *'columns'* *'co'* *E594*
1854'columns' 'co' number (default 80 or terminal width)
1855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001857 initialization and does not have to be set by hand. Also see
1858 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 When Vim is running in the GUI or in a resizable window, setting this
1860 option will cause the window size to be changed. When you only want
1861 to use the size for the GUI, put the command in your |gvimrc| file.
1862 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001863 number of columns of the display, the display may be messed up. For
1864 the GUI it is always possible and Vim limits the number of columns to
1865 what fits on the screen. You can use this command to get the widest
1866 window possible: >
1867 :set columns=9999
1868< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869
1870 *'comments'* *'com'* *E524* *E525*
1871'comments' 'com' string (default
1872 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1873 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001874 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 |format-comments|. See |option-backslash| about using backslashes to
1876 insert a space.
1877
1878 *'commentstring'* *'cms'* *E537*
1879'commentstring' 'cms' string (default "/*%s*/")
1880 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 {not available when compiled without the |+folding|
1882 feature}
1883 A template for a comment. The "%s" in the value is replaced with the
1884 comment text. Currently only used to add markers for folding, see
1885 |fold-marker|.
1886
1887 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001888'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001889 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 This option has the effect of making Vim either more Vi-compatible, or
1892 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001893
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001895 other options are also changed as a side effect.
1896 NOTE: Setting or resetting this option can have a lot of unexpected
1897 effects: Mappings are interpreted in another way, undo behaves
1898 differently, etc. If you set this option in your vimrc file, you
1899 should probably put it at the very start.
1900
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 By default this option is on and the Vi defaults are used for the
1902 options. This default was chosen for those people who want to use Vim
1903 just like Vi, and don't even (want to) know about the 'compatible'
1904 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001905 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001906 this option is switched off, and all options that have not been
1907 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001908 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001909 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001910 happen for the system-wide vimrc or gvimrc file, nor for a file given
1911 with the |-u| argument). Also see |compatible-default| and
1912 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 You can also set this option with the "-C" argument, and reset it with
1914 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001915 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916
Bram Moolenaar214641f2017-03-05 17:04:09 +01001917 When this option is set, numerous other options are set to make Vim as
1918 Vi-compatible as possible. When this option is unset, various options
1919 are set to make Vim more useful. The table below lists all the
1920 options affected.
1921 The {?} column indicates when the options are affected:
1922 + Means that the option is set to the value given in {set value} when
1923 'compatible' is set.
1924 & Means that the option is set to the value given in {set value} when
1925 'compatible' is set AND is set to its Vim default value when
1926 'compatible' is unset.
1927 - Means the option is NOT changed when setting 'compatible' but IS
1928 set to its Vim default when 'compatible' is unset.
1929 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930
Bram Moolenaar036986f2017-03-16 17:41:02 +01001931 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001932
1933 'allowrevins' + off no CTRL-_ command
1934 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001935 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001936 'arabicshape' + on correct character shapes
1937 'backspace' + "" normal backspace
1938 'backup' + off no backup file
1939 'backupcopy' & Unix: "yes" backup file is a copy
1940 else: "auto" copy or rename backup file
1941 'balloonexpr' + "" text to show in evaluation balloon
1942 'breakindent' + off don't indent when wrapping lines
1943 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001944 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001945 'cindent' + off no C code indentation
1946 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1947 'copyindent' + off don't copy indent structure
1948 'cpoptions' & (all flags) Vi-compatible flags
1949 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001950 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001951 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001952 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001953 'cscopeverbose' + off see |cscopeverbose|
1954 'delcombine' + off unicode: delete whole char combination
1955 'digraph' + off no digraphs
1956 'esckeys' & off no <Esc>-keys in Insert mode
1957 'expandtab' + off tabs not expanded to spaces
1958 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001959 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001960 'formatexpr' + "" use 'formatprg' for auto-formatting
1961 'formatoptions' & "vt" Vi compatible formatting
1962 'gdefault' + off no default 'g' flag for ":s"
1963 'history' & 0 no commandline history
1964 'hkmap' + off no Hebrew keyboard mapping
1965 'hkmapp' + off no phonetic Hebrew keyboard mapping
1966 'hlsearch' + off no highlighting of search matches
1967 'incsearch' + off no incremental searching
1968 'indentexpr' + "" no indenting by expression
1969 'insertmode' + off do not start in Insert mode
1970 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001972 'joinspaces' + on insert 2 spaces after period
1973 'modeline' & off no modelines
1974 'more' & off no pauses in listings
1975 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1976 'numberwidth' & 8 min number of columns for line number
1977 'preserveindent'+ off don't preserve current indent structure
1978 when changing it
1979 'revins' + off no reverse insert
1980 'ruler' + off no ruler
1981 'scrolljump' + 1 no jump scroll
1982 'scrolloff' + 0 no scroll offset
1983 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1984 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001985 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001986 'showcmd' & off command characters not shown
1987 'showmode' & off current mode not shown
1988 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1989 'smartcase' + off no automatic ignore case switch
1990 'smartindent' + off no smart indentation
1991 'smarttab' + off no smart tab size
1992 'softtabstop' + 0 tabs are always 'tabstop' positions
1993 'startofline' + on goto startofline with some commands
1994 'tagcase' & "followic" 'ignorecase' when searching tags file
1995 'tagrelative' & off tag file names are not relative
1996 'termguicolors' + off don't use highlight-(guifg|guibg)
1997 'textauto' & off no automatic textmode detection
1998 'textwidth' + 0 no automatic line wrap
1999 'tildeop' + off tilde is not an operator
2000 'ttimeout' + off no terminal timeout
2001 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002002 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002003 'virtualedit' + "" cursor can only be placed on characters
2004 'whichwrap' & "" left-right movements don't wrap
2005 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002007 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008
2009 *'complete'* *'cpt'* *E535*
2010'complete' 'cpt' string (default: ".,w,b,u,t,i")
2011 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 This option specifies how keyword completion |ins-completion| works
2013 when CTRL-P or CTRL-N are used. It is also used for whole-line
2014 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002015 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002016 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017 w scan buffers from other windows
2018 b scan other loaded buffers that are in the buffer list
2019 u scan the unloaded buffers that are in the buffer list
2020 U scan the buffers that are not in the buffer list
2021 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002022 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 k{dict} scan the file {dict}. Several "k" flags can be given,
2024 patterns are valid too. For example: >
2025 :set cpt=k/usr/dict/*,k~/spanish
2026< s scan the files given with the 'thesaurus' option
2027 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2028 are valid too.
2029 i scan current and included files
2030 d scan current and included files for defined name or macro
2031 |i_CTRL-X_CTRL-D|
2032 ] tag completion
2033 t same as "]"
2034
2035 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2036 not executed, this may lead to unexpected completions from some files
2037 (gzipped files for example). Unloaded buffers are not scanned for
2038 whole-line completion.
2039
2040 The default is ".,w,b,u,t,i", which means to scan:
2041 1. the current buffer
2042 2. buffers in other windows
2043 3. other loaded buffers
2044 4. unloaded buffers
2045 5. tags
2046 6. included files
2047
2048 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002049 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2050 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002052 *'completefunc'* *'cfu'*
2053'completefunc' 'cfu' string (default: empty)
2054 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002055 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002056 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002057 This option specifies a function to be used for Insert mode completion
2058 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002059 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002060 invoked and what it should return. The value can be the name of a
2061 function, a |lambda| or a |Funcref|. See |option-value-function| for
2062 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002063 This option cannot be set from a |modeline| or in the |sandbox|, for
2064 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002065
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002066 *'completeslash'* *'csl'*
2067'completeslash' 'csl' string (default: "")
2068 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002069 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002070 When this option is set it overrules 'shellslash' for completion:
2071 - When this option is set to "slash", a forward slash is used for path
2072 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002073 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002074 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002075 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002076 - When this option is empty, same character is used as for
2077 'shellslash'.
2078 For Insert mode completion the buffer-local value is used. For
2079 command line completion the global value is used.
2080
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002081 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002082'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002083 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002084 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002085 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002086
2087 menu Use a popup menu to show the possible completions. The
2088 menu is only shown when there is more than one match and
2089 sufficient colors are available. |ins-completion-menu|
2090
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002091 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002092 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002093 match, e.g., what file it comes from.
2094
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002095 longest Only insert the longest common text of the matches. If
2096 the menu is displayed you can use CTRL-L to add more
2097 characters. Whether case is ignored depends on the kind
2098 of completion. For buffer text the 'ignorecase' option is
2099 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002100
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002101 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002102 completion in the preview window. Only works in
2103 combination with "menu" or "menuone".
2104
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002105 popup Show extra information about the currently selected
2106 completion in a popup window. Only works in combination
2107 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002108 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002109 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002110
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002111 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002112 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002113 |CompleteChanged| autocommand to fetch the info and call
2114 |popup_show()| once the popup has been filled.
2115 See the example at |complete-popuphidden|.
2116 {only works when compiled with the |+textprop| feature}
2117
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002118 noinsert Do not insert any text for a match until the user selects
2119 a match from the menu. Only works in combination with
2120 "menu" or "menuone". No effect if "longest" is present.
2121
2122 noselect Do not select a match in the menu, force the user to
2123 select one from the menu. Only works in combination with
2124 "menu" or "menuone".
2125
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002126
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002127 *'completepopup'* *'cpp'*
2128'completepopup' 'cpp' string (default empty)
2129 global
2130 {not available when compiled without the |+textprop|
2131 or |+quickfix| feature}
2132 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002133 properties of the info popup when it is created. If an info popup
2134 window already exists it is closed, so that the option value is
2135 applied when it is created again.
2136 You can also use |popup_findinfo()| and then set properties for an
2137 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002138
2139
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002140 *'concealcursor'* *'cocu'*
2141'concealcursor' 'cocu' string (default: "")
2142 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002143 {not available when compiled without the |+conceal|
2144 feature}
2145 Sets the modes in which text in the cursor line can also be concealed.
2146 When the current mode is listed then concealing happens just like in
2147 other lines.
2148 n Normal mode
2149 v Visual mode
2150 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002151 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002152
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002153 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002154 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002155 are moving around text is concealed, but when starting to insert text
2156 or selecting a Visual area the concealed text is displayed, so that
2157 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002158 Keep in mind that the cursor position is not always where it's
2159 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002160
2161
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002162 *'conceallevel'* *'cole'*
2163'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002164 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002165 {not available when compiled without the |+conceal|
2166 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002167 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2168 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002169
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002170 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002171 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002172 1 Each block of concealed text is replaced with one
2173 character. If the syntax item does not have a custom
2174 replacement character defined (see |:syn-cchar|) the
2175 character defined in 'listchars' is used (default is a
2176 space).
2177 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002178 2 Concealed text is completely hidden unless it has a
2179 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002180 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002181 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002182
Bram Moolenaara7781e02010-07-19 20:13:22 +02002183 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002184 edit and copy the text. This can be changed with the 'concealcursor'
2185 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002186
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2188'confirm' 'cf' boolean (default off)
2189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 When 'confirm' is on, certain operations that would normally
2191 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2192 instead raise a |dialog| asking if you wish to save the current
2193 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2194 If 'confirm' is off you can still activate confirmation for one
2195 command only (this is most useful in mappings) with the |:confirm|
2196 command.
2197 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2198
2199 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2200'conskey' 'consk' boolean (default off)
2201 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002202 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203
2204 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2205'copyindent' 'ci' boolean (default off)
2206 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 Copy the structure of the existing lines indent when autoindenting a
2208 new line. Normally the new indent is reconstructed by a series of
2209 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2210 in which case only spaces are used). Enabling this option makes the
2211 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002212 existing line. 'expandtab' has no effect on these characters, a Tab
2213 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002215 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216 Also see 'preserveindent'.
2217
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002218 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219'cpoptions' 'cpo' string (Vim default: "aABceFs",
2220 Vi default: all flags)
2221 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002223 this indicates Vi-compatible behavior. This is used for things where
2224 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 'cpoptions' stands for "compatible-options".
2226 Commas can be added for readability.
2227 To avoid problems with flags that are added in the future, use the
2228 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002229
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 NOTE: This option is set to the Vi default value when 'compatible' is
2231 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002232
2233 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2234 is saved, 'cpoptions' is set to the Vim default, and the saved value
2235 is restored at the end of the script. Changes to the value of
2236 'cpoptions' will be applied to the saved value, but keep in mind that
2237 removing a flag that is not present when 'cpoptions' is changed has no
2238 effect. In the |.vimrc| file the value is not restored, thus using
2239 `vim9script` in the |.vimrc| file results in using the Vim default.
2240
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002241 NOTE: This option is set to the POSIX default value at startup when
2242 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002243 variable exists |posix|. This means Vim tries to behave like the
2244 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245
2246 contains behavior ~
2247 *cpo-a*
2248 a When included, a ":read" command with a file name
2249 argument will set the alternate file name for the
2250 current window.
2251 *cpo-A*
2252 A When included, a ":write" command with a file name
2253 argument will set the alternate file name for the
2254 current window.
2255 *cpo-b*
2256 b "\|" in a ":map" command is recognized as the end of
2257 the map command. The '\' is included in the mapping,
2258 the text after the '|' is interpreted as the next
2259 command. Use a CTRL-V instead of a backslash to
2260 include the '|' in the mapping. Applies to all
2261 mapping, abbreviation, menu and autocmd commands.
2262 See also |map_bar|.
2263 *cpo-B*
2264 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002265 abbreviations, user commands and the "to" part of the
2266 menu commands. Remove this flag to be able to use a
2267 backslash like a CTRL-V. For example, the command
2268 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 'B' included: "\^[" (^[ is a real <Esc>)
2270 'B' excluded: "<Esc>" (5 characters)
2271 ('<' excluded in both cases)
2272 *cpo-c*
2273 c Searching continues at the end of any match at the
2274 cursor position, but not further than the start of the
2275 next line. When not present searching continues
2276 one character from the cursor position. With 'c'
2277 "abababababab" only gets three matches when repeating
2278 "/abab", without 'c' there are five matches.
2279 *cpo-C*
2280 C Do not concatenate sourced lines that start with a
2281 backslash. See |line-continuation|.
2282 *cpo-d*
2283 d Using "./" in the 'tags' option doesn't mean to use
2284 the tags file relative to the current file, but the
2285 tags file in the current directory.
2286 *cpo-D*
2287 D Can't use CTRL-K to enter a digraph after Normal mode
2288 commands with a character argument, like |r|, |f| and
2289 |t|.
2290 *cpo-e*
2291 e When executing a register with ":@r", always add a
2292 <CR> to the last line, also when the register is not
2293 linewise. If this flag is not present, the register
2294 is not linewise and the last line does not end in a
2295 <CR>, then the last line is put on the command-line
2296 and can be edited before hitting <CR>.
2297 *cpo-E*
2298 E It is an error when using "y", "d", "c", "g~", "gu" or
2299 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002300 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301 This makes "y0" fail in the first column.
2302 *cpo-f*
2303 f When included, a ":read" command with a file name
2304 argument will set the file name for the current buffer,
2305 if the current buffer doesn't have a file name yet.
2306 *cpo-F*
2307 F When included, a ":write" command with a file name
2308 argument will set the file name for the current
2309 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002310 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 *cpo-g*
2312 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002313 *cpo-H*
2314 H When using "I" on a line with only blanks, insert
2315 before the last blank. Without this flag insert after
2316 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 *cpo-i*
2318 i When included, interrupting the reading of a file will
2319 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002320 *cpo-I*
2321 I When moving the cursor up or down just after inserting
2322 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 *cpo-j*
2324 j When joining lines, only add two spaces after a '.',
2325 not after '!' or '?'. Also see 'joinspaces'.
2326 *cpo-J*
2327 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002328 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 white space.
2330 *cpo-k*
2331 k Disable the recognition of raw key codes in
2332 mappings, abbreviations, and the "to" part of menu
2333 commands. For example, if <Key> sends ^[OA (where ^[
2334 is <Esc>), the command ":map X ^[OA" results in X
2335 being mapped to:
2336 'k' included: "^[OA" (3 characters)
2337 'k' excluded: "<Key>" (one key code)
2338 Also see the '<' flag below.
2339 *cpo-K*
2340 K Don't wait for a key code to complete when it is
2341 halfway a mapping. This breaks mapping <F1><F1> when
2342 only part of the second <F1> has been read. It
2343 enables cancelling the mapping by typing <F1><Esc>.
2344 *cpo-l*
2345 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002346 literally, only "\]", "\^", "\-" and "\\" are special.
2347 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2349 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002350 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 *cpo-L*
2352 L When the 'list' option is set, 'wrapmargin',
2353 'textwidth', 'softtabstop' and Virtual Replace mode
2354 (see |gR|) count a <Tab> as two characters, instead of
2355 the normal behavior of a <Tab>.
2356 *cpo-m*
2357 m When included, a showmatch will always wait half a
2358 second. When not included, a showmatch will wait half
2359 a second or until a character is typed. |'showmatch'|
2360 *cpo-M*
2361 M When excluded, "%" matching will take backslashes into
2362 account. Thus in "( \( )" and "\( ( \)" the outer
2363 parenthesis match. When included "%" ignores
2364 backslashes, which is Vi compatible.
2365 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002366 n When included, the column used for 'number' and
2367 'relativenumber' will also be used for text of wrapped
2368 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 *cpo-o*
2370 o Line offset to search command is not remembered for
2371 next search.
2372 *cpo-O*
2373 O Don't complain if a file is being overwritten, even
2374 when it didn't exist when editing it. This is a
2375 protection against a file unexpectedly created by
2376 someone else. Vi didn't complain about this.
2377 *cpo-p*
2378 p Vi compatible Lisp indenting. When not present, a
2379 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002380 *cpo-P*
2381 P When included, a ":write" command that appends to a
2382 file will set the file name for the current buffer, if
2383 the current buffer doesn't have a file name yet and
2384 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002385 *cpo-q*
2386 q When joining multiple lines leave the cursor at the
2387 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 *cpo-r*
2389 r Redo ("." command) uses "/" to repeat a search
2390 command, instead of the actually used search string.
2391 *cpo-R*
2392 R Remove marks from filtered lines. Without this flag
2393 marks are kept like |:keepmarks| was used.
2394 *cpo-s*
2395 s Set buffer options when entering the buffer for the
2396 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002397 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 set when the buffer is created.
2399 *cpo-S*
2400 S Set buffer options always when entering a buffer
2401 (except 'readonly', 'fileformat', 'filetype' and
2402 'syntax'). This is the (most) Vi compatible setting.
2403 The options are set to the values in the current
2404 buffer. When you change an option and go to another
2405 buffer, the value is copied. Effectively makes the
2406 buffer options global to all buffers.
2407
2408 's' 'S' copy buffer options
2409 no no when buffer created
2410 yes no when buffer first entered (default)
2411 X yes each time when buffer entered (vi comp.)
2412 *cpo-t*
2413 t Search pattern for the tag command is remembered for
2414 "n" command. Otherwise Vim only puts the pattern in
2415 the history for search pattern, but doesn't change the
2416 last used search pattern.
2417 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002418 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 *cpo-v*
2420 v Backspaced characters remain visible on the screen in
2421 Insert mode. Without this flag the characters are
2422 erased from the screen right away. With this flag the
2423 screen newly typed text overwrites backspaced
2424 characters.
2425 *cpo-w*
2426 w When using "cw" on a blank character, only change one
2427 character and not all blanks until the start of the
2428 next word.
2429 *cpo-W*
2430 W Don't overwrite a readonly file. When omitted, ":w!"
2431 overwrites a readonly file, if possible.
2432 *cpo-x*
2433 x <Esc> on the command-line executes the command-line.
2434 The default in Vim is to abandon the command-line,
2435 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002436 *cpo-X*
2437 X When using a count with "R" the replaced text is
2438 deleted only once. Also when repeating "R" with "."
2439 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002441 y A yank command can be redone with ".". Think twice if
2442 you really want to use this, it may break some
2443 plugins, since most people expect "." to only repeat a
2444 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002445 *cpo-Z*
2446 Z When using "w!" while the 'readonly' option is set,
2447 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 *cpo-!*
2449 ! When redoing a filter command, use the last used
2450 external command, whatever it was. Otherwise the last
2451 used -filter- command is used.
2452 *cpo-$*
2453 $ When making a change to one line, don't redisplay the
2454 line, but put a '$' at the end of the changed text.
2455 The changed text will be overwritten when you type the
2456 new text. The line is redisplayed if you type any
2457 command that moves the cursor from the insertion
2458 point.
2459 *cpo-%*
2460 % Vi-compatible matching is done for the "%" command.
2461 Does not recognize "#if", "#endif", etc.
2462 Does not recognize "/*" and "*/".
2463 Parens inside single and double quotes are also
2464 counted, causing a string that contains a paren to
2465 disturb the matching. For example, in a line like
2466 "if (strcmp("foo(", s))" the first paren does not
2467 match the last one. When this flag is not included,
2468 parens inside single and double quotes are treated
2469 specially. When matching a paren outside of quotes,
2470 everything inside quotes is ignored. When matching a
2471 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002472 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002473 This flag is also used for other features, such as
2474 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002475 *cpo--*
2476 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002477 it would go above the first line or below the last
2478 line. Without it the cursor moves to the first or
2479 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002480 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002481 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002482 *cpo-+*
2483 + When included, a ":write file" command will reset the
2484 'modified' flag of the buffer, even though the buffer
2485 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002486 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 * Use ":*" in the same way as ":@". When not included,
2488 ":*" is an alias for ":'<,'>", select the Visual area.
2489 *cpo-<*
2490 < Disable the recognition of special key codes in |<>|
2491 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002492 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 ":map X <Tab>" results in X being mapped to:
2494 '<' included: "<Tab>" (5 characters)
2495 '<' excluded: "^I" (^I is a real <Tab>)
2496 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002497 *cpo->*
2498 > When appending to a register, put a line break before
2499 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002500 *cpo-;*
2501 ; When using |,| or |;| to repeat the last |t| search
2502 and the cursor is right in front of the searched
2503 character, the cursor won't move. When not included,
2504 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002505 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002506
2507 POSIX flags. These are not included in the Vi default value, except
2508 when $VIM_POSIX was set on startup. |posix|
2509
2510 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002511 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002512 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002513 *cpo-&*
2514 & When ":preserve" was used keep the swap file when
2515 exiting normally while this buffer is still loaded.
2516 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002517 *cpo-\*
2518 \ Backslash in a [] range in a search pattern is taken
2519 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002520 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2521 '\' excluded: "/[ \-]" finds <Space> and '-'
2522 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002523 *cpo-/*
2524 / When "%" is used as the replacement string in a |:s|
2525 command, use the previous replacement string. |:s%|
2526 *cpo-{*
2527 { The |{| and |}| commands also stop at a "{" character
2528 at the start of a line.
2529 *cpo-.*
2530 . The ":chdir" and ":cd" commands fail if the current
2531 buffer is modified, unless ! is used. Vim doesn't
2532 need this, since it remembers the full path of an
2533 opened file.
2534 *cpo-bar*
2535 | The value of the $LINES and $COLUMNS environment
2536 variables overrule the terminal size values obtained
2537 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002538
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002540 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002541'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002542 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002543 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002544 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002545 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002546 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002547 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002548 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002549 blowfish Blowfish method. Medium strong encryption but it has
2550 an implementation flaw. Requires Vim 7.3 or later,
2551 files can NOT be read by Vim 7.2 and older. This adds
2552 a "seed" to the file, every time you write the file
2553 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002554 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002555 *blowfish2*
2556 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002557 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002558 and older. This adds a "seed" to the file, every time
2559 you write the file the encrypted bytes will be
2560 different. The whole undo file is encrypted, not just
2561 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002562 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002563 *E1197* *E1198* *E1199* *E1200* *E1201*
2564 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2565 Code. Medium strong till strong encryption.
2566 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002567 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002568 It adds a seed and a message authentication code (MAC)
2569 to the file. This needs at least a Vim 8.2.3022 to
2570 read the encrypted file.
2571 Encryption of swap files is not supported, therefore
2572 no swap file will be used when xchacha20 encryption is
2573 enabled.
2574 Encryption of undo files is not yet supported,
2575 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002576 CAREFUL: Files written with this method might have to
2577 be read back with the same version of Vim if the
2578 binary format changes later.
2579 Obsolete, please do no longer use.
2580 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2581 stores the key derivation parameters together with the
2582 encrypted file. Should work better in case the
2583 parameters in the libsodium library ever change.
2584 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002585 might have to be read back with the same version of
2586 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002587
Christian Brabandtaae58342023-04-23 17:50:22 +01002588 You should use "blowfish2", also to re-encrypt older files. The
2589 "xchacha20" method provides better encryption, but it does not work
2590 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002591
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002592 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002593 to the detected method of the file being read. Thus if you write it
2594 without changing 'cryptmethod' the same method will be used.
2595 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002596 explicitly write it, you don't get a warning unless there are other
2597 modifications. Also see |:X|.
2598
2599 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002600 the value "blowfish2". When setting the local value to an empty
2601 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002602
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002603 When a new encryption method is added in a later version of Vim, and
2604 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002605 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002606
2607
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 *'cscopepathcomp'* *'cspc'*
2609'cscopepathcomp' 'cspc' number (default 0)
2610 global
2611 {not available when compiled without the |+cscope|
2612 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 Determines how many components of the path to show in a list of tags.
2614 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002615 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616
2617 *'cscopeprg'* *'csprg'*
2618'cscopeprg' 'csprg' string (default "cscope")
2619 global
2620 {not available when compiled without the |+cscope|
2621 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 Specifies the command to execute cscope. See |cscopeprg|.
2623 This option cannot be set from a |modeline| or in the |sandbox|, for
2624 security reasons.
2625
2626 *'cscopequickfix'* *'csqf'*
2627'cscopequickfix' 'csqf' string (default "")
2628 global
2629 {not available when compiled without the |+cscope|
2630 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 Specifies whether to use quickfix window to show cscope results.
2632 See |cscopequickfix|.
2633
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002634 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002635'cscoperelative' 'csre' boolean (default off)
2636 global
2637 {not available when compiled without the |+cscope|
2638 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002639 In the absence of a prefix (-P) for cscope. setting this option enables
2640 to use the basename of cscope.out path as the prefix.
2641 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002642 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002643
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2645'cscopetag' 'cst' boolean (default off)
2646 global
2647 {not available when compiled without the |+cscope|
2648 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 Use cscope for tag commands. See |cscope-options|.
2650 NOTE: This option is reset when 'compatible' is set.
2651
2652 *'cscopetagorder'* *'csto'*
2653'cscopetagorder' 'csto' number (default 0)
2654 global
2655 {not available when compiled without the |+cscope|
2656 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 Determines the order in which ":cstag" performs a search. See
2658 |cscopetagorder|.
2659 NOTE: This option is set to 0 when 'compatible' is set.
2660
2661 *'cscopeverbose'* *'csverb'*
2662 *'nocscopeverbose'* *'nocsverb'*
2663'cscopeverbose' 'csverb' boolean (default off)
2664 global
2665 {not available when compiled without the |+cscope|
2666 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 Give messages when adding a cscope database. See |cscopeverbose|.
2668 NOTE: This option is reset when 'compatible' is set.
2669
Bram Moolenaar860cae12010-06-05 23:22:07 +02002670 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2671'cursorbind' 'crb' boolean (default off)
2672 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002673 When this option is set, as the cursor in the current
2674 window moves other cursorbound windows (windows that also have
2675 this option set) move their cursors to the corresponding line and
2676 column. This option is useful for viewing the
2677 differences between two versions of a file (see 'diff'); in diff mode,
2678 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002679 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002680
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002681
2682 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2683'cursorcolumn' 'cuc' boolean (default off)
2684 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002685 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002686 feature}
2687 Highlight the screen column of the cursor with CursorColumn
2688 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2689 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002690 If you only want the highlighting in the current window you can use
2691 these autocommands: >
2692 au WinLeave * set nocursorline nocursorcolumn
2693 au WinEnter * set cursorline cursorcolumn
2694<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002695
2696 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2697'cursorline' 'cul' boolean (default off)
2698 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002699 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002700 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002701 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2702 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002703 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002704 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002705
2706
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002707 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002708'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002709 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002710 {not available when compiled without the |+syntax|
2711 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002712 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002713 Valid values:
2714 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002715 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002716 "screenline" Highlight only the screen line of the cursor with
2717 CursorLine |hl-CursorLine|.
2718 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002719 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002720
2721 Special value:
2722 "both" Alias for the values "line,number".
2723
2724 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002725
2726
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 *'debug'*
2728'debug' string (default "")
2729 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002730 These values can be used:
2731 msg Error messages that would otherwise be omitted will be given
2732 anyway.
2733 throw Error messages that would otherwise be omitted will be given
2734 anyway and also throw an exception and set |v:errmsg|.
2735 beep A message will be given when otherwise only a beep would be
2736 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002737 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002738 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2739 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740
2741 *'define'* *'def'*
2742'define' 'def' string (default "^\s*#\s*define")
2743 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002744 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 pattern, just like for the "/" command. This option is used for the
2746 commands like "[i" and "[d" |include-search|. The 'isident' option is
2747 used to recognize the defined name after the match:
2748 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2749 See |option-backslash| about inserting backslashes to include a space
2750 or backslash.
2751 The default value is for C programs. For C++ this value would be
2752 useful, to include const type declarations: >
2753 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002754< You can also use "\ze" just before the name and continue the pattern
2755 to check what is following. E.g. for Javascript, if a function is
2756 defined with "func_name = function(args)": >
2757 ^\s*\ze\i\+\s*=\s*function(
2758< If the function is defined with "func_name : function() {...": >
2759 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002761 To avoid that use `:let` with a single quote string: >
2762 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002763<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764
2765 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2766'delcombine' 'deco' boolean (default off)
2767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 If editing Unicode and this option is set, backspace and Normal mode
2769 "x" delete each combining character on its own. When it is off (the
2770 default) the character along with its combining characters are
2771 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002772 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773
2774 This is useful for Arabic, Hebrew and many other languages where one
2775 may have combining characters overtop of base characters, and want
2776 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002777 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778
2779 *'dictionary'* *'dict'*
2780'dictionary' 'dict' string (default "")
2781 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 List of file names, separated by commas, that are used to lookup words
2783 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2784 contain a list of words. This can be one word per line, or several
2785 words per line, separated by non-keyword characters (white space is
2786 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002787
2788 When this option is empty or an entry "spell" is present, and spell
2789 checking is enabled, words in the word lists for the currently active
2790 'spelllang' are used. See |spell|.
2791
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002792 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 after a comma are ignored, otherwise spaces are included in the file
2794 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002795 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 Where to find a list of words?
2797 - On FreeBSD, there is the file "/usr/share/dict/words".
2798 - In the Simtel archive, look in the "msdos/linguist" directory.
2799 - In "miscfiles" of the GNU collection.
2800 The use of |:set+=| and |:set-=| is preferred when adding or removing
2801 directories from the list. This avoids problems when a future version
2802 uses another default.
2803 Backticks cannot be used in this option for security reasons.
2804
2805 *'diff'* *'nodiff'*
2806'diff' boolean (default off)
2807 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 {not available when compiled without the |+diff|
2809 feature}
2810 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002811 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812
2813 *'dex'* *'diffexpr'*
2814'diffexpr' 'dex' string (default "")
2815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 {not available when compiled without the |+diff|
2817 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002818 Expression which is evaluated to obtain a diff file (either ed-style
2819 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 This option cannot be set from a |modeline| or in the |sandbox|, for
2821 security reasons.
2822
2823 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002824'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 {not available when compiled without the |+diff|
2827 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002828 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 All are optional. Items must be separated by a comma.
2830
2831 filler Show filler lines, to keep the text
2832 synchronized with a window that has inserted
2833 lines at the same position. Mostly useful
2834 when windows are side-by-side and 'scrollbind'
2835 is set.
2836
2837 context:{n} Use a context of {n} lines between a change
2838 and a fold that contains unchanged lines.
2839 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002840 When using zero the context is actually one,
2841 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002842 for a deleted line. Set it to a very large
2843 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 See |fold-diff|.
2845
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002846 iblank Ignore changes where lines are all blank. Adds
2847 the "-B" flag to the "diff" command if
2848 'diffexpr' is empty. Check the documentation
2849 of the "diff" command for what this does
2850 exactly.
2851 NOTE: the diff windows will get out of sync,
2852 because no differences between blank lines are
2853 taken into account.
2854
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 icase Ignore changes in case of text. "a" and "A"
2856 are considered the same. Adds the "-i" flag
2857 to the "diff" command if 'diffexpr' is empty.
2858
2859 iwhite Ignore changes in amount of white space. Adds
2860 the "-b" flag to the "diff" command if
2861 'diffexpr' is empty. Check the documentation
2862 of the "diff" command for what this does
2863 exactly. It should ignore adding trailing
2864 white space, but not leading white space.
2865
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002866 iwhiteall Ignore all white space changes. Adds
2867 the "-w" flag to the "diff" command if
2868 'diffexpr' is empty. Check the documentation
2869 of the "diff" command for what this does
2870 exactly.
2871
2872 iwhiteeol Ignore white space changes at end of line.
2873 Adds the "-Z" flag to the "diff" command if
2874 'diffexpr' is empty. Check the documentation
2875 of the "diff" command for what this does
2876 exactly.
2877
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002878 horizontal Start diff mode with horizontal splits (unless
2879 explicitly specified otherwise).
2880
2881 vertical Start diff mode with vertical splits (unless
2882 explicitly specified otherwise).
2883
Bram Moolenaarc8234772019-11-10 21:00:27 +01002884 closeoff When a window is closed where 'diff' is set
2885 and there is only one window remaining in the
2886 same tab page with 'diff' set, execute
2887 `:diffoff` in that window. This undoes a
2888 `:diffsplit` command.
2889
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002890 hiddenoff Do not use diff mode for a buffer when it
2891 becomes hidden.
2892
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002893 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2894 starting diff mode. Without this 2 is used.
2895
Bram Moolenaar4223d432021-02-10 13:18:17 +01002896 followwrap Follow the 'wrap' option and leave as it is.
2897
Bram Moolenaare828b762018-09-10 17:51:58 +02002898 internal Use the internal diff library. This is
2899 ignored when 'diffexpr' is set. *E960*
2900 When running out of memory when writing a
2901 buffer this item will be ignored for diffs
2902 involving that buffer. Set the 'verbose'
2903 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904
Bram Moolenaare828b762018-09-10 17:51:58 +02002905 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002906 Use the indent heuristic for the internal
2907 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002908
2909 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002910 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002911 algorithms are:
2912 myers the default algorithm
2913 minimal spend extra time to generate the
2914 smallest possible diff
2915 patience patience diff algorithm
2916 histogram histogram diff algorithm
2917
2918 Examples: >
2919 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002921 :set diffopt=internal,filler,foldcolumn:3
2922 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923<
2924 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2925'digraph' 'dg' boolean (default off)
2926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 {not available when compiled without the |+digraphs|
2928 feature}
2929 Enable the entering of digraphs in Insert mode with {char1} <BS>
2930 {char2}. See |digraphs|.
2931 NOTE: This option is reset when 'compatible' is set.
2932
2933 *'directory'* *'dir'*
2934'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002935 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 for Unix: ".,~/tmp,/var/tmp,/tmp")
2937 global
2938 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002939 Recommended value: ".,~/vimswap//" - this will put the swap file next
2940 to the edited file if possible, and in your personal swap directory
2941 otherwise. Make sure "~/vimswap//" is only readable for you.
2942
2943 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 - The swap file will be created in the first directory where this is
2945 possible.
2946 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002947 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 - A directory "." means to put the swap file in the same directory as
2949 the edited file. On Unix, a dot is prepended to the file name, so
2950 it doesn't show in a directory listing. On MS-Windows the "hidden"
2951 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002952 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2953 the swap file relative to where the edited file is. The leading "."
2954 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002955 - For Unix and Win32, if a directory ends in two path separators "//",
2956 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002957 with all path separators replaced by percent '%' signs (including
2958 the colon following the drive letter on Win32). This will ensure
2959 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002960 On Win32, it is also possible to end with "\\". However, When a
2961 separating comma is following, you must use "//", since "\\" will
2962 include the comma in the file name. Therefore it is recommended to
2963 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 - Spaces after the comma are ignored, other spaces are considered part
2965 of the directory name. To have a space at the start of a directory
2966 name, precede it with a backslash.
2967 - To include a comma in a directory name precede it with a backslash.
2968 - A directory name may end in an ':' or '/'.
2969 - Environment variables are expanded |:set_env|.
2970 - Careful with '\' characters, type one before a space, type two to
2971 get one in the option (see |option-backslash|), for example: >
2972 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2973< - For backwards compatibility with Vim version 3.0 a '>' at the start
2974 of the option is removed.
2975 Using "." first in the list is recommended. This means that editing
2976 the same file twice will result in a warning. Using "/tmp" on Unix is
2977 discouraged: When the system crashes you lose the swap file.
2978 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002979 choice than "/tmp". But others on the computer may be able to see the
2980 files, and it can contain a lot of files, your swap files get lost in
2981 the crowd. That is why a "tmp" directory in your home directory is
2982 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 The use of |:set+=| and |:set-=| is preferred when adding or removing
2984 directories from the list. This avoids problems when a future version
2985 uses another default.
2986 This option cannot be set from a |modeline| or in the |sandbox|, for
2987 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988
2989 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002990'display' 'dy' string (default "", set to "truncate" in
2991 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01002993 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 flags:
2995 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002996 in a window will be displayed. "@@@" is put in the
2997 last columns of the last screen line to indicate the
2998 rest of the line is not displayed.
2999 truncate Like "lastline", but "@@@" is displayed in the first
3000 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 uhex Show unprintable characters hexadecimal as <xx>
3002 instead of using ^C and ~C.
3003
Bram Moolenaard0796902016-09-16 20:02:31 +02003004 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003005 doesn't fit is replaced with "@" lines.
3006
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003007 The "@" character can be changed by setting the "lastline" item in
3008 'fillchars'. The character is highlighted with |hl-NonText|.
3009
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 *'eadirection'* *'ead'*
3011'eadirection' 'ead' string (default "both")
3012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 Tells when the 'equalalways' option applies:
3014 ver vertically, width of windows is not affected
3015 hor horizontally, height of windows is not affected
3016 both width and height of windows is affected
3017
3018 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3019'edcompatible' 'ed' boolean (default off)
3020 global
3021 Makes the 'g' and 'c' flags of the ":substitute" command to be
3022 toggled each time the flag is given. See |complex-change|. See
3023 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003024 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003025 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026
Bram Moolenaar03413f42016-04-12 21:07:15 +02003027 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003028'emoji' 'emo' boolean (default: on)
3029 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003030 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003031 This excludes "text emoji" characters, which are normally displayed as
3032 single width. Unfortunately there is no good specification for this
3033 and it has been determined on trial-and-error basis. Use the
3034 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003035
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003037'encoding' 'enc' string (default for MS-Windows: "utf-8",
3038 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 Sets the character encoding used inside Vim. It applies to text in
3041 the buffers, registers, Strings in expressions, text stored in the
3042 viminfo file, etc. It sets the kind of characters which Vim can work
3043 with. See |encoding-names| for the possible values.
3044
3045 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003046 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003048 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049
Bram Moolenaar865242e2010-07-14 21:12:05 +02003050 This option cannot be set from a |modeline|. It would most likely
3051 corrupt the text.
3052
Bram Moolenaar3df01732017-02-17 22:47:16 +01003053 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3054 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 'encoding', "utf-8" is the natural choice for the environment and
3056 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003057 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 versions, and to avoid changing the encoding of newly created files
3059 without your knowledge (in case 'fileencodings' is empty).
3060
3061 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003062 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 iconv() or as specified with 'charconvert'.
3064
Bram Moolenaar207f0092020-08-30 17:20:20 +02003065 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003066 can use: >
3067 if has("multi_byte_encoding")
3068<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 Normally 'encoding' will be equal to your current locale. This will
3070 be the default if Vim recognizes your environment settings. If
3071 'encoding' is not set to the current locale, 'termencoding' must be
3072 set to convert typed and displayed text. See |encoding-table|.
3073
3074 When you set this option, it fires the |EncodingChanged| autocommand
3075 event so that you can set up fonts if necessary.
3076
3077 When the option is set, the value is converted to lowercase. Thus
3078 you can set it with uppercase values too. Underscores are translated
3079 to '-' signs.
3080 When the encoding is recognized, it is changed to the standard name.
3081 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3082 "iso-8859-2" and "utf8" becomes "utf-8".
3083
3084 Note: "latin1" is also used when the encoding could not be detected.
3085 This only works when editing files in the same encoding! When the
3086 actual character set is not latin1, make sure 'fileencoding' and
3087 'fileencodings' are empty. When conversion is needed, switch to using
3088 utf-8.
3089
3090 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3091 You don't notice this while editing, but it does matter for the
3092 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3093 setting 'encoding' to one of these values instead of utf-8 only has
3094 effect for encoding used for files when 'fileencoding' is empty.
3095
Bram Moolenaar661b1822005-07-28 22:36:45 +00003096 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3097 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003099 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003100'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003102 Indicates that a CTRL-Z character was found at the end of the file
3103 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003105 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003106 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003107 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003108
3109 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3110'endofline' 'eol' boolean (default on)
3111 local to buffer
3112 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003113 is on, or 'fixeol' option is off, no <EOL> will be written for the
3114 last line in the file. This option is automatically set or reset when
3115 starting to edit a new file, depending on whether file has an <EOL>
3116 for the last line in the file. Normally you don't have to set or
3117 reset this option.
3118 When 'binary' is off and 'fixeol' is on the value is not used when
3119 writing the file. When 'binary' is on or 'fixeol' is off it is used
3120 to remember the presence of a <EOL> for the last line in the file, so
3121 that when you write the file the situation from the original file can
3122 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003123 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124
3125 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3126'equalalways' 'ea' boolean (default on)
3127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003129 splitting or closing a window. This also happens the moment the
3130 option is switched on. When off, splitting a window will reduce the
3131 size of the current window and leave the other windows the same. When
3132 closing a window the extra lines are given to the window next to it
3133 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 When mixing vertically and horizontally split windows, a minimal size
3135 is computed and some windows may be larger if there is room. The
3136 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003137 Changing the height and width of a window can be avoided by setting
3138 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003139 If a window size is specified when creating a new window sizes are
3140 currently not equalized (it's complicated, but may be implemented in
3141 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142
3143 *'equalprg'* *'ep'*
3144'equalprg' 'ep' string (default "")
3145 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003147 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003148 or 'indentexpr'. When Vim was compiled without internal formatting,
3149 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003150 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 about including spaces and backslashes.
3152 This option cannot be set from a |modeline| or in the |sandbox|, for
3153 security reasons.
3154
3155 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3156'errorbells' 'eb' boolean (default off)
3157 global
3158 Ring the bell (beep or screen flash) for error messages. This only
3159 makes a difference for error messages, the bell will be used always
3160 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003161 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003162 screen flash or do nothing. See 'belloff' to finetune when to ring the
3163 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164
3165 *'errorfile'* *'ef'*
3166'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3167 others: "errors.err")
3168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 {not available when compiled without the |+quickfix|
3170 feature}
3171 Name of the errorfile for the QuickFix mode (see |:cf|).
3172 When the "-q" command-line argument is used, 'errorfile' is set to the
3173 following argument. See |-q|.
3174 NOT used for the ":make" command. See 'makeef' for that.
3175 Environment variables are expanded |:set_env|.
3176 See |option-backslash| about including spaces and backslashes.
3177 This option cannot be set from a |modeline| or in the |sandbox|, for
3178 security reasons.
3179
3180 *'errorformat'* *'efm'*
3181'errorformat' 'efm' string (default is very long)
3182 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 {not available when compiled without the |+quickfix|
3184 feature}
3185 Scanf-like description of the format for the lines in the error file
3186 (see |errorformat|).
3187
3188 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3189'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 Function keys that start with an <Esc> are recognized in Insert
3192 mode. When this option is off, the cursor and function keys cannot be
3193 used in Insert mode if they start with an <Esc>. The advantage of
3194 this is that the single <Esc> is recognized immediately, instead of
3195 after one second. Instead of resetting this option, you might want to
3196 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3197 when 'esckeys' is off, you can still map anything, but the cursor keys
3198 won't work by default.
3199 NOTE: This option is set to the Vi default value when 'compatible' is
3200 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003201 NOTE: when this option is off then the |modifyOtherKeys| functionality
3202 is disabled while in Insert mode to avoid ending Insert mode with any
3203 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204
3205 *'eventignore'* *'ei'*
3206'eventignore' 'ei' string (default "")
3207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003209 When set to "all" or when "all" is one of the items, all autocommand
3210 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003211 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 :set ei=WinEnter,WinLeave
3213<
3214 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3215'expandtab' 'et' boolean (default off)
3216 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003218 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3220 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003221 This option is reset when the 'paste' option is set and restored when
3222 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 NOTE: This option is reset when 'compatible' is set.
3224
3225 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3226'exrc' 'ex' boolean (default off)
3227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003229 directory.
3230
3231 Setting this option is a potential security leak. E.g., consider
3232 unpacking a package or fetching files from github, a .vimrc in there
3233 might be a trojan horse. BETTER NOT SET THIS OPTION!
3234 Instead, define an autocommand in your .vimrc to set options for a
3235 matching directory.
3236
3237 If you do switch this option on you should also consider setting the
3238 'secure' option (see |initialization|).
3239 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 This option cannot be set from a |modeline| or in the |sandbox|, for
3241 security reasons.
3242
3243 *'fileencoding'* *'fenc'* *E213*
3244'fileencoding' 'fenc' string (default: "")
3245 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003247
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003249 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 When 'fileencoding' is empty, the same value as 'encoding' will be
3251 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003252 No error will be given when the value is set, only when it is used,
3253 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003254 Conversion will also be done when 'encoding' and 'fileencoding' are
3255 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3256 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003258 'encoding' is "utf-8" or another Unicode encoding, conversion
3259 is most likely done in a way that the reverse conversion
3260 results in the same text. When 'encoding' is not "utf-8" some
3261 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003262
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 See 'encoding' for the possible values. Additionally, values may be
3264 specified that can be handled by the converter, see
3265 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003266
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 When reading a file 'fileencoding' will be set from 'fileencodings'.
3268 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003269 'fileencoding', use the |++enc| argument. One exception: when
3270 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003271 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003272
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3274 When the option is set, the value is converted to lowercase. Thus
3275 you can set it with uppercase values too. '_' characters are
3276 replaced with '-'. If a name is recognized from the list for
3277 'encoding', it is replaced by the standard name. For example
3278 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003279
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 When this option is set, after starting to edit a file, the 'modified'
3281 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003282
3283 Keep in mind that changing 'fenc' from a modeline happens
3284 AFTER the text has been read, thus it applies to when the file will be
3285 written. If you do set 'fenc' in a modeline, you might want to set
3286 'nomodified' to avoid not being able to ":q".
3287
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 This option can not be changed when 'modifiable' is off.
3289
3290 *'fe'*
3291 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003292 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 old short name was 'fe', which is no longer used.
3294
3295 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003296'fileencodings' 'fencs' string (default: "ucs-bom",
3297 "ucs-bom,utf-8,default,latin1" when
3298 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 This is a list of character encodings considered when starting to edit
3301 an existing file. When a file is read, Vim tries to use the first
3302 mentioned character encoding. If an error is detected, the next one
3303 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003304 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 an empty string, which means the value of 'encoding' is used.
3306 WARNING: Conversion can cause loss of information! When
3307 'encoding' is "utf-8" (or one of the other Unicode variants)
3308 conversion is most likely done in a way that the reverse
3309 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003310 "utf-8" some non-ASCII characters may be lost! You can use
3311 the |++bad| argument to specify what is done with characters
3312 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 For an empty file or a file with only ASCII characters most encodings
3314 will work and the first entry of 'fileencodings' will be used (except
3315 "ucs-bom", which requires the BOM to be present). If you prefer
3316 another encoding use an BufReadPost autocommand event to test if your
3317 preferred encoding is to be used. Example: >
3318 au BufReadPost * if search('\S', 'w') == 0 |
3319 \ set fenc=iso-2022-jp | endif
3320< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3321 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003322 When the |++enc| argument is used then the value of 'fileencodings' is
3323 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003324 Note that 'fileencodings' is not used for a new file, the global value
3325 of 'fileencoding' is used instead. You can set it with: >
3326 :setglobal fenc=iso-8859-2
3327< This means that a non-existing file may get a different encoding than
3328 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 The special value "ucs-bom" can be used to check for a Unicode BOM
3330 (Byte Order Mark) at the start of the file. It must not be preceded
3331 by "utf-8" or another Unicode encoding for this to work properly.
3332 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3333 because Vim cannot detect an error, thus the encoding is always
3334 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003335 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003336 environment. On MS-Windows this is the system encoding. Otherwise
3337 this is the default value for 'encoding'. It is useful when
3338 'encoding' is set to "utf-8" and your environment uses a non-latin1
3339 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003340 When 'encoding' is "utf-8" and a file contains an illegal byte
3341 sequence it won't be recognized as UTF-8. You can use the |8g8|
3342 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 WRONG VALUES: WHAT'S WRONG:
3344 latin1,utf-8 "latin1" will always be used
3345 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3346 file
3347 cp1250,latin1 "cp1250" will always be used
3348 If 'fileencodings' is empty, 'fileencoding' is not modified.
3349 See 'fileencoding' for the possible values.
3350 Setting this option does not have an effect until the next time a file
3351 is read.
3352
3353 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003354'fileformat' 'ff' string (MS-Windows default: "dos",
3355 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 This gives the <EOL> of the current buffer, which is used for
3358 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003359 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 unix <NL>
3361 mac <CR>
3362 When "dos" is used, CTRL-Z at the end of a file is ignored.
3363 See |file-formats| and |file-read|.
3364 For the character encoding of the file see 'fileencoding'.
3365 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003366 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 This option is set automatically when starting to edit a file and
3368 'fileformats' is not empty and 'binary' is off.
3369 When this option is set, after starting to edit a file, the 'modified'
3370 option is set, because the file would be different when written.
3371 This option can not be changed when 'modifiable' is off.
3372 For backwards compatibility: When this option is set to "dos",
3373 'textmode' is set, otherwise 'textmode' is reset.
3374
3375 *'fileformats'* *'ffs'*
3376'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003377 Vim+Vi MS-Windows: "dos,unix",
3378 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 Vi Cygwin: "unix,dos",
3380 Vi others: "")
3381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 This gives the end-of-line (<EOL>) formats that will be tried when
3383 starting to edit a new buffer and when reading a file into an existing
3384 buffer:
3385 - When empty, the format defined with 'fileformat' will be used
3386 always. It is not set automatically.
3387 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003388 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 'fileformats' name will be used when a file is read into an existing
3390 buffer, no matter what 'fileformat' for that buffer is set to.
3391 - When more than one name is present, separated by commas, automatic
3392 <EOL> detection will be done when reading a file. When starting to
3393 edit a file, a check is done for the <EOL>:
3394 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3395 'fileformat' is set to "dos".
3396 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003397 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003399 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3400 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003401 This means that "mac" is only chosen when:
3402 "unix" is not present or no <NL> is found in the file, and
3403 "dos" is not present or no <CR><NL> is found in the file.
3404 Except: if "unix" was chosen, but there is a <CR> before
3405 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003406 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 4. If 'fileformat' is still not set, the first name from
3408 'fileformats' is used.
3409 When reading a file into an existing buffer, the same is done, but
3410 this happens like 'fileformat' has been set appropriately for that
3411 file only, the option is not changed.
3412 When 'binary' is set, the value of 'fileformats' is not used.
3413
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003414 When Vim starts up with an empty buffer the first item is used. You
3415 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003416
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3418 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3419 done:
3420 - When 'fileformats' is empty, there is no automatic detection. Dos
3421 format will be used.
3422 - When 'fileformats' is set to one or more names, automatic detection
3423 is done. This is based on the first <NL> in the file: If there is a
3424 <CR> in front of it, Dos format is used, otherwise Unix format is
3425 used.
3426 Also see |file-formats|.
3427 For backwards compatibility: When this option is set to an empty
3428 string or one format (no comma is included), 'textauto' is reset,
3429 otherwise 'textauto' is set.
3430 NOTE: This option is set to the Vi default value when 'compatible' is
3431 set and to the Vim default value when 'compatible' is reset.
3432
Bram Moolenaarbf884932013-04-05 22:26:15 +02003433 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3434'fileignorecase' 'fic' boolean (default on for systems where case in file
3435 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003436 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003437 When set case is ignored when using file names and directories.
3438 See 'wildignorecase' for only ignoring case when doing completion.
3439
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 *'filetype'* *'ft'*
3441'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003442 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 When this option is set, the FileType autocommand event is triggered.
3444 All autocommands that match with the value of this option will be
3445 executed. Thus the value of 'filetype' is used in place of the file
3446 name.
3447 Otherwise this option does not always reflect the current file type.
3448 This option is normally set when the file type is detected. To enable
3449 this use the ":filetype on" command. |:filetype|
3450 Setting this option to a different value is most useful in a modeline,
3451 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003452 Example, for in an IDL file:
3453 /* vim: set filetype=idl : */ ~
3454 |FileType| |filetypes|
3455 When a dot appears in the value then this separates two filetype
3456 names. Example:
3457 /* vim: set filetype=c.doxygen : */ ~
3458 This will use the "c" filetype first, then the "doxygen" filetype.
3459 This works both for filetype plugins and for syntax files. More than
3460 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 This option is not copied to another buffer, independent of the 's' or
3462 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003463 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464
3465 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003466'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003467 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003468 {not available when compiled without the |+folding|
3469 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003470 Characters to fill the statuslines, vertical separators and special
3471 lines in the window.
3472 It is a comma-separated list of items. Each item has a name, a colon
3473 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003475 item name default Used for ~
3476 stl ' ' or '^' statusline of the current window
3477 stlnc ' ' or '=' statusline of the non-current windows
3478 vert '|' vertical separators |:vsplit|
3479 fold '-' filling 'foldtext'
3480 foldopen '-' mark the beginning of a fold
3481 foldclose '+' show a closed fold
3482 foldsep '|' open fold middle character
3483 diff '-' deleted lines of the 'diff' option
3484 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003485 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003487 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003488 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 otherwise.
3490
3491 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003492 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493< This is similar to the default, except that these characters will also
3494 be used when there is highlighting.
3495
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003496 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3497 single-byte and multibyte characters are supported. But double-width
3498 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003499
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003501 item name highlight group ~
3502 stl StatusLine |hl-StatusLine|
3503 stlnc StatusLineNC |hl-StatusLineNC|
3504 vert VertSplit |hl-VertSplit|
3505 fold Folded |hl-Folded|
3506 diff DiffDelete |hl-DiffDelete|
3507 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003508 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003510 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3511'fixendofline' 'fixeol' boolean (default on)
3512 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003513 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003514 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003515 preserve the situation from the original file.
3516 When the 'binary' option is set the value of this option doesn't
3517 matter.
3518 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003519 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003520
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003522'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 {only available when compiled with the |+rightleft|
3525 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003526 This option was for using Farsi, which has been removed. See
3527 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528
3529 *'foldclose'* *'fcl'*
3530'foldclose' 'fcl' string (default "")
3531 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 {not available when compiled without the |+folding|
3533 feature}
3534 When set to "all", a fold is closed when the cursor isn't in it and
3535 its level is higher than 'foldlevel'. Useful if you want folds to
3536 automatically close when moving out of them.
3537
3538 *'foldcolumn'* *'fdc'*
3539'foldcolumn' 'fdc' number (default 0)
3540 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 {not available when compiled without the |+folding|
3542 feature}
3543 When non-zero, a column with the specified width is shown at the side
3544 of the window which indicates open and closed folds. The maximum
3545 value is 12.
3546 See |folding|.
3547
3548 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3549'foldenable' 'fen' boolean (default on)
3550 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 {not available when compiled without the |+folding|
3552 feature}
3553 When off, all folds are open. This option can be used to quickly
3554 switch between showing all text unfolded and viewing the text with
3555 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003556 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 'foldenable' is off.
3558 This option is set by commands that create a new fold or close a fold.
3559 See |folding|.
3560
3561 *'foldexpr'* *'fde'*
3562'foldexpr' 'fde' string (default: "0")
3563 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003565 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003567 for each line to obtain its fold level. The context is set to the
3568 script where 'foldexpr' was set, script-local items can be accessed.
3569 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003570
Bram Moolenaar30b65812012-07-12 22:01:11 +02003571 The expression will be evaluated in the |sandbox| if set from a
3572 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003573 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003574 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003575
3576 It is not allowed to change text or jump to another window while
3577 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578
3579 *'foldignore'* *'fdi'*
3580'foldignore' 'fdi' string (default: "#")
3581 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 {not available when compiled without the |+folding|
3583 feature}
3584 Used only when 'foldmethod' is "indent". Lines starting with
3585 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003586 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 The default "#" works well for C programs. See |fold-indent|.
3588
3589 *'foldlevel'* *'fdl'*
3590'foldlevel' 'fdl' number (default: 0)
3591 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 {not available when compiled without the |+folding|
3593 feature}
3594 Sets the fold level: Folds with a higher level will be closed.
3595 Setting this option to zero will close all folds. Higher numbers will
3596 close fewer folds.
3597 This option is set by commands like |zm|, |zM| and |zR|.
3598 See |fold-foldlevel|.
3599
3600 *'foldlevelstart'* *'fdls'*
3601'foldlevelstart' 'fdls' number (default: -1)
3602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 {not available when compiled without the |+folding|
3604 feature}
3605 Sets 'foldlevel' when starting to edit another buffer in a window.
3606 Useful to always start editing with all folds closed (value zero),
3607 some folds closed (one) or no folds closed (99).
3608 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003609 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 ignores this option and closes all folds.
3611 It is also done before BufReadPre autocommands, to allow an autocmd to
3612 overrule the 'foldlevel' value for specific files.
3613 When the value is negative, it is not used.
3614
3615 *'foldmarker'* *'fmr'* *E536*
3616'foldmarker' 'fmr' string (default: "{{{,}}}")
3617 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 {not available when compiled without the |+folding|
3619 feature}
3620 The start and end marker used when 'foldmethod' is "marker". There
3621 must be one comma, which separates the start and end marker. The
3622 marker is a literal string (a regular expression would be too slow).
3623 See |fold-marker|.
3624
3625 *'foldmethod'* *'fdm'*
3626'foldmethod' 'fdm' string (default: "manual")
3627 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 {not available when compiled without the |+folding|
3629 feature}
3630 The kind of folding used for the current window. Possible values:
3631 |fold-manual| manual Folds are created manually.
3632 |fold-indent| indent Lines with equal indent form a fold.
3633 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3634 |fold-marker| marker Markers are used to specify folds.
3635 |fold-syntax| syntax Syntax highlighting items specify folds.
3636 |fold-diff| diff Fold text that is not changed.
3637
3638 *'foldminlines'* *'fml'*
3639'foldminlines' 'fml' number (default: 1)
3640 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 {not available when compiled without the |+folding|
3642 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003643 Sets the number of screen lines above which a fold can be displayed
3644 closed. Also for manually closed folds. With the default value of
3645 one a fold can only be closed if it takes up two or more screen lines.
3646 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003647 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 "zc" to close a fold, which is displayed open because it's smaller
3649 than 'foldminlines', a following "zc" may close a containing fold.
3650
3651 *'foldnestmax'* *'fdn'*
3652'foldnestmax' 'fdn' number (default: 20)
3653 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 {not available when compiled without the |+folding|
3655 feature}
3656 Sets the maximum nesting of folds for the "indent" and "syntax"
3657 methods. This avoids that too many folds will be created. Using more
3658 than 20 doesn't work, because the internal limit is 20.
3659
3660 *'foldopen'* *'fdo'*
3661'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3662 search,tag,undo")
3663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 {not available when compiled without the |+folding|
3665 feature}
3666 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003667 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003669 NOTE: When the command is part of a mapping this option is not used.
3670 Add the |zv| command to the mapping to get the same effect.
3671 (rationale: the mapping may want to control opening folds itself)
3672
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 item commands ~
3674 all any
3675 block "(", "{", "[[", "[{", etc.
3676 hor horizontal movements: "l", "w", "fx", etc.
3677 insert any command in Insert mode
3678 jump far jumps: "G", "gg", etc.
3679 mark jumping to a mark: "'m", CTRL-O, etc.
3680 percent "%"
3681 quickfix ":cn", ":crew", ":make", etc.
3682 search search for a pattern: "/", "n", "*", "gd", etc.
3683 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003684 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 tag jumping to a tag: ":ta", CTRL-T, etc.
3686 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 When a movement command is used for an operator (e.g., "dl" or "y%")
3688 this option is not used. This means the operator will include the
3689 whole closed fold.
3690 Note that vertical movements are not here, because it would make it
3691 very difficult to move onto a closed fold.
3692 In insert mode the folds containing the cursor will always be open
3693 when text is inserted.
3694 To close folds you can re-apply 'foldlevel' with the |zx| command or
3695 set the 'foldclose' option to "all".
3696
3697 *'foldtext'* *'fdt'*
3698'foldtext' 'fdt' string (default: "foldtext()")
3699 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 {not available when compiled without the |+folding|
3701 feature}
3702 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003703 fold. The context is set to the script where 'foldexpr' was set,
3704 script-local items can be accessed. See |fold-foldtext| for the
3705 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706
Bram Moolenaar30b65812012-07-12 22:01:11 +02003707 The expression will be evaluated in the |sandbox| if set from a
3708 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003709 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003710
3711 It is not allowed to change text or jump to another window while
3712 evaluating 'foldtext' |textlock|.
3713
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003714 *'formatexpr'* *'fex'*
3715'formatexpr' 'fex' string (default "")
3716 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003717 {not available when compiled without the |+eval|
3718 feature}
3719 Expression which is evaluated to format a range of lines for the |gq|
3720 operator or automatic formatting (see 'formatoptions'). When this
3721 option is empty 'formatprg' is used.
3722
3723 The |v:lnum| variable holds the first line to be formatted.
3724 The |v:count| variable holds the number of lines to be formatted.
3725 The |v:char| variable holds the character that is going to be
3726 inserted if the expression is being evaluated due to
3727 automatic formatting. This can be empty. Don't insert
3728 it yet!
3729
3730 Example: >
3731 :set formatexpr=mylang#Format()
3732< This will invoke the mylang#Format() function in the
3733 autoload/mylang.vim file in 'runtimepath'. |autoload|
3734
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003735 The advantage of using a function call without arguments is that it is
3736 faster, see |expr-option-function|.
3737
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003738 The expression is also evaluated when 'textwidth' is set and adding
3739 text beyond that limit. This happens under the same conditions as
3740 when internal formatting is used. Make sure the cursor is kept in the
3741 same spot relative to the text then! The |mode()| function will
3742 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003743
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003744 When the expression evaluates to non-zero Vim will fall back to using
3745 the internal format mechanism.
3746
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003747 If the expression starts with s: or |<SID>|, then it is replaced with
3748 the script ID (|local-function|). Example: >
3749 set formatexpr=s:MyFormatExpr()
3750 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003751< Otherwise, the expression is evaluated in the context of the script
3752 where the option was set, thus script-local items are available.
3753
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003754 The expression will be evaluated in the |sandbox| when set from a
3755 modeline, see |sandbox-option|. That stops the option from working,
3756 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003757 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003758 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003759
Bram Moolenaar86b68352004-12-27 21:59:20 +00003760 *'formatlistpat'* *'flp'*
3761'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3762 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003763 A pattern that is used to recognize a list header. This is used for
3764 the "n" flag in 'formatoptions'.
3765 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003766 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003767 while still checking more characters. There must be a character
3768 following the pattern, when it matches the whole line it is handled
3769 like there is no match.
3770 The default recognizes a number, followed by an optional punctuation
3771 character and white space.
3772
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003773 *'formatoptions'* *'fo'*
3774'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3775 local to buffer
3776 This is a sequence of letters which describes how automatic
3777 formatting is to be done. See |fo-table|. When the 'paste' option is
3778 on, no formatting is done (like 'formatoptions' is empty). Commas can
3779 be inserted for readability.
3780 To avoid problems with flags that are added in the future, use the
3781 "+=" and "-=" feature of ":set" |add-option-flags|.
3782 NOTE: This option is set to the Vi default value when 'compatible' is
3783 set and to the Vim default value when 'compatible' is reset.
3784
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 *'formatprg'* *'fp'*
3786'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003787 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003789 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003791 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003792 If the 'formatexpr' option is not empty it will be used instead.
3793 Otherwise, if 'formatprg' option is an empty string, the internal
3794 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003795 Environment variables are expanded |:set_env|. See |option-backslash|
3796 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003797 This option cannot be set from a |modeline| or in the |sandbox|, for
3798 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799
Bram Moolenaard94464e2015-11-02 15:28:18 +01003800 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003801'fsync' 'fs' boolean (default on)
3802 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003803 When on, the library function fsync() will be called after writing a
3804 file. This will flush a file to disk, ensuring that it is safely
3805 written even on filesystems which do metadata-only journaling. This
3806 will force the harddrive to spin up on Linux systems running in laptop
3807 mode, so it may be undesirable in some situations. Be warned that
3808 turning this off increases the chances of data loss after a crash. On
3809 systems without an fsync() implementation, this variable is always
3810 off.
3811 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003812 'fsync' also applies to |writefile()| (unless a flag is used to
3813 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003814 This option cannot be set from a |modeline| or in the |sandbox|, for
3815 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003816
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3818'gdefault' 'gd' boolean (default off)
3819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 When on, the ":substitute" flag 'g' is default on. This means that
3821 all matches in a line are substituted instead of one. When a 'g' flag
3822 is given to a ":substitute" command, this will toggle the substitution
3823 of all or one match. See |complex-change|.
3824
3825 command 'gdefault' on 'gdefault' off ~
3826 :s/// subst. all subst. one
3827 :s///g subst. one subst. all
3828 :s///gg subst. all subst. one
3829
3830 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003831 DEPRECATED: Setting this option may break plugins that are not aware
3832 of this option. Also, many users get confused that adding the /g flag
3833 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003834 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835
3836 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003837'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 Format to recognize for the ":grep" command output.
3840 This is a scanf-like string that uses the same format as the
3841 'errorformat' option: see |errorformat|.
3842
3843 *'grepprg'* *'gp'*
3844'grepprg' 'gp' string (default "grep -n ",
3845 Unix: "grep -n $* /dev/null",
3846 Win32: "findstr /n" or "grep -n",
3847 VMS: "SEARCH/NUMBERS ")
3848 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003849 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 and '#' characters, which are expanded like when used in a command-
3851 line. The placeholder "$*" is allowed to specify where the arguments
3852 will be included. Environment variables are expanded |:set_env|. See
3853 |option-backslash| about including spaces and backslashes.
3854 When your "grep" accepts the "-H" argument, use this to make ":grep"
3855 also work well with a single file: >
3856 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003857< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003858 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3859 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003860 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 apply equally to 'grepprg'.
3862 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3863 otherwise it's "grep -n".
3864 This option cannot be set from a |modeline| or in the |sandbox|, for
3865 security reasons.
3866
3867 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3868'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3869 ve:ver35-Cursor,
3870 o:hor50-Cursor,
3871 i-ci:ver25-Cursor/lCursor,
3872 r-cr:hor20-Cursor/lCursor,
3873 sm:block-Cursor
3874 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003875 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 "n-v-c:block,o:hor50,i-ci:hor15,
3877 r-cr:hor30,sm:block")
3878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003880 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003882 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003883 height of the cursor can be changed. This can be done by specifying a
3884 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003885 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3886 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003888 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 mode-list and an argument-list:
3890 mode-list:argument-list,mode-list:argument-list,..
3891 The mode-list is a dash separated list of these modes:
3892 n Normal mode
3893 v Visual mode
3894 ve Visual mode with 'selection' "exclusive" (same as 'v',
3895 if not specified)
3896 o Operator-pending mode
3897 i Insert mode
3898 r Replace mode
3899 c Command-line Normal (append) mode
3900 ci Command-line Insert mode
3901 cr Command-line Replace mode
3902 sm showmatch in Insert mode
3903 a all modes
3904 The argument-list is a dash separated list of these arguments:
3905 hor{N} horizontal bar, {N} percent of the character height
3906 ver{N} vertical bar, {N} percent of the character width
3907 block block cursor, fills the whole character
3908 [only one of the above three should be present]
3909 blinkwait{N} *cursor-blinking*
3910 blinkon{N}
3911 blinkoff{N}
3912 blink times for cursor: blinkwait is the delay before
3913 the cursor starts blinking, blinkon is the time that
3914 the cursor is shown and blinkoff is the time that the
3915 cursor is not shown. The times are in msec. When one
3916 of the numbers is zero, there is no blinking. The
3917 default is: "blinkwait700-blinkon400-blinkoff250".
3918 These numbers are used for a missing entry. This
3919 means that blinking is enabled by default. To switch
3920 blinking off you can use "blinkon0". The cursor only
3921 blinks when Vim is waiting for input, not while
3922 executing a command.
3923 To make the cursor blink in an xterm, see
3924 |xterm-blink|.
3925 {group-name}
3926 a highlight group name, that sets the color and font
3927 for the cursor
3928 {group-name}/{group-name}
3929 Two highlight group names, the first is used when
3930 no language mappings are used, the other when they
3931 are. |language-mapping|
3932
3933 Examples of parts:
3934 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3935 block cursor with colors from the "nCursor"
3936 highlight group
3937 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3938 In Insert and Command-line Insert mode, use a
3939 30% vertical bar cursor with colors from the
3940 "iCursor" highlight group. Blink a bit
3941 faster.
3942
3943 The 'a' mode is different. It will set the given argument-list for
3944 all modes. It does not reset anything to defaults. This can be used
3945 to do a common setting for all modes. For example, to switch off
3946 blinking: "a:blinkon0"
3947
3948 Examples of cursor highlighting: >
3949 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3950 :highlight Cursor gui=NONE guifg=bg guibg=fg
3951<
3952 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003953 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954'guifont' 'gfn' string (default "")
3955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 {only available when compiled with GUI enabled}
3957 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003958 In its simplest form the value is just one font name.
3959 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960
3961 *'guifontset'* *'gfs'*
3962 *E250* *E252* *E234* *E597* *E598*
3963'guifontset' 'gfs' string (default "")
3964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 {only available when compiled with GUI enabled and
3966 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003967 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 When not empty, specifies two (or more) fonts to be used. The first
3969 one for normal English, the second one for your special language. See
3970 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003971
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3973'guifontwide' 'gfw' string (default "")
3974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 {only available when compiled with GUI enabled}
3976 When not empty, specifies a comma-separated list of fonts to be used
3977 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003978 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003979
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 *'guiheadroom'* *'ghr'*
3981'guiheadroom' 'ghr' number (default 50)
3982 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003983 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 The number of pixels subtracted from the screen height when fitting
3985 the GUI window on the screen. Set this before the GUI is started,
3986 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003987 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 lines will be left for window decorations and other items on the
3989 screen. Set it to a negative value to allow windows taller than the
3990 screen.
3991
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003992 *'guiligatures'* *'gli'* *E1243*
3993'guiligatures' 'gli' string (default "")
3994 global
3995 {only for GTK GUI}
3996 List of ASCII characters that, when combined together, can create more
3997 complex shapes. Each character must be a printable ASCII character
3998 with a value in the 32-127 range.
3999 Example: >
4000 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4001< Changing this option updates screen output immediately. Set it to an
4002 empty string to disable ligatures.
4003
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004005'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4006 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004007 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004008 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004011 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 sequence of letters which describes what components and options of the
4013 GUI should be used.
4014 To avoid problems with flags that are added in the future, use the
4015 "+=" and "-=" feature of ":set" |add-option-flags|.
4016
Bram Moolenaar13568252018-03-16 20:46:58 +01004017 Valid characters are as follows:
4018 *'go-!'*
4019 '!' External commands are executed in a terminal window. Without
4020 this flag the MS-Windows GUI will open a console window to
4021 execute the command. The Unix GUI will simulate a dumb
4022 terminal to list the command output.
4023 The terminal window will be positioned at the bottom, and grow
4024 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004025 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 'a' Autoselect: If present, then whenever VISUAL mode is started,
4027 or the Visual area extended, Vim tries to become the owner of
4028 the windowing system's global selection. This means that the
4029 Visually highlighted text is available for pasting into other
4030 applications as well as into Vim itself. When the Visual mode
4031 ends, possibly due to an operation on the text, or when an
4032 application wants to paste the selection, the highlighted text
4033 is automatically yanked into the "* selection register.
4034 Thus the selection is still available for pasting into other
4035 applications after the VISUAL mode has ended.
4036 If not present, then Vim won't become the owner of the
4037 windowing system's global selection unless explicitly told to
4038 by a yank or delete operation for the "* register.
4039 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004040 *'go-P'*
4041 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004042 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004043 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004044 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 applies to the modeless selection.
4046
4047 'guioptions' autoselect Visual autoselect modeless ~
4048 "" - -
4049 "a" yes yes
4050 "A" - yes
4051 "aA" yes yes
4052
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004053 When using a terminal see the 'clipboard' option.
4054
Bram Moolenaar02467872007-05-06 13:22:01 +00004055 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 'c' Use console dialogs instead of popup dialogs for simple
4057 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004058 *'go-d'*
4059 'd' Use dark theme variant if available. Currently only works for
4060 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004061 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004062 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004063 'guitablabel' can be used to change the text in the labels.
4064 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004065 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004066 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004067 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 'f' Foreground: Don't use fork() to detach the GUI from the shell
4069 where it was started. Use this for programs that wait for the
4070 editor to finish (e.g., an e-mail program). Alternatively you
4071 can use "gvim -f" or ":gui -f" to start the GUI in the
4072 foreground. |gui-fork|
4073 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004074 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004075 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4077 corner of the window. It's black&white on non-GTK, because of
4078 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004079 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004081 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004082 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004084 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004086 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004087 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 'g' Grey menu items: Make menu items that are not active grey. If
4089 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004090 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 't' Include tearoff menu items. Currently only works for Win32,
4092 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004093 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004094 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4095 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004096 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004098 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 'R' Right-hand scrollbar is present when there is a vertically
4100 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004101 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004103 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 'L' Left-hand scrollbar is present when there is a vertically
4105 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004106 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4108 the longest visible line, or on the cursor line if the 'h'
4109 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004110 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 'h' Limit horizontal scrollbar size to the length of the cursor
4112 line. Reduces computations. |gui-horiz-scroll|
4113
4114 And yes, you may even have scrollbars on the left AND the right if
4115 you really want to :-). See |gui-scrollbars| for more information.
4116
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004117 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 'v' Use a vertical button layout for dialogs. When not included,
4119 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004120 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004121 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 'p' Use Pointer callbacks for X11 GUI. This is required for some
4123 window managers. If the cursor is not blinking or hollow at
4124 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004125 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004127 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004128 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004129 *'go-k'*
4130 'k' Keep the GUI window size when adding/removing a scrollbar, or
4131 toolbar, tabline, etc. Instead, the behavior is similar to
4132 when the window is maximized and will adjust 'lines' and
4133 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004134 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004135 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004136
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 *'guipty'* *'noguipty'*
4138'guipty' boolean (default on)
4139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 {only available when compiled with GUI enabled}
4141 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4142 I/O to/from shell commands. See |gui-pty|.
4143
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004144 *'guitablabel'* *'gtl'*
4145'guitablabel' 'gtl' string (default empty)
4146 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004147 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004148 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004149 pages line. When empty and when the result is empty Vim will use a
4150 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004151
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004152 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004153 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004154 The expression will be evaluated in the |sandbox| when set from a
4155 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004156 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004157
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004158 Only used when the GUI tab pages line is displayed. 'e' must be
4159 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4160 used.
4161
Bram Moolenaar57657d82006-04-21 22:12:41 +00004162 *'guitabtooltip'* *'gtt'*
4163'guitabtooltip' 'gtt' string (default empty)
4164 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004165 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004166 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004167 pages line. When empty Vim will use a default tooltip.
4168 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004169 You can include a line break. Simplest method is to use |:let|: >
4170 :let &guitabtooltip = "line one\nline two"
4171<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004172
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004174'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 (others) "$VIMRUNTIME/doc/help.txt")
4176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 Name of the main help file. All distributed help files should be
4178 placed together in one directory. Additionally, all "doc" directories
4179 in 'runtimepath' will be used.
4180 Environment variables are expanded |:set_env|. For example:
4181 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004182 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 spaces and backslashes.
4184 This option cannot be set from a |modeline| or in the |sandbox|, for
4185 security reasons.
4186
4187 *'helpheight'* *'hh'*
4188'helpheight' 'hh' number (default 20)
4189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 Minimal initial height of the help window when it is opened with the
4191 ":help" command. The initial height of the help window is half of the
4192 current window, or (when the 'ea' option is on) the same as other
4193 windows. When the height is less than 'helpheight', the height is
4194 set to 'helpheight'. Set to zero to disable.
4195
4196 *'helplang'* *'hlg'*
4197'helplang' 'hlg' string (default: messages language or empty)
4198 global
4199 {only available when compiled with the |+multi_lang|
4200 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004201 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 for which the desired help can be found. The English help will always
4203 be used as a last resort. You can add "en" to prefer English over
4204 another language, but that will only find tags that exist in that
4205 language and not in the English help.
4206 Example: >
4207 :set helplang=de,it
4208< This will first search German, then Italian and finally English help
4209 files.
4210 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4211 try to find the tag in the current language before using this option.
4212 See |help-translated|.
4213
4214 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4215'hidden' 'hid' boolean (default off)
4216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 When off a buffer is unloaded when it is |abandon|ed. When on a
4218 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4219 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004220
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004222 hidden even if the 'hidden' option is off when these three are true:
4223 - the buffer is modified
4224 - 'autowrite' is off or writing is not possible
4225 - the '!' flag was used
4226 Also see |windows.txt|.
4227
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004228 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 This option is set for one command with ":hide {command}" |:hide|.
4230 WARNING: It's easy to forget that you have changes in hidden buffers.
4231 Think twice when using ":q!" or ":qa!".
4232
4233 *'highlight'* *'hl'*
4234'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004235 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4236 d:Directory,e:ErrorMsg,i:IncSearch,
4237 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004238 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004239 N:CursorLineNr,r:Question,s:StatusLine,
4240 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004241 v:Visual,V:VisualNOS,w:WarningMsg,
4242 W:WildMenu,f:Folded,F:FoldColumn,
4243 A:DiffAdd,C:DiffChange,D:DiffDelete,
4244 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004245 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004246 L:SpellLocal,+:Pmenu,=:PmenuSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004247 [:PmenuKind,]:PmenuKindSel,
4248 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004249 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4250 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004251 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004252 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004255 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004257 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004259 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4260 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 characters from 'showbreak'
4262 |hl-Directory| d directories in CTRL-D listing and other special
4263 things in listings
4264 |hl-ErrorMsg| e error messages
4265 h (obsolete, ignored)
4266 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004267 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4269 |hl-MoreMsg| m |more-prompt|
4270 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004271 |hl-LineNr| n line number for ":number" and ":#" commands, and
4272 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004273 |hl-LineNrAbove| a line number above the cursor for when the
4274 'relativenumber' option is set.
4275 |hl-LineNrBelow| b line number below the cursor for when the
4276 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004277 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4278 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 |hl-Question| r |hit-enter| prompt and yes/no questions
4280 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004281 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4283 |hl-VertSplit| c column used to separate vertically split windows
4284 |hl-Visual| v Visual mode
4285 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4286 Selection" Only X11 Gui's |gui-x11| and
4287 |xterm-clipboard|.
4288 |hl-WarningMsg| w warning messages
4289 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4290 |hl-Folded| f line used for closed folds
4291 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004292 |hl-DiffAdd| A added line in diff mode
4293 |hl-DiffChange| C changed line in diff mode
4294 |hl-DiffDelete| D deleted line in diff mode
4295 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004297 |hl-Conceal| - the placeholders used for concealed characters
4298 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004299 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004300 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004301 |hl-SpellRare| R rare word |spell|
4302 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004303 |hl-Pmenu| + popup menu normal line
4304 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004305 |hl-PmenuKind| [ popup menu "kind" normal line
4306 |hl-PmenuKindSel| ] popup menu "kind" selected line
4307 |hl-PmenuExtra| { popup menu "kind" normal line
4308 |hl-PmenuExtraSel| } popup menu "kind" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004309 |hl-PmenuSbar| x popup menu scrollbar
4310 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311
4312 The display modes are:
4313 r reverse (termcap entry "mr" and "me")
4314 i italic (termcap entry "ZH" and "ZR")
4315 b bold (termcap entry "md" and "me")
4316 s standout (termcap entry "so" and "se")
4317 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004318 c undercurl (termcap entry "Us" and "Ce")
4319 2 double underline (termcap entry "Ds" and "Ce")
4320 d dotted underline (termcap entry "ds" and "Ce")
4321 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004322 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 n no highlighting
4324 - no highlighting
4325 : use a highlight group
4326 The default is used for occasions that are not included.
4327 If you want to change what the display modes do, see |dos-colors|
4328 for an example.
4329 When using the ':' display mode, this must be followed by the name of
4330 a highlight group. A highlight group can be used to define any type
4331 of highlighting, including using color. See |:highlight| on how to
4332 define one. The default uses a different group for each occasion.
4333 See |highlight-default| for the default highlight groups.
4334
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004336'history' 'hi' number (Vim default: 50, Vi default: 0,
4337 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004340 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004342 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 NOTE: This option is set to the Vi default value when 'compatible' is
4344 set and to the Vim default value when 'compatible' is reset.
4345
4346 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4347'hkmap' 'hk' boolean (default off)
4348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 {only available when compiled with the |+rightleft|
4350 feature}
4351 When on, the keyboard is mapped for the Hebrew character set.
4352 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4353 toggle this option. See |rileft.txt|.
4354 NOTE: This option is reset when 'compatible' is set.
4355
4356 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4357'hkmapp' 'hkp' boolean (default off)
4358 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 {only available when compiled with the |+rightleft|
4360 feature}
4361 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4362 This is useful if you have a non-Hebrew keyboard.
4363 See |rileft.txt|.
4364 NOTE: This option is reset when 'compatible' is set.
4365
Bram Moolenaar036986f2017-03-16 17:41:02 +01004366 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4367'hlsearch' 'hls' boolean (default off)
4368 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004369 {not available when compiled without the
4370 |+extra_search| feature}
4371 When there is a previous search pattern, highlight all its matches.
4372 The type of highlighting used can be set with the 'l' occasion in the
4373 'highlight' option. This uses the "Search" highlight group by
4374 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004375 are not applied. If the "CurSearch" highlight group is set then the
4376 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004377 See also: 'incsearch' and |:match|.
4378 When you get bored looking at the highlighted matches, you can turn it
4379 off with |:nohlsearch|. This does not change the option value, as
4380 soon as you use a search command, the highlighting comes back.
4381 'redrawtime' specifies the maximum time spent on finding matches.
4382 When the search pattern can match an end-of-line, Vim will try to
4383 highlight all of the matched text. However, this depends on where the
4384 search starts. This will be the first line in the window or the first
4385 line below a closed fold. A match in a previous line which is not
4386 drawn may not continue in a newly drawn line.
4387 You can specify whether the highlight status is restored on startup
4388 with the 'h' flag in 'viminfo' |viminfo-h|.
4389 NOTE: This option is reset when 'compatible' is set.
4390
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 *'icon'* *'noicon'*
4392'icon' boolean (default off, on when title can be restored)
4393 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 When on, the icon text of the window will be set to the value of
4395 'iconstring' (if it is not empty), or to the name of the file
4396 currently being edited. Only the last part of the name is used.
4397 Overridden by the 'iconstring' option.
4398 Only works if the terminal supports setting window icons (currently
4399 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4400 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4401 builtin termcap).
4402 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004403 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004405 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406
4407 *'iconstring'*
4408'iconstring' string (default "")
4409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 When this option is not empty, it will be used for the icon text of
4411 the window. This happens only when the 'icon' option is on.
4412 Only works if the terminal supports setting window icon text
4413 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004414 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 When Vim was compiled with HAVE_X11 defined, the original icon will be
4416 restored if possible |X11|.
4417 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004418 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004420 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 {not available when compiled without the |+statusline| feature}
4422
4423 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4424'ignorecase' 'ic' boolean (default off)
4425 global
4426 Ignore case in search patterns. Also used when searching in the tags
4427 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004428 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 Can be overruled by using "\c" or "\C" in the pattern, see
4430 |/ignorecase|.
4431
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004432 *'imactivatefunc'* *'imaf'*
4433'imactivatefunc' 'imaf' string (default "")
4434 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004435 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004436 activate or deactivate the Input Method. The value can be the name of
4437 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4438 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004439 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004440 The expression will be evaluated in the |sandbox| when set from a
4441 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004442
4443 Example: >
4444 function ImActivateFunc(active)
4445 if a:active
4446 ... do something
4447 else
4448 ... do something
4449 endif
4450 " return value is not used
4451 endfunction
4452 set imactivatefunc=ImActivateFunc
4453<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 *'imactivatekey'* *'imak'*
4455'imactivatekey' 'imak' string (default "")
4456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004458 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 Specifies the key that your Input Method in X-Windows uses for
4460 activation. When this is specified correctly, vim can fully control
4461 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4462 You can't use this option to change the activation key, the option
4463 tells Vim what the key is.
4464 Format:
4465 [MODIFIER_FLAG-]KEY_STRING
4466
4467 These characters can be used for MODIFIER_FLAG (case is ignored):
4468 S Shift key
4469 L Lock key
4470 C Control key
4471 1 Mod1 key
4472 2 Mod2 key
4473 3 Mod3 key
4474 4 Mod4 key
4475 5 Mod5 key
4476 Combinations are allowed, for example "S-C-space" or "SC-space" are
4477 both shift+ctrl+space.
4478 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4479
4480 Example: >
4481 :set imactivatekey=S-space
4482< "S-space" means shift+space. This is the activation key for kinput2 +
4483 canna (Japanese), and ami (Korean).
4484
4485 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4486'imcmdline' 'imc' boolean (default off)
4487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 When set the Input Method is always on when starting to edit a command
4489 line, unless entering a search pattern (see 'imsearch' for that).
4490 Setting this option is useful when your input method allows entering
4491 English characters directly, e.g., when it's used to type accented
4492 characters with dead keys.
4493
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004494 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 When set the Input Method is never used. This is useful to disable
4498 the IM when it doesn't work properly.
4499 Currently this option is on by default for SGI/IRIX machines. This
4500 may change in later releases.
4501
4502 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004503'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 Specifies whether :lmap or an Input Method (IM) is to be used in
4506 Insert mode. Valid values:
4507 0 :lmap is off and IM is off
4508 1 :lmap is ON and IM is off
4509 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 To always reset the option to zero when leaving Insert mode with <Esc>
4511 this can be used: >
4512 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4513< This makes :lmap and IM turn off automatically when leaving Insert
4514 mode.
4515 Note that this option changes when using CTRL-^ in Insert mode
4516 |i_CTRL-^|.
4517 The value is set to 1 when setting 'keymap' to a valid keymap name.
4518 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004519 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 methods. Use 'imdisable' to disable XIM then.
4521
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004522 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004523 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004524 |+multi_byte_ime| or |global-ime|.
4525
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004527'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 Specifies whether :lmap or an Input Method (IM) is to be used when
4530 entering a search pattern. Valid values:
4531 -1 the value of 'iminsert' is used, makes it look like
4532 'iminsert' is also used when typing a search pattern
4533 0 :lmap is off and IM is off
4534 1 :lmap is ON and IM is off
4535 2 :lmap is off and IM is ON
4536 Note that this option changes when using CTRL-^ in Command-line mode
4537 |c_CTRL-^|.
4538 The value is set to 1 when it is not -1 and setting the 'keymap'
4539 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004540 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 methods. Use 'imdisable' to disable XIM then.
4542
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004543 *'imstatusfunc'* *'imsf'*
4544'imstatusfunc' 'imsf' string (default "")
4545 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004546 This option specifies a function that is called to obtain the status
4547 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004548 The value can be the name of a function, a |lambda| or a |Funcref|.
4549 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004550 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004551
4552 Example: >
4553 function ImStatusFunc()
4554 let is_active = ...do something
4555 return is_active ? 1 : 0
4556 endfunction
4557 set imstatusfunc=ImStatusFunc
4558<
4559 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004560 The expression will be evaluated in the |sandbox| when set from a
4561 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004562
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004563 *'imstyle'* *'imst'*
4564'imstyle' 'imst' number (default 1)
4565 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004566 {only available when compiled with |+xim| and
4567 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004568 This option specifies the input style of Input Method:
4569 0 use on-the-spot style
4570 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004571 See: |xim-input-style|
4572
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004573 For a long time on-the-spot style had been used in the GTK version of
4574 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004575 |single-repeat|, etc. Therefore over-the-spot style becomes the
4576 default now. This should work fine for most people, however if you
4577 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004578 The expression will be evaluated in the |sandbox| when set from a
4579 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004580
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 *'include'* *'inc'*
4582'include' 'inc' string (default "^\s*#\s*include")
4583 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 {not available when compiled without the
4585 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004586 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 pattern, just like for the "/" command (See |pattern|). The default
4588 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004589 "]I", "[d", etc.
4590 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004591 comes after the matched pattern. But if "\zs" appears in the pattern
4592 then the text matched from "\zs" to the end, or until "\ze" if it
4593 appears, is used as the file name. Use this to include characters
4594 that are not in 'isfname', such as a space. You can then use
4595 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004596 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597
4598 *'includeexpr'* *'inex'*
4599'includeexpr' 'inex' string (default "")
4600 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004602 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004604 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004605 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004607 Note the double backslash: the `:set` command first halves them, then
4608 one remains it the value, where "\." matches a dot literally. For
4609 simple character replacements `tr()` avoids the need for escaping: >
4610 :setlocal includeexpr=tr(v:fname,'.','/')
4611<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004613 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 Also used for |<cfile>|.
4615
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004616 If the expression starts with s: or |<SID>|, then it is replaced with
4617 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004618 setlocal includeexpr=s:MyIncludeExpr()
4619 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004620< Otherwise, the expression is evaluated in the context of the script
4621 where the option was set, thus script-local items are available.
4622
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004623 It is more efficient if the value is just a function call without
4624 arguments, see |expr-option-function|.
4625
Bram Moolenaar30b65812012-07-12 22:01:11 +02004626 The expression will be evaluated in the |sandbox| when set from a
4627 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004628 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004629
4630 It is not allowed to change text or jump to another window while
4631 evaluating 'includeexpr' |textlock|.
4632
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004634'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004635 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004638 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004639 While typing a search command, show where the pattern, as it was typed
4640 so far, matches. The matched string is highlighted. If the pattern
4641 is invalid or not found, nothing is shown. The screen will be updated
4642 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004643 Also applies to the pattern in commands: >
4644 :global
4645 :lvimgrep
4646 :lvimgrepadd
4647 :smagic
4648 :snomagic
4649 :sort
4650 :substitute
4651 :vglobal
4652 :vimgrep
4653 :vimgrepadd
4654< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004655 original position when no match is found and when pressing <Esc>. You
4656 still need to finish the search command with <Enter> to move the
4657 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004658 You can use the CTRL-G and CTRL-T keys to move to the next and
4659 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004660 When compiled with the |+reltime| feature Vim only searches for about
4661 half a second. With a complicated pattern and/or a lot of text the
4662 match may not be found. This is to avoid that Vim hangs while you
4663 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004664 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004665 When 'hlsearch' is on, all matched strings are highlighted too while
4666 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004667 If you don't want to turn 'hlsearch' on, but want to highlight all
4668 matches while searching, you can turn on and off 'hlsearch' with
4669 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004670 augroup vimrc-incsearch-highlight
4671 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004672 autocmd CmdlineEnter /,\? :set hlsearch
4673 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004674 augroup END
4675<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004676 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004677 to the command line. If 'ignorecase' and 'smartcase' are set and the
4678 command line has no uppercase characters, the added character is
4679 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004680 CTRL-R CTRL-W can be used to add the word at the end of the current
4681 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 NOTE: This option is reset when 'compatible' is set.
4683
4684 *'indentexpr'* *'inde'*
4685'indentexpr' 'inde' string (default "")
4686 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004687 {not available when compiled without the |+eval|
4688 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 Expression which is evaluated to obtain the proper indent for a line.
4690 It is used when a new line is created, for the |=| operator and
4691 in Insert mode as specified with the 'indentkeys' option.
4692 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004693 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004694 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 When 'paste' is set this option is not used for indenting.
4696 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004697 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004699
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004700 If the expression starts with s: or |<SID>|, then it is replaced with
4701 the script ID (|local-function|). Example: >
4702 set indentexpr=s:MyIndentExpr()
4703 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004704< Otherwise, the expression is evaluated in the context of the script
4705 where the option was set, thus script-local items are available.
4706
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004707 The advantage of using a function call without arguments is that it is
4708 faster, see |expr-option-function|.
4709
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 The expression must return the number of spaces worth of indent. It
4711 can return "-1" to keep the current indent (this means 'autoindent' is
4712 used for the indent).
4713 Functions useful for computing the indent are |indent()|, |cindent()|
4714 and |lispindent()|.
4715 The evaluation of the expression must not have side effects! It must
4716 not change the text, jump to another window, etc. Afterwards the
4717 cursor position is always restored, thus the cursor may be moved.
4718 Normally this option would be set to call a function: >
4719 :set indentexpr=GetMyIndent()
4720< Error messages will be suppressed, unless the 'debug' option contains
4721 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004722 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004723 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724
Bram Moolenaar30b65812012-07-12 22:01:11 +02004725 The expression will be evaluated in the |sandbox| when set from a
4726 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004727 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004728
4729 It is not allowed to change text or jump to another window while
4730 evaluating 'indentexpr' |textlock|.
4731
4732
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004734'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 A list of keys that, when typed in Insert mode, cause reindenting of
4737 the current line. Only happens if 'indentexpr' isn't empty.
4738 The format is identical to 'cinkeys', see |indentkeys-format|.
4739 See |C-indenting| and |indent-expression|.
4740
4741 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4742'infercase' 'inf' boolean (default off)
4743 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004745 'ignorecase' is also on, the case of the match is adjusted depending
4746 on the typed text. If the typed text contains a lowercase letter
4747 where the match has an upper case letter, the completed part is made
4748 lowercase. If the typed text has no lowercase letters and the match
4749 has a lowercase letter where the typed text has an uppercase letter,
4750 and there is a letter before it, the completed part is made uppercase.
4751 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752
4753 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4754'insertmode' 'im' boolean (default off)
4755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 Makes Vim work in a way that Insert mode is the default mode. Useful
4757 if you want to use Vim as a modeless editor. Used for |evim|.
4758 These Insert mode commands will be useful:
4759 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004760 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 this is a mapping, it is executed as if 'insertmode' was off.
4762 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004764 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4765 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766
4767 These items change when 'insertmode' is set:
4768 - when starting to edit of a file, Vim goes to Insert mode.
4769 - <Esc> in Insert mode is a no-op and beeps.
4770 - <Esc> in Normal mode makes Vim go to Insert mode.
4771 - CTRL-L in Insert mode is a command, it is not inserted.
4772 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4773 However, when <Esc> is used inside a mapping, it behaves like
4774 'insertmode' was not set. This was done to be able to use the same
4775 mappings with 'insertmode' set or not set.
4776 When executing commands with |:normal| 'insertmode' is not used.
4777
4778 NOTE: This option is reset when 'compatible' is set.
4779
4780 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004781'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4783 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4784 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4785 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4786 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 The characters specified by this option are included in file names and
4789 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004790 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 Multi-byte characters 256 and above are always included, only the
4792 characters up to 255 are specified with this option.
4793 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004794 Think twice before adding white space to this option. Although a
4795 space may appear inside a file name, the effect will be that Vim
4796 doesn't know where a file name starts or ends when doing completion.
4797 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798
4799 Note that on systems using a backslash as path separator, Vim tries to
4800 do its best to make it work as you would expect. That is a bit
4801 tricky, since Vi originally used the backslash to escape special
4802 characters. Vim will not remove a backslash in front of a normal file
4803 name character on these systems, but it will on Unix and alikes. The
4804 '&' and '^' are not included by default, because these are special for
4805 cmd.exe.
4806
4807 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004808 Each part can be a single character number or a range. A range is two
4809 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 decimal number between 0 and 255 or the ASCII character itself (does
4811 not work for digits). Example:
4812 "_,-,128-140,#-43" (include '_' and '-' and the range
4813 128 to 140 and '#' to 43)
4814 If a part starts with '^', the following character number or range
4815 will be excluded from the option. The option is interpreted from left
4816 to right. Put the excluded character after the range where it is
4817 included. To include '^' itself use it as the last character of the
4818 option or the end of a range. Example:
4819 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4820 If the character is '@', all characters where isalpha() returns TRUE
4821 are included. Normally these are the characters a to z and A to Z,
4822 plus accented characters. To include '@' itself use "@-@". Examples:
4823 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004824 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 "a-z,A-Z,@-@" All letters plus the '@' character.
4826 A comma can be included by using it where a character number is
4827 expected. Example:
4828 "48-57,,,_" Digits, comma and underscore.
4829 A comma can be excluded by prepending a '^'. Example:
4830 " -~,^,,9" All characters from space to '~', excluding
4831 comma, plus <Tab>.
4832 See |option-backslash| about including spaces and backslashes.
4833
4834 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004835'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 "@,48-57,_,128-167,224-235"
4837 otherwise: "@,48-57,_,192-255")
4838 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 The characters given by this option are included in identifiers.
4840 Identifiers are used in recognizing environment variables and after a
4841 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004842 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004843 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004845 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4847
4848 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004849'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 "@,48-57,_,128-167,224-235"
4851 otherwise: "@,48-57,_,192-255"
4852 Vi default: "@,48-57,_")
4853 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004855 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004856 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004857 characters above 255 check the "word" character class (any character
4858 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004859 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 For a help file it is set to all non-blank printable characters except
4861 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4862 command).
4863 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004864 This option also influences syntax highlighting, unless the syntax
4865 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 NOTE: This option is set to the Vi default value when 'compatible' is
4867 set and to the Vim default value when 'compatible' is reset.
4868
4869 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004870'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 "@,~-255"; otherwise: "@,161-255")
4872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 The characters given by this option are displayed directly on the
4874 screen. It is also used for "\p" in a |pattern|. The characters from
4875 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4876 even when they are not included in 'isprint' or excluded. See
4877 'isfname' for a description of the format of this option.
4878
4879 Non-printable characters are displayed with two characters:
4880 0 - 31 "^@" - "^_"
4881 32 - 126 always single characters
4882 127 "^?"
4883 128 - 159 "~@" - "~_"
4884 160 - 254 "| " - "|~"
4885 255 "~?"
4886 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4887 displayed as <xx>, with the hexadecimal value of the byte.
4888 When 'display' contains "uhex" all unprintable characters are
4889 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004890 The SpecialKey highlighting will be used for unprintable characters.
4891 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892
4893 Multi-byte characters 256 and above are always included, only the
4894 characters up to 255 are specified with this option. When a character
4895 is printable but it is not available in the current font, a
4896 replacement character will be shown.
4897 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4898 There is no option to specify these characters.
4899
4900 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4901'joinspaces' 'js' boolean (default on)
4902 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 Insert two spaces after a '.', '?' and '!' with a join command.
4904 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4905 Otherwise only one space is inserted.
4906 NOTE: This option is set when 'compatible' is set.
4907
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02004908 *'jumpoptions'* *'jop'*
4909'jumpoptions' 'jop' string (default "")
4910 global
4911 List of words that change the behavior of the |jumplist|.
4912 stack Make the jumplist behave like the tagstack.
4913 Relative location of entries in the jumplist is
4914 preserved at the cost of discarding subsequent entries
4915 when navigating backwards in the jumplist and then
4916 jumping to a location. |jumplist-stack|
4917
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 *'key'*
4919'key' string (default "")
4920 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004921 {only available when compiled with the |+cryptv|
4922 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004924 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 Careful: Do not set the key value by hand, someone might see the typed
4926 key. Use the |:X| command. But you can make 'key' empty: >
4927 :set key=
4928< It is not possible to get the value of this option with ":set key" or
4929 "echo &key". This is to avoid showing it to someone who shouldn't
4930 know. It also means you cannot see it yourself once you have set it,
4931 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02004932 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
4933 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01004934 You can use "&key" in an expression to detect whether encryption is
4935 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936
4937 *'keymap'* *'kmp'* *E544*
4938'keymap' 'kmp' string (default "")
4939 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 {only available when compiled with the |+keymap|
4941 feature}
4942 Name of a keyboard mapping. See |mbyte-keymap|.
4943 Setting this option to a valid keymap name has the side effect of
4944 setting 'iminsert' to one, so that the keymap becomes effective.
4945 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004946 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947
4948 *'keymodel'* *'km'*
4949'keymodel' 'km' string (default "")
4950 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004951 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 can do. These values can be used:
4953 startsel Using a shifted special key starts selection (either
4954 Select mode or Visual mode, depending on "key" being
4955 present in 'selectmode').
4956 stopsel Using a not-shifted special key stops selection.
4957 Special keys in this context are the cursor keys, <End>, <Home>,
4958 <PageUp> and <PageDown>.
4959 The 'keymodel' option is set by the |:behave| command.
4960
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004961 *'keyprotocol'* *'kpc'*
4962'keyprotocol' 'kpc' string (default: see below)
4963 global
4964 Specifies what keyboard protocol to use depending on the value of
4965 'term'. The supported keyboard protocols names are:
4966 none whatever the terminal uses
4967 mok2 modifyOtherKeys level 2, as supported by xterm
4968 kitty Kitty keyboard protocol, as supported by Kitty
4969
Bram Moolenaara87749e2022-11-30 10:23:17 +00004970 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004971 a pattern that is matched against the 'term' option, a colon and the
4972 protocol name to be used. To illustrate this, the default value would
4973 be set with: >
4974 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
4975
4976< This means that when 'term' contains "kitty, "foot" or "wezterm"
4977 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00004978 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004979
4980 The first match is used, thus if you want to have "kitty" use the
4981 kitty protocol, but "badkitty" not, then you should match "badkitty"
4982 first and use the "none" value: >
4983 set keyprotocol=badkitty:none,kitty:kitty
4984<
4985 The option is used after 'term' has been changed. First the termcap
4986 entries are set, possibly using the builtin list, see |builtin-terms|.
4987 Then this option is inspected and if there is a match and a protocol
4988 is specified the following happens:
4989 none Nothing, the regular t_TE and t_TI values remain
4990
4991 mok2 The t_TE value is changed to:
4992 CSI >4;m disables modifyOtherKeys
4993 The t_TI value is changed to:
4994 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00004995 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004996
4997 kitty The t_TE value is changed to:
4998 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00004999 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005000 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005001 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005002 CSI ?u request kitty keyboard protocol state
5003 CSI >c request the termresponse
5004
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005005 If you notice problems, such as characters being displayed that
5006 disappear after `CTRL-L`, you might want to try making this option
5007 empty. Then set the 'term' option to have it take effect: >
5008 set keyprotocol=
5009 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005010<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005011
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 *'keywordprg'* *'kp'*
5013'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005014 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 Program to use for the |K| command. Environment variables are
5017 expanded |:set_env|. ":help" may be used to access the Vim internal
5018 help. (Note that previously setting the global option to the empty
5019 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005020 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005021 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005022 When "man", "man -s" or an Ex command is used, Vim will automatically
5023 translate a count for the "K" command and pass it as the first
5024 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 See |option-backslash| about including spaces and backslashes.
5026 Example: >
5027 :set keywordprg=man\ -s
5028< This option cannot be set from a |modeline| or in the |sandbox|, for
5029 security reasons.
5030
5031 *'langmap'* *'lmap'* *E357* *E358*
5032'langmap' 'lmap' string (default "")
5033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034 {only available when compiled with the |+langmap|
5035 feature}
5036 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005037 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005038 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 care of translating these special characters to the original meaning
5040 of the key. This means you don't have to change the keyboard mode to
5041 be able to execute Normal mode commands.
5042 This is the opposite of the 'keymap' option, where characters are
5043 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005044 Also consider setting 'langremap' to off, to prevent 'langmap' from
5045 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005046 This option cannot be set from a |modeline| or in the |sandbox|, for
5047 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005049 Example (for Greek, in UTF-8): *greek* >
5050 :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 +00005051< Example (exchanges meaning of z and y for commands): >
5052 :set langmap=zy,yz,ZY,YZ
5053<
5054 The 'langmap' option is a list of parts, separated with commas. Each
5055 part can be in one of two forms:
5056 1. A list of pairs. Each pair is a "from" character immediately
5057 followed by the "to" character. Examples: "aA", "aAbBcC".
5058 2. A list of "from" characters, a semi-colon and a list of "to"
5059 characters. Example: "abc;ABC"
5060 Example: "aA,fgh;FGH,cCdDeE"
5061 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005062 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063
5064 This will allow you to activate vim actions without having to switch
5065 back and forth between the languages. Your language characters will
5066 be understood as normal vim English characters (according to the
5067 langmap mappings) in the following cases:
5068 o Normal/Visual mode (commands, buffer/register names, user mappings)
5069 o Insert/Replace Mode: Register names after CTRL-R
5070 o Insert/Replace Mode: Mappings
5071 Characters entered in Command-line mode will NOT be affected by
5072 this option. Note that this option can be changed at any time
5073 allowing to switch between mappings for different languages/encodings.
5074 Use a mapping to avoid having to type it each time!
5075
5076 *'langmenu'* *'lm'*
5077'langmenu' 'lm' string (default "")
5078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 {only available when compiled with the |+menu| and
5080 |+multi_lang| features}
5081 Language to use for menu translation. Tells which file is loaded
5082 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005083 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084< (without the spaces). For example, to always use the Dutch menus, no
5085 matter what $LANG is set to: >
5086 :set langmenu=nl_NL.ISO_8859-1
5087< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005088 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 If your $LANG is set to a non-English language but you do want to use
5090 the English menus: >
5091 :set langmenu=none
5092< This option must be set before loading menus, switching on filetype
5093 detection or syntax highlighting. Once the menus are defined setting
5094 this option has no effect. But you could do this: >
5095 :source $VIMRUNTIME/delmenu.vim
5096 :set langmenu=de_DE.ISO_8859-1
5097 :source $VIMRUNTIME/menu.vim
5098< Warning: This deletes all menus that you defined yourself!
5099
Bram Moolenaard94464e2015-11-02 15:28:18 +01005100 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005101'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005102 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005103 {only available when compiled with the |+langmap|
5104 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005105 This is just like 'langremap' but with the value inverted. It only
5106 exists for backwards compatibility. When setting 'langremap' then
5107 'langnoremap' is set to the inverted value, and the other way around.
5108
5109 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005110'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005111 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005112 {only available when compiled with the |+langmap|
5113 feature}
5114 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005115 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005116 'langmap' disables some of your mappings, try resetting this option.
5117 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005118 that works for you to avoid mappings to break.
5119
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 *'laststatus'* *'ls'*
5121'laststatus' 'ls' number (default 1)
5122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 The value of this option influences when the last window will have a
5124 status line:
5125 0: never
5126 1: only if there are at least two windows
5127 2: always
5128 The screen looks nicer with a status line if you have several
5129 windows, but it takes another screen line. |status-line|
5130
5131 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5132'lazyredraw' 'lz' boolean (default off)
5133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 When this option is set, the screen will not be redrawn while
5135 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005136 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005138 This may occasionally cause display errors. It is only meant to be set
5139 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005140 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141
5142 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5143'linebreak' 'lbr' boolean (default off)
5144 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005145 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005147 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 than at the last character that fits on the screen. Unlike
5149 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005150 it only affects the way the file is displayed, not its contents.
5151 If 'breakindent' is set, line is visually indented. Then, the value
5152 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005153 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 Note that <Tab> characters after an <EOL> are mostly not displayed
5155 with the right amount of white space.
5156
5157 *'lines'* *E593*
5158'lines' number (default 24 or terminal height)
5159 global
5160 Number of lines of the Vim window.
5161 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005162 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 When Vim is running in the GUI or in a resizable window, setting this
5164 option will cause the window size to be changed. When you only want
5165 to use the size for the GUI, put the command in your |gvimrc| file.
5166 Vim limits the number of lines to what fits on the screen. You can
5167 use this command to get the tallest window possible: >
5168 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005169< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005170 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 When you set this option and Vim is unable to change the physical
5172 number of lines of the display, the display may be messed up.
5173
5174 *'linespace'* *'lsp'*
5175'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 {only in the GUI}
5178 Number of pixel lines inserted between characters. Useful if the font
5179 uses the full character cell height, making lines touch each other.
5180 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005181 With some fonts there can be too much room between lines (to have
5182 space for ascents and descents). Then it makes sense to set
5183 'linespace' to a negative value. This may cause display problems
5184 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185
5186 *'lisp'* *'nolisp'*
5187'lisp' boolean (default off)
5188 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 Lisp mode: When <Enter> is typed in insert mode set the indent for
5190 the next line to Lisp standards (well, sort of). Also happens with
5191 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5192 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5193 better. Also see 'lispwords'.
5194 The '-' character is included in keyword characters. Redefines the
5195 "=" operator to use this same indentation algorithm rather than
5196 calling an external program if 'equalprg' is empty.
5197 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005199 *'lispoptions'* *'lop'*
5200'lispoptions' 'lop' string (default "")
5201 local to buffer
5202 Comma-separated list of items that influence the Lisp indenting when
5203 enabled with the |'lisp'| option. Currently only one item is
5204 supported:
5205 expr:1 use 'indentexpr' for Lisp indenting when it is set
5206 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5207 Note that when using 'indentexpr' the `=` operator indents all the
5208 lines, otherwise the first line is not indented (Vi-compatible).
5209
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 *'lispwords'* *'lw'*
5211'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005212 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005213 Comma-separated list of words that influence the Lisp indenting when
5214 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215
5216 *'list'* *'nolist'*
5217'list' boolean (default off)
5218 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005219 List mode: By default show tabs as CTRL-I is displayed, display $
5220 after end of line. Useful to see the difference between tabs and
5221 spaces and for trailing blanks. Further changed by the 'listchars'
5222 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005223
5224 The cursor is displayed at the start of the space a Tab character
5225 occupies, not at the end as usual in Normal mode. To get this cursor
5226 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005227 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005228<
5229 Note that list mode will also affect formatting (set with 'textwidth'
5230 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 changing the way tabs are displayed.
5232
5233 *'listchars'* *'lcs'*
5234'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005235 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005236 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005237 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005238 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 eol:c Character to show at the end of each line. When
5240 omitted, there is no extra character at the end of the
5241 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005242 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005243 tab:xy[z] Two or three characters to be used to show a tab.
5244 The third character is optional.
5245
5246 tab:xy The 'x' is always used, then 'y' as many times as will
5247 fit. Thus "tab:>-" displays:
5248 >
5249 >-
5250 >--
5251 etc.
5252
5253 tab:xyz The 'z' is always used, then 'x' is prepended, and
5254 then 'y' is used as many times as will fit. Thus
5255 "tab:<->" displays:
5256 >
5257 <>
5258 <->
5259 <-->
5260 etc.
5261
5262 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005263 *lcs-space*
5264 space:c Character to show for a space. When omitted, spaces
5265 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005266 *lcs-multispace*
5267 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005268 One or more characters to use cyclically to show for
5269 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005270 setting, except for single spaces. When omitted, the
5271 "space" setting is used. For example,
5272 `:set listchars=multispace:---+` shows ten consecutive
5273 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005274 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005275 *lcs-lead*
5276 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005277 leading spaces are blank. Overrides the "space" and
5278 "multispace" settings for leading spaces. You can
5279 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005280 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005281< *lcs-leadmultispace*
5282 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005283 Like the |lcs-multispace| value, but for leading
5284 spaces only. Also overrides |lcs-lead| for leading
5285 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005286 `:set listchars=leadmultispace:---+` shows ten
5287 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005288 ---+---+--XXX ~
5289 Where "XXX" denotes the first non-blank characters in
5290 the line.
5291 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005292 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005293 trailing spaces are blank. Overrides the "space" and
5294 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005295 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 extends:c Character to show in the last column, when 'wrap' is
5297 off and the line continues beyond the right of the
5298 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005299 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005300 precedes:c Character to show in the first visible column of the
5301 physical line, when there is text preceding the
5302 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005303 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005304 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005305 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005306 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005307 nbsp:c Character to show for a non-breakable space character
5308 (0xA0 (160 decimal) and U+202F). Left blank when
5309 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005311 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005313 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005315 Each character can be specified as hex: >
5316 set listchars=eol:\\x24
5317 set listchars=eol:\\u21b5
5318 set listchars=eol:\\U000021b5
5319< Note that a double backslash is used. The number of hex characters
5320 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5321
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322 Examples: >
5323 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005324 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 :set lcs=extends:>,precedes:<
5326< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005327 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5328 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005329 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330
5331 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5332'loadplugins' 'lpl' boolean (default on)
5333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 When on the plugin scripts are loaded when starting up |load-plugins|.
5335 This option can be reset in your |vimrc| file to disable the loading
5336 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005337 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5338 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339
Bram Moolenaard94464e2015-11-02 15:28:18 +01005340 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005341'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005342 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005343 {only available when compiled with the |+lua/dyn|
5344 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005345 Specifies the name of the Lua shared library. The default is
5346 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005347 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005348 This option cannot be set from a |modeline| or in the |sandbox|, for
5349 security reasons.
5350
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005351 *'macatsui'* *'nomacatsui'*
5352'macatsui' boolean (default on)
5353 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005354 {not supported}
5355 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005356
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 *'magic'* *'nomagic'*
5358'magic' boolean (default on)
5359 global
5360 Changes the special characters that can be used in search patterns.
5361 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005362 WARNING: Switching this option off most likely breaks plugins! That
5363 is because many patterns assume it's on and will fail when it's off.
5364 Only switch it off when working with old Vi scripts. In any other
5365 situation write patterns that work when 'magic' is on. Include "\M"
5366 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005367 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5368 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369
5370 *'makeef'* *'mef'*
5371'makeef' 'mef' string (default: "")
5372 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 {not available when compiled without the |+quickfix|
5374 feature}
5375 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5376 and the |:grep| command.
5377 When it is empty, an internally generated temp file will be used.
5378 When "##" is included, it is replaced by a number to make the name
5379 unique. This makes sure that the ":make" command doesn't overwrite an
5380 existing file.
5381 NOT used for the ":cf" command. See 'errorfile' for that.
5382 Environment variables are expanded |:set_env|.
5383 See |option-backslash| about including spaces and backslashes.
5384 This option cannot be set from a |modeline| or in the |sandbox|, for
5385 security reasons.
5386
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005387 *'makeencoding'* *'menc'*
5388'makeencoding' 'menc' string (default "")
5389 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005390 Encoding used for reading the output of external commands. When empty,
5391 encoding is not converted.
5392 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5393 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5394 and `:laddfile`.
5395
5396 This would be mostly useful when you use MS-Windows and set 'encoding'
5397 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5398 'makeencoding' to "char" has the same effect as setting to the system
5399 locale encoding. Example: >
5400 :set encoding=utf-8
5401 :set makeencoding=char " system locale is used
5402<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403 *'makeprg'* *'mp'*
5404'makeprg' 'mp' string (default "make", VMS: "MMS")
5405 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005406 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005407 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5408 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005409 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005410 Environment variables are expanded |:set_env|. See |option-backslash|
5411 about including spaces and backslashes.
5412 Note that a '|' must be escaped twice: once for ":set" and once for
5413 the interpretation of a command. When you use a filter called
5414 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 :set makeprg=gmake\ \\\|\ myfilter
5416< The placeholder "$*" can be given (even multiple times) to specify
5417 where the arguments will be included, for example: >
5418 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5419< This option cannot be set from a |modeline| or in the |sandbox|, for
5420 security reasons.
5421
5422 *'matchpairs'* *'mps'*
5423'matchpairs' 'mps' string (default "(:),{:},[:]")
5424 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005426 other.
5427 Only character pairs are allowed that are different, thus you cannot
5428 jump between two double quotes.
5429 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005430 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005431 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 :set mps+=<:>
5433
5434< A more exotic example, to jump between the '=' and ';' in an
5435 assignment, useful for languages like C and Java: >
5436 :au FileType c,cpp,java set mps+==:;
5437
5438< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005439 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440
5441 *'matchtime'* *'mat'*
5442'matchtime' 'mat' number (default 5)
5443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 Tenths of a second to show the matching paren, when 'showmatch' is
5445 set. Note that this is not in milliseconds, like other options that
5446 set a time. This is to be compatible with Nvi.
5447
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005448 *'maxcombine'* *'mco'*
5449'maxcombine' 'mco' number (default 2)
5450 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005451 The maximum number of combining characters supported for displaying.
5452 Only used when 'encoding' is "utf-8".
5453 The default is OK for most languages. Hebrew may require 4.
5454 Maximum value is 6.
5455 Even when this option is set to 2 you can still edit text with more
5456 combining characters, you just can't see them. Use |g8| or |ga|.
5457 See |mbyte-combining|.
5458
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 *'maxfuncdepth'* *'mfd'*
5460'maxfuncdepth' 'mfd' number (default 100)
5461 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005462 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005463 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 Maximum depth of function calls for user functions. This normally
5465 catches endless recursion. When using a recursive function with
5466 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5467 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005468 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005469 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 See also |:function|.
5471
5472 *'maxmapdepth'* *'mmd'* *E223*
5473'maxmapdepth' 'mmd' number (default 1000)
5474 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 Maximum number of times a mapping is done without resulting in a
5476 character to be used. This normally catches endless mappings, like
5477 ":map x y" with ":map y x". It still does not catch ":map g wg",
5478 because the 'w' is used before the next mapping is done. See also
5479 |key-mapping|.
5480
5481 *'maxmem'* *'mm'*
5482'maxmem' 'mm' number (default between 256 to 5120 (system
5483 dependent) or half the amount of memory
5484 available)
5485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5487 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005488 other memory to be freed.
5489 The maximum usable value is about 2000000. Use this to work without a
5490 limit.
5491 The value is ignored when 'swapfile' is off.
5492 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005494 *'maxmempattern'* *'mmp'*
5495'maxmempattern' 'mmp' number (default 1000)
5496 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005497 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005498 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005499 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005500 When Vim runs into the limit it gives an error message and mostly
5501 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005502 Running into the limit often means that the pattern is very
5503 inefficient or too complex. This may already happen with the pattern
5504 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005505 Might also happen on redraw, when syntax rules try to match a complex
5506 text structure.
5507 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5508 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005509
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 *'maxmemtot'* *'mmt'*
5511'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5512 dependent) or half the amount of memory
5513 available)
5514 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005515 Maximum amount of memory in Kbyte to use for all buffers together.
5516 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005517 without a limit.
5518 On 64 bit machines higher values might work. But hey, do you really
5519 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005520 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005521 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005522 Buffers with 'swapfile' off still count to the total amount of memory
5523 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005524 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525
5526 *'menuitems'* *'mis'*
5527'menuitems' 'mis' number (default 25)
5528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 {not available when compiled without the |+menu|
5530 feature}
5531 Maximum number of items to use in a menu. Used for menus that are
5532 generated from a list of items, e.g., the Buffers menu. Changing this
5533 option has no direct effect, the menu must be refreshed first.
5534
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005535 *'mkspellmem'* *'msm'*
5536'mkspellmem' 'msm' string (default "460000,2000,500")
5537 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005538 {not available when compiled without the |+syntax|
5539 feature}
5540 Parameters for |:mkspell|. This tunes when to start compressing the
5541 word tree. Compression can be slow when there are many words, but
5542 it's needed to avoid running out of memory. The amount of memory used
5543 per word depends very much on how similar the words are, that's why
5544 this tuning is complicated.
5545
5546 There are three numbers, separated by commas:
5547 {start},{inc},{added}
5548
5549 For most languages the uncompressed word tree fits in memory. {start}
5550 gives the amount of memory in Kbyte that can be used before any
5551 compression is done. It should be a bit smaller than the amount of
5552 memory that is available to Vim.
5553
5554 When going over the {start} limit the {inc} number specifies the
5555 amount of memory in Kbyte that can be allocated before another
5556 compression is done. A low number means compression is done after
5557 less words are added, which is slow. A high number means more memory
5558 will be allocated.
5559
5560 After doing compression, {added} times 1024 words can be added before
5561 the {inc} limit is ignored and compression is done when any extra
5562 amount of memory is needed. A low number means there is a smaller
5563 chance of hitting the {inc} limit, less memory is used but it's
5564 slower.
5565
5566 The languages for which these numbers are important are Italian and
5567 Hungarian. The default works for when you have about 512 Mbyte. If
5568 you have 1 Gbyte you could use: >
5569 :set mkspellmem=900000,3000,800
5570< If you have less than 512 Mbyte |:mkspell| may fail for some
5571 languages, no matter what you set 'mkspellmem' to.
5572
Bram Moolenaar07607392019-05-26 19:20:43 +02005573 This option cannot be set from a |modeline| or in the |sandbox|.
5574
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005576'modeline' 'ml' boolean (Vim default: on (off for root),
5577 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005579 If 'modeline' is on 'modelines' gives the number of lines that is
5580 checked for set commands. If 'modeline' is off or 'modelines' is zero
5581 no lines are checked. See |modeline|.
5582
5583 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5584'modelineexpr' 'mle' boolean (default: off)
5585 global
5586 When on allow some options that are an expression to be set in the
5587 modeline. Check the option for whether it is affected by
5588 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005589 This option cannot be set from a |modeline| or in the |sandbox|, for
5590 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005591
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 *'modelines'* *'mls'*
5593'modelines' 'mls' number (default 5)
5594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 If 'modeline' is on 'modelines' gives the number of lines that is
5596 checked for set commands. If 'modeline' is off or 'modelines' is zero
5597 no lines are checked. See |modeline|.
5598 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5599 set and to the Vim default value when 'compatible' is reset.
5600
5601 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005602 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603'modifiable' 'ma' boolean (default on)
5604 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 When off the buffer contents cannot be changed. The 'fileformat' and
5606 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005607 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005608
5609 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5610'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005611 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 When on, the buffer is considered to be modified. This option is set
5613 when:
5614 1. A change was made to the text since it was last written. Using the
5615 |undo| command to go back to the original text will reset the
5616 option. But undoing changes that were made before writing the
5617 buffer will set the option again, since the text is different from
5618 when it was written.
5619 2. 'fileformat' or 'fileencoding' is different from its original
5620 value. The original value is set when the buffer is read or
5621 written. A ":set nomodified" command also resets the original
5622 values to the current values and the 'modified' option will be
5623 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005624 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005625 This option is not set when a change is made to the buffer as the
5626 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5627 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5628 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5630 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005631 Note that the text may actually be the same, e.g. 'modified' is set
5632 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633
5634 *'more'* *'nomore'*
5635'more' boolean (Vim default: on, Vi default: off)
5636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637 When on, listings pause when the whole screen is filled. You will get
5638 the |more-prompt|. When this option is off there are no pauses, the
5639 listing continues until finished.
5640 NOTE: This option is set to the Vi default value when 'compatible' is
5641 set and to the Vim default value when 'compatible' is reset.
5642
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005643 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005644'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005645 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005647 Enable the use of the mouse. Works for most terminals (xterm, Win32
5648 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5649 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5650 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005651 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 v Visual mode
5653 i Insert mode
5654 c Command-line mode
5655 h all previous modes when editing a help file
5656 a all previous modes
5657 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005658 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005660< If your terminal can't overrule the mouse events going to the
5661 application, use: >
5662 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005663< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005664 back to Vim using the mouse events.
5665 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5666 "xterm".
5667
5668 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 modeless selection. This doesn't move the text cursor.
5670
5671 See |mouse-using|. Also see |'clipboard'|.
5672
5673 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005674 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 the mouse buttons can still be used by keeping the shift key pressed.
5676 Also see the 'clipboard' option.
5677
5678 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5679'mousefocus' 'mousef' boolean (default off)
5680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 {only works in the GUI}
5682 The window that the mouse pointer is on is automatically activated.
5683 When changing the window layout or window focus in another way, the
5684 mouse pointer is moved to the window with keyboard focus. Off is the
5685 default because it makes using the pull down menus a little goofy, as
5686 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005687 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005688 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689
5690 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5691'mousehide' 'mh' boolean (default on)
5692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 {only works in the GUI}
5694 When on, the mouse pointer is hidden when characters are typed.
5695 The mouse pointer is restored when the mouse is moved.
5696
5697 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005698'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 Sets the model to use for the mouse. The name mostly specifies what
5701 the right mouse button is used for:
5702 extend Right mouse button extends a selection. This works
5703 like in an xterm.
5704 popup Right mouse button pops up a menu. The shifted left
5705 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005706 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 popup_setpos Like "popup", but the cursor will be moved to the
5708 position where the mouse was clicked, and thus the
5709 selected operation will act upon the clicked object.
5710 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005711 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 course, that right clicking outside a selection will
5713 end Visual mode.
5714 Overview of what button does what for each model:
5715 mouse extend popup(_setpos) ~
5716 left click place cursor place cursor
5717 left drag start selection start selection
5718 shift-left search word extend selection
5719 right click extend selection popup menu (place cursor)
5720 right drag extend selection -
5721 middle click paste paste
5722
5723 In the "popup" model the right mouse button produces a pop-up menu.
5724 You need to define this first, see |popup-menu|.
5725
5726 Note that you can further refine the meaning of buttons with mappings.
5727 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5728 selection (because that's handled in the GUI code directly).
5729
5730 The 'mousemodel' option is set by the |:behave| command.
5731
Bram Moolenaar938ae282023-02-20 20:44:55 +00005732 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005733'mousemoveevent' 'mousemev' boolean (default off)
5734 global
5735 {only works in the GUI}
5736 When on, mouse move events are delivered to the input queue and are
5737 available for mapping. The default, off, avoids the mouse movement
5738 overhead except when needed. See |gui-mouse-mapping|.
5739 Warning: Setting this option can make pending mappings to be aborted
5740 when the mouse is moved.
5741 Currently only works in the GUI, may be made to work in a terminal
5742 later.
5743
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005745'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5746 vs:leftright,vd:lrsizing,m:no,
5747 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 {only available when compiled with the |+mouseshape|
5750 feature}
5751 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005752 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 like used for 'guicursor'. Each part consist of a mode/location-list
5754 and an argument-list:
5755 mode-list:shape,mode-list:shape,..
5756 The mode-list is a dash separated list of these modes/locations:
5757 In a normal window: ~
5758 n Normal mode
5759 v Visual mode
5760 ve Visual mode with 'selection' "exclusive" (same as 'v',
5761 if not specified)
5762 o Operator-pending mode
5763 i Insert mode
5764 r Replace mode
5765
5766 Others: ~
5767 c appending to the command-line
5768 ci inserting in the command-line
5769 cr replacing in the command-line
5770 m at the 'Hit ENTER' or 'More' prompts
5771 ml idem, but cursor in the last line
5772 e any mode, pointer below last window
5773 s any mode, pointer on a status line
5774 sd any mode, while dragging a status line
5775 vs any mode, pointer on a vertical separator line
5776 vd any mode, while dragging a vertical separator line
5777 a everywhere
5778
5779 The shape is one of the following:
5780 avail name looks like ~
5781 w x arrow Normal mouse pointer
5782 w x blank no pointer at all (use with care!)
5783 w x beam I-beam
5784 w x updown up-down sizing arrows
5785 w x leftright left-right sizing arrows
5786 w x busy The system's usual busy pointer
5787 w x no The system's usual 'no input' pointer
5788 x udsizing indicates up-down resizing
5789 x lrsizing indicates left-right resizing
5790 x crosshair like a big thin +
5791 x hand1 black hand
5792 x hand2 white hand
5793 x pencil what you write with
5794 x question big ?
5795 x rightup-arrow arrow pointing right-up
5796 w x up-arrow arrow pointing up
5797 x <number> any X11 pointer number (see X11/cursorfont.h)
5798
5799 The "avail" column contains a 'w' if the shape is available for Win32,
5800 x for X11.
5801 Any modes not specified or shapes not available use the normal mouse
5802 pointer.
5803
5804 Example: >
5805 :set mouseshape=s:udsizing,m:no
5806< will make the mouse turn to a sizing arrow over the status lines and
5807 indicate no input when the hit-enter prompt is displayed (since
5808 clicking the mouse has no effect in this state.)
5809
5810 *'mousetime'* *'mouset'*
5811'mousetime' 'mouset' number (default 500)
5812 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005813 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 time in msec between two mouse clicks for the second click to be
5815 recognized as a multi click.
5816
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005817 *'mzschemedll'*
5818'mzschemedll' string (default depends on the build)
5819 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005820 {only available when compiled with the |+mzscheme/dyn|
5821 feature}
5822 Specifies the name of the MzScheme shared library. The default is
5823 DYNAMIC_MZSCH_DLL which was specified at compile time.
5824 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005825 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005826 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005827 This option cannot be set from a |modeline| or in the |sandbox|, for
5828 security reasons.
5829
5830 *'mzschemegcdll'*
5831'mzschemegcdll' string (default depends on the build)
5832 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005833 {only available when compiled with the |+mzscheme/dyn|
5834 feature}
5835 Specifies the name of the MzScheme GC shared library. The default is
5836 DYNAMIC_MZGC_DLL which was specified at compile time.
5837 The value can be equal to 'mzschemedll' if it includes the GC code.
5838 Environment variables are expanded |:set_env|.
5839 This option cannot be set from a |modeline| or in the |sandbox|, for
5840 security reasons.
5841
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005842 *'mzquantum'* *'mzq'*
5843'mzquantum' 'mzq' number (default 100)
5844 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005845 {not available when compiled without the |+mzscheme|
5846 feature}
5847 The number of milliseconds between polls for MzScheme threads.
5848 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005849 NOTE: This option is set to the Vim default value when 'compatible'
5850 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005851
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005853'nrformats' 'nf' string (default "bin,octal,hex",
5854 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 This defines what bases Vim will consider for numbers when using the
5857 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5858 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005859 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005860 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005861 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005862 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005864 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 considered to be hexadecimal. Example: Using CTRL-X on
5866 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005867 bin If included, numbers starting with "0b" or "0B" will be
5868 considered to be binary. Example: Using CTRL-X on
5869 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005870 unsigned If included, numbers are recognized as unsigned. Thus a
5871 leading dash or negative sign won't be considered as part of
5872 the number. Examples:
5873 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5874 (without "unsigned" it would become "9-2021").
5875 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5876 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005877 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5878 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 Numbers which simply begin with a digit in the range 1-9 are always
5880 considered decimal. This also happens for numbers that are not
5881 recognized as octal or hex.
5882
5883 *'number'* *'nu'* *'nonumber'* *'nonu'*
5884'number' 'nu' boolean (default off)
5885 local to window
5886 Print the line number in front of each line. When the 'n' option is
5887 excluded from 'cpoptions' a wrapped line will not use the column of
5888 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005889 The 'numberwidth' option can be used to set the room used for the line
5890 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 When a long, wrapped line doesn't start with the first character, '-'
5892 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005893 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5894 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005895 *number_relativenumber*
5896 The 'relativenumber' option changes the displayed number to be
5897 relative to the cursor. Together with 'number' there are these
5898 four combinations (cursor in line 3):
5899
Bram Moolenaar3848e002016-03-19 18:42:29 +01005900 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005901 'nornu' 'nornu' 'rnu' 'rnu'
5902
5903 |apple | 1 apple | 2 apple | 2 apple
5904 |pear | 2 pear | 1 pear | 1 pear
5905 |nobody | 3 nobody | 0 nobody |3 nobody
5906 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005908 *'numberwidth'* *'nuw'*
5909'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5910 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005911 {only available when compiled with the |+linebreak|
5912 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005913 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005914 when the 'number' or 'relativenumber' option is set or printing lines
5915 with a line number. Since one space is always between the number and
5916 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005917 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005918 fit the highest line number in the buffer respectively the number of
5919 rows in the window, depending on whether 'number' or 'relativenumber'
5920 is set. Thus with the Vim default of 4 there is room for a line number
5921 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005922 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005923 NOTE: This option is set to the Vi default value when 'compatible' is
5924 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005925
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005926 *'omnifunc'* *'ofu'*
5927'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005928 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005929 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005930 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005931 This option specifies a function to be used for Insert mode omni
5932 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005933 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005934 invoked and what it should return. The value can be the name of a
5935 function, a |lambda| or a |Funcref|. See |option-value-function| for
5936 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005937 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005938 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005939 This option cannot be set from a |modeline| or in the |sandbox|, for
5940 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005941
5942
Bram Moolenaar02467872007-05-06 13:22:01 +00005943 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005944'opendevice' 'odev' boolean (default off)
5945 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005946 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005947 Enable reading and writing from devices. This may get Vim stuck on a
5948 device that can be opened but doesn't actually do the I/O. Therefore
5949 it is off by default.
5950 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5951 result in editing a device.
5952
5953
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005954 *'operatorfunc'* *'opfunc'*
5955'operatorfunc' 'opfunc' string (default: empty)
5956 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005957 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005958 See |:map-operator| for more info and an example. The value can be
5959 the name of a function, a |lambda| or a |Funcref|. See
5960 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005961
5962 This option cannot be set from a |modeline| or in the |sandbox|, for
5963 security reasons.
5964
5965
Bram Moolenaar251e1912011-06-19 05:09:16 +02005966 *'osfiletype'* *'oft'*
5967'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005969 This option was supported on RISC OS, which has been removed.
5970
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005972 *'packpath'* *'pp'*
5973'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005974 Directories used to find packages. See |packages|.
5975
5976
Bram Moolenaar071d4272004-06-13 20:20:40 +00005977 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005978'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979 global
5980 Specifies the nroff macros that separate paragraphs. These are pairs
5981 of two letters (see |object-motions|).
5982
5983 *'paste'* *'nopaste'*
5984'paste' boolean (default off)
5985 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005986 Put Vim in Paste mode. This is useful if you want to cut or copy
5987 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 unexpected effects.
5989 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005990 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 knows about pasting and will mostly do the right thing without 'paste'
5992 being set. The same is true for a terminal where Vim handles the
5993 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005994 This option is reset when starting the GUI. Thus if you set it in
5995 your .vimrc it will work in a terminal, but not in the GUI. Setting
5996 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5997 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 When the 'paste' option is switched on (also when it was already on):
5999 - mapping in Insert mode and Command-line mode is disabled
6000 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006002 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006003 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 - 'revins' is reset
6005 - 'ruler' is reset
6006 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006007 - 'smarttab' is reset
6008 - 'softtabstop' is set to 0
6009 - 'textwidth' is set to 0
6010 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006011 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006014 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006015 - 'indentexpr'
6016 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006017 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 NOTE: When you start editing another file while the 'paste' option is
6019 on, settings from the modelines or autocommands may change the
6020 settings again, causing trouble when pasting text. You might want to
6021 set the 'paste' option again.
6022 When the 'paste' option is reset the mentioned options are restored to
6023 the value before the moment 'paste' was switched from off to on.
6024 Resetting 'paste' before ever setting it does not have any effect.
6025 Since mapping doesn't work while 'paste' is active, you need to use
6026 the 'pastetoggle' option to toggle the 'paste' option with some key.
6027
6028 *'pastetoggle'* *'pt'*
6029'pastetoggle' 'pt' string (default "")
6030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 When non-empty, specifies the key sequence that toggles the 'paste'
6032 option. This is like specifying a mapping: >
6033 :map {keys} :set invpaste<CR>
6034< Where {keys} is the value of 'pastetoggle'.
6035 The difference is that it will work even when 'paste' is set.
6036 'pastetoggle' works in Insert mode and Normal mode, but not in
6037 Command-line mode.
6038 Mappings are checked first, thus overrule 'pastetoggle'. However,
6039 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6040 this: >
6041 :map <F10> :set paste<CR>
6042 :map <F11> :set nopaste<CR>
6043 :imap <F10> <C-O>:set paste<CR>
6044 :imap <F11> <nop>
6045 :set pastetoggle=<F11>
6046< This will make <F10> start paste mode and <F11> stop paste mode.
6047 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6048 mode everything is inserted literally, except the 'pastetoggle' key
6049 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006050 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051
6052 *'pex'* *'patchexpr'*
6053'patchexpr' 'pex' string (default "")
6054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 {not available when compiled without the |+diff|
6056 feature}
6057 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006058 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059
Bram Moolenaardbc28022014-07-26 13:40:44 +02006060 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061'patchmode' 'pm' string (default "")
6062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 When non-empty the oldest version of a file is kept. This can be used
6064 to keep the original version of a file if you are changing files in a
6065 source distribution. Only the first time that a file is written a
6066 copy of the original file will be kept. The name of the copy is the
6067 name of the original file with the string in the 'patchmode' option
6068 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006069 ".orig" or ".org". 'backupdir' must not be empty for this to work
6070 (Detail: The backup file is renamed to the patchmode file after the
6071 new file has been successfully written, that's why it must be possible
6072 to write a backup file). If there was no file to be backed up, an
6073 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 When the 'backupskip' pattern matches, a patchmode file is not made.
6075 Using 'patchmode' for compressed files appends the extension at the
6076 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6077 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006078 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006080 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 other systems: ".,,")
6083 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006085 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6086 provided that the file being searched for has a relative path (not
6087 starting with "/", "./" or "../"). The directories in the 'path'
6088 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 - Use commas to separate directory names: >
6090 :set path=.,/usr/local/include,/usr/include
6091< - Spaces can also be used to separate directory names (for backwards
6092 compatibility with version 3.0). To have a space in a directory
6093 name, precede it with an extra backslash, and escape the space: >
6094 :set path=.,/dir/with\\\ space
6095< - To include a comma in a directory name precede it with an extra
6096 backslash: >
6097 :set path=.,/dir/with\\,comma
6098< - To search relative to the directory of the current file, use: >
6099 :set path=.
6100< - To search in the current directory use an empty string between two
6101 commas: >
6102 :set path=,,
6103< - A directory name may end in a ':' or '/'.
6104 - Environment variables are expanded |:set_env|.
6105 - When using |netrw.vim| URLs can be used. For example, adding
6106 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006107 - Search upwards and downwards in a directory tree using "*", "**" and
6108 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 - Careful with '\' characters, type two to get one in the option: >
6110 :set path=.,c:\\include
6111< Or just use '/' instead: >
6112 :set path=.,c:/include
6113< Don't forget "." or files won't even be found in the same directory as
6114 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006115 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 it is something like 256 or 1024 characters.
6117 You can check if all the include files are found, using the value of
6118 'path', see |:checkpath|.
6119 The use of |:set+=| and |:set-=| is preferred when adding or removing
6120 directories from the list. This avoids problems when a future version
6121 uses another default. To remove the current directory use: >
6122 :set path-=
6123< To add the current directory use: >
6124 :set path+=
6125< To use an environment variable, you probably need to replace the
6126 separator. Here is an example to append $INCL, in which directory
6127 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006128 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129< Replace the ';' with a ':' or whatever separator is used. Note that
6130 this doesn't work when $INCL contains a comma or white space.
6131
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006132 *'perldll'*
6133'perldll' string (default depends on the build)
6134 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006135 {only available when compiled with the |+perl/dyn|
6136 feature}
6137 Specifies the name of the Perl shared library. The default is
6138 DYNAMIC_PERL_DLL, which was specified at compile time.
6139 Environment variables are expanded |:set_env|.
6140 This option cannot be set from a |modeline| or in the |sandbox|, for
6141 security reasons.
6142
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6144'preserveindent' 'pi' boolean (default off)
6145 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 When changing the indent of the current line, preserve as much of the
6147 indent structure as possible. Normally the indent is replaced by a
6148 series of tabs followed by spaces as required (unless |'expandtab'| is
6149 enabled, in which case only spaces are used). Enabling this option
6150 means the indent will preserve as many existing characters as possible
6151 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006152 'expandtab' does not apply to the preserved white space, a Tab remains
6153 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 NOTE: When using ">>" multiple times the resulting indent is a mix of
6155 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006156 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 Also see 'copyindent'.
6158 Use |:retab| to clean up white space.
6159
6160 *'previewheight'* *'pvh'*
6161'previewheight' 'pvh' number (default 12)
6162 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006163 {not available when compiled without the |+quickfix|
6164 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006166 commands. Used for |CTRL-W_}| when no count is given. Not used when
6167 'previewpopup' is set.
6168
6169 *'previewpopup'* *'pvp'*
6170'previewpopup' 'pvp' string (default empty)
6171 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006172 {not available when compiled without the |+textprop|
6173 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006174 When not empty a popup window is used for commands that would open a
6175 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006176 Not used for the insert completion info, add "popup" to
6177 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178
6179 *'previewwindow'* *'nopreviewwindow'*
6180 *'pvw'* *'nopvw'* *E590*
6181'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006182 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006183 {not available when compiled without the |+quickfix|
6184 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006185 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 set. It's normally not set directly, but by using one of the commands
6187 |:ptag|, |:pedit|, etc.
6188
6189 *'printdevice'* *'pdev'*
6190'printdevice' 'pdev' string (default empty)
6191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 {only available when compiled with the |+printer|
6193 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006194 The name of the printer to be used for |:hardcopy|.
6195 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006196 This option cannot be set from a |modeline| or in the |sandbox|, for
6197 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198
Bram Moolenaar8299df92004-07-10 09:47:34 +00006199 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006200'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 {only available when compiled with the |+printer|
6203 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006204 Sets the character encoding used when printing.
6205 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206
6207 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006208'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 {only available when compiled with the |+printer|
6211 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006212 Expression used to print the PostScript produced with |:hardcopy|.
6213 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006214 This option cannot be set from a |modeline| or in the |sandbox|, for
6215 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216
Bram Moolenaar8299df92004-07-10 09:47:34 +00006217 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218'printfont' 'pfn' string (default "courier")
6219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 {only available when compiled with the |+printer|
6221 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006222 The name of the font that will be used for |:hardcopy|.
6223 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224
6225 *'printheader'* *'pheader'*
6226'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228 {only available when compiled with the |+printer|
6229 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006230 The format of the header produced in |:hardcopy| output.
6231 See |pheader-option|.
6232
6233 *'printmbcharset'* *'pmbcs'*
6234'printmbcharset' 'pmbcs' string (default "")
6235 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006236 {only available when compiled with the |+printer|
6237 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006238 The CJK character set to be used for CJK output from |:hardcopy|.
6239 See |pmbcs-option|.
6240
6241 *'printmbfont'* *'pmbfn'*
6242'printmbfont' 'pmbfn' string (default "")
6243 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006244 {only available when compiled with the |+printer|
6245 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006246 List of font names to be used for CJK output from |:hardcopy|.
6247 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248
6249 *'printoptions'* *'popt'*
6250'printoptions' 'popt' string (default "")
6251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006253 List of items that control the format of the output of |:hardcopy|.
6254 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006256 *'prompt'* *'noprompt'*
6257'prompt' boolean (default on)
6258 global
6259 When on a ":" prompt is used in Ex mode.
6260
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006261 *'pumheight'* *'ph'*
6262'pumheight' 'ph' number (default 0)
6263 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006264 Determines the maximum number of items to show in the popup menu for
6265 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006266 |ins-completion-menu|.
6267
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006268 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006269'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006270 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006271 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006272 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006273
Bram Moolenaard94464e2015-11-02 15:28:18 +01006274 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006275'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006276 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006277 {only available when compiled with the |+python/dyn|
6278 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006279 Specifies the name of the Python 2.x shared library. The default is
6280 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006281 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006282 This option cannot be set from a |modeline| or in the |sandbox|, for
6283 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006284
Bram Moolenaar94073162018-01-31 21:49:05 +01006285 *'pythonhome'*
6286'pythonhome' string (default "")
6287 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006288 {only available when compiled with the |+python/dyn|
6289 feature}
6290 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6291 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6292 which was specified at compile time, will be used for the Python 2.x
6293 home directory.
6294 Environment variables are expanded |:set_env|.
6295 This option cannot be set from a |modeline| or in the |sandbox|, for
6296 security reasons.
6297
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006298 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006299'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006300 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006301 {only available when compiled with the |+python3/dyn|
6302 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006303 Specifies the name of the Python 3 shared library. The default is
6304 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006305 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006306 This option cannot be set from a |modeline| or in the |sandbox|, for
6307 security reasons.
6308
Bram Moolenaar94073162018-01-31 21:49:05 +01006309 *'pythonthreehome'*
6310'pythonthreehome' string (default "")
6311 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006312 {only available when compiled with the |+python3/dyn|
6313 feature}
6314 Specifies the name of the Python 3 home directory. When
6315 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6316 PYTHON3_HOME, which was specified at compile time, will be used for
6317 the Python 3 home directory.
6318 Environment variables are expanded |:set_env|.
6319 This option cannot be set from a |modeline| or in the |sandbox|, for
6320 security reasons.
6321
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006322 *'pyxversion'* *'pyx'*
6323'pyxversion' 'pyx' number (default depends on the build)
6324 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006325 {only available when compiled with the |+python| or
6326 the |+python3| feature}
6327 Specifies the python version used for pyx* functions and commands
6328 |python_x|. The default value is as follows:
6329
6330 Compiled with Default ~
6331 |+python| and |+python3| 0
6332 only |+python| 2
6333 only |+python3| 3
6334
6335 Available values are 0, 2 and 3.
6336 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6337 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6338 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6339 to 2 if Python 2 is available.
6340 See also: |has-pythonx|
6341
6342 If Vim is compiled with only |+python| or |+python3| setting
6343 'pyxversion' has no effect. The pyx* functions and commands are
6344 always the same as the compiled version.
6345
6346 This option cannot be set from a |modeline| or in the |sandbox|, for
6347 security reasons.
6348
Bram Moolenaar858ba062020-05-31 23:11:59 +02006349 *'quickfixtextfunc'* *'qftf'*
6350'quickfixtextfunc' 'qftf' string (default "")
6351 global
6352 {only available when compiled with the |+quickfix|
6353 feature}
6354 This option specifies a function to be used to get the text to display
6355 in the quickfix and location list windows. This can be used to
6356 customize the information displayed in the quickfix or location window
6357 for each entry in the corresponding quickfix or location list. See
6358 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006359 function and an example. The value can be the name of a function, a
6360 |lambda| or a |Funcref|. See |option-value-function| for more
6361 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006362
6363 This option cannot be set from a |modeline| or in the |sandbox|, for
6364 security reasons.
6365
Bram Moolenaar677ee682005-01-27 14:41:15 +00006366 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006367'quoteescape' 'qe' string (default "\")
6368 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006369 The characters that are used to escape quotes in a string. Used for
6370 objects like a', a" and a` |a'|.
6371 When one of the characters in this option is found inside a string,
6372 the following character will be skipped. The default value makes the
6373 text "foo\"bar\\" considered to be one string.
6374
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6376'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006377 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 If on, writes fail unless you use a '!'. Protects you from
6379 accidentally overwriting a file. Default on when Vim is started
6380 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006381 When using ":w!" the 'readonly' option is reset for the current
6382 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006383 When using the ":view" command the 'readonly' option is set for the
6384 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006385 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006387 *'redrawtime'* *'rdt'*
6388'redrawtime' 'rdt' number (default 2000)
6389 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006390 {only available when compiled with the |+reltime|
6391 feature}
6392 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006393 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006394 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006395 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006396 matches will be highlighted.
6397 For syntax highlighting the time applies per window. When over the
6398 limit syntax highlighting is disabled until |CTRL-L| is used.
6399 This is used to avoid that Vim hangs when using a very complicated
6400 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006401
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006402 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006403'regexpengine' 're' number (default 0)
6404 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006405 This selects the default regexp engine. |two-engines|
6406 The possible values are:
6407 0 automatic selection
6408 1 old engine
6409 2 NFA engine
6410 Note that when using the NFA engine and the pattern contains something
6411 that is not supported the pattern will not match. This is only useful
6412 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006413 Using automatic selection enables Vim to switch the engine, if the
6414 default engine becomes too costly. E.g., when the NFA engine uses too
6415 many states. This should prevent Vim from hanging on a combination of
6416 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006417
Bram Moolenaar64486672010-05-16 15:46:46 +02006418 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6419'relativenumber' 'rnu' boolean (default off)
6420 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006421 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006422 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006423 precede some vertical motion commands (e.g. j k + -) with, without
6424 having to calculate it yourself. Especially useful in combination with
6425 other commands (e.g. y d c < > gq gw =).
6426 When the 'n' option is excluded from 'cpoptions' a wrapped
6427 line will not use the column of line numbers (this is the default when
6428 'compatible' isn't set).
6429 The 'numberwidth' option can be used to set the room used for the line
6430 number.
6431 When a long, wrapped line doesn't start with the first character, '-'
6432 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006433 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6434 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006435
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006436 The number in front of the cursor line also depends on the value of
6437 'number', see |number_relativenumber| for all combinations of the two
6438 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006439
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 *'remap'* *'noremap'*
6441'remap' boolean (default on)
6442 global
6443 Allows for mappings to work recursively. If you do not want this for
6444 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006445 NOTE: To avoid portability problems with Vim scripts, always keep
6446 this option at the default "on". Only switch it off when working with
6447 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006449 *'renderoptions'* *'rop'*
6450'renderoptions' 'rop' string (default: empty)
6451 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006452 {only available when compiled with GUI and DIRECTX on
6453 MS-Windows}
6454 Select a text renderer and set its options. The options depend on the
6455 renderer.
6456
6457 Syntax: >
6458 set rop=type:{renderer}(,{name}:{value})*
6459<
6460 Currently, only one optional renderer is available.
6461
6462 render behavior ~
6463 directx Vim will draw text using DirectX (DirectWrite). It makes
6464 drawn glyphs more beautiful than default GDI.
6465 It requires 'encoding' is "utf-8", and only works on
6466 MS-Windows Vista or newer version.
6467
6468 Options:
6469 name meaning type value ~
6470 gamma gamma float 1.0 - 2.2 (maybe)
6471 contrast enhancedContrast float (unknown)
6472 level clearTypeLevel float (unknown)
6473 geom pixelGeometry int 0 - 2 (see below)
6474 renmode renderingMode int 0 - 6 (see below)
6475 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006476 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006477
Bram Moolenaar92467d32017-12-05 13:22:16 +01006478 See this URL for detail (except for scrlines):
6479 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006480
6481 For geom: structure of a device pixel.
6482 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6483 1 - DWRITE_PIXEL_GEOMETRY_RGB
6484 2 - DWRITE_PIXEL_GEOMETRY_BGR
6485
6486 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006487 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006488
6489 For renmode: method of rendering glyphs.
6490 0 - DWRITE_RENDERING_MODE_DEFAULT
6491 1 - DWRITE_RENDERING_MODE_ALIASED
6492 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6493 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6494 4 - DWRITE_RENDERING_MODE_NATURAL
6495 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6496 6 - DWRITE_RENDERING_MODE_OUTLINE
6497
6498 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006499 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006500
6501 For taamode: antialiasing mode used for drawing text.
6502 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6503 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6504 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6505 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6506
6507 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006508 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6509
Bram Moolenaara338adc2018-01-31 20:51:47 +01006510 For scrlines:
6511 This was used for optimizing scrolling behavior, however this
6512 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006513
6514 Example: >
6515 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006516 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006517 set rop=type:directx
6518<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006519 If select a raster font (Courier, Terminal or FixedSys which
6520 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006521 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006522
6523 NOTE: It is known that some fonts and options combination
6524 causes trouble on drawing glyphs.
6525
Bram Moolenaar92467d32017-12-05 13:22:16 +01006526 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006527 special made fonts (True-Type fonts which includes only
6528 bitmap glyphs).
6529 - 'taamode:3' will not work with some vector fonts.
6530
6531 NOTE: With this option, you can display colored emoji
6532 (emoticon) in Windows 8.1 or later. To display colored emoji,
6533 there are some conditions which you should notice.
6534
6535 - If your font includes non-colored emoji already, it will
6536 be used.
6537 - If your font doesn't have emoji, the system chooses an
6538 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6539 will be used.
6540 - When this alternative font didn't have fixed width glyph,
6541 emoji might be rendered beyond the bounding box of drawing
6542 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006543
6544 Other render types are currently not supported.
6545
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 *'report'*
6547'report' number (default 2)
6548 global
6549 Threshold for reporting number of lines changed. When the number of
6550 changed lines is more than 'report' a message will be given for most
6551 ":" commands. If you want it always, set 'report' to 0.
6552 For the ":substitute" command the number of substitutions is used
6553 instead of the number of lines.
6554
6555 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6556'restorescreen' 'rs' boolean (default on)
6557 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006558 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 When set, the screen contents is restored when exiting Vim. This also
6560 happens when executing external commands.
6561
6562 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6563 options in your .vimrc. To disable restoring:
6564 set t_ti= t_te=
6565 To enable restoring (for an xterm):
6566 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6567 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6568
6569 *'revins'* *'ri'* *'norevins'* *'nori'*
6570'revins' 'ri' boolean (default off)
6571 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572 {only available when compiled with the |+rightleft|
6573 feature}
6574 Inserting characters in Insert mode will work backwards. See "typing
6575 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6576 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006577 NOTE: This option is reset when 'compatible' is set.
6578 This option is reset when 'paste' is set and restored when 'paste' is
6579 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580
6581 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6582'rightleft' 'rl' boolean (default off)
6583 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 {only available when compiled with the |+rightleft|
6585 feature}
6586 When on, display orientation becomes right-to-left, i.e., characters
6587 that are stored in the file appear from the right to the left.
6588 Using this option, it is possible to edit files for languages that
6589 are written from the right to the left such as Hebrew and Arabic.
6590 This option is per window, so it is possible to edit mixed files
6591 simultaneously, or to view the same file in both ways (this is
6592 useful whenever you have a mixed text file with both right-to-left
6593 and left-to-right strings so that both sets are displayed properly
6594 in different windows). Also see |rileft.txt|.
6595
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006596 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597'rightleftcmd' 'rlc' string (default "search")
6598 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 {only available when compiled with the |+rightleft|
6600 feature}
6601 Each word in this option enables the command line editing to work in
6602 right-to-left mode for a group of commands:
6603
6604 search "/" and "?" commands
6605
6606 This is useful for languages such as Hebrew, Arabic and Farsi.
6607 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6608
Bram Moolenaard94464e2015-11-02 15:28:18 +01006609 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006610'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006611 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006612 {only available when compiled with the |+ruby/dyn|
6613 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006614 Specifies the name of the Ruby shared library. The default is
6615 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006616 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006617 This option cannot be set from a |modeline| or in the |sandbox|, for
6618 security reasons.
6619
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006621'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006624 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 text in the file is shown on the far right:
6626 Top first line is visible
6627 Bot last line is visible
6628 All first and last line are visible
6629 45% relative position in the file
6630 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006631 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006632 ruler is shown there. Otherwise it is shown in the last line of the
6633 screen. If the statusline is given by 'statusline' (i.e. not empty),
6634 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006636 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 the text column (byte number) and the screen column are shown,
6638 separated with a dash.
6639 For an empty line "0-1" is shown.
6640 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006641 This option is reset when 'paste' is set and restored when 'paste' is
6642 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 If you don't want to see the ruler all the time but want to know where
6644 you are, use "g CTRL-G" |g_CTRL-G|.
6645 NOTE: This option is reset when 'compatible' is set.
6646
6647 *'rulerformat'* *'ruf'*
6648'rulerformat' 'ruf' string (default empty)
6649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 {not available when compiled without the |+statusline|
6651 feature}
6652 When this option is not empty, it determines the content of the ruler
6653 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006654 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006655 This option cannot be set in a modeline when 'modelineexpr' is off.
6656
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 The default ruler width is 17 characters. To make the ruler 15
6658 characters wide, put "%15(" at the start and "%)" at the end.
6659 Example: >
6660 :set rulerformat=%15(%c%V\ %p%%%)
6661<
6662 *'runtimepath'* *'rtp'* *vimfiles*
6663'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006664 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 $VIM/vimfiles,
6666 $VIMRUNTIME,
6667 $VIM/vimfiles/after,
6668 $HOME/.vim/after"
6669 Amiga: "home:vimfiles,
6670 $VIM/vimfiles,
6671 $VIMRUNTIME,
6672 $VIM/vimfiles/after,
6673 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006674 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 $VIM/vimfiles,
6676 $VIMRUNTIME,
6677 $VIM/vimfiles/after,
6678 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006679 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 $VIMRUNTIME,
6681 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006682 Haiku: "$BE_USER_SETTINGS/vim,
6683 $VIM/vimfiles,
6684 $VIMRUNTIME,
6685 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006686 $BE_USER_SETTINGS/vim/after"
6687 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 $VIM/vimfiles,
6689 $VIMRUNTIME,
6690 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006691 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 This is a list of directories which will be searched for runtime
6694 files:
6695 filetype.vim filetypes by file name |new-filetype|
6696 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006697 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 colors/ color scheme files |:colorscheme|
6699 compiler/ compiler files |:compiler|
6700 doc/ documentation |write-local-help|
6701 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006702 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 indent/ indent scripts |indent-expression|
6704 keymap/ key mapping files |mbyte-keymap|
6705 lang/ menu translations |:menutrans|
6706 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006707 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 plugin/ plugin scripts |write-plugin|
6709 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006710 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 syntax/ syntax files |mysyntaxfile|
6712 tutor/ files for vimtutor |tutor|
6713
6714 And any other file searched for with the |:runtime| command.
6715
6716 The defaults for most systems are setup to search five locations:
6717 1. In your home directory, for your personal preferences.
6718 2. In a system-wide Vim directory, for preferences from the system
6719 administrator.
6720 3. In $VIMRUNTIME, for files distributed with Vim.
6721 *after-directory*
6722 4. In the "after" directory in the system-wide Vim directory. This is
6723 for the system administrator to overrule or add to the distributed
6724 defaults (rarely needed)
6725 5. In the "after" directory in your home directory. This is for
6726 personal preferences to overrule or add to the distributed defaults
6727 or system-wide settings (rarely needed).
6728
Bram Moolenaard0796902016-09-16 20:02:31 +02006729 More entries are added when using |packages|. If it gets very long
6730 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6731 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006732
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6734 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006735 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 wildcards.
6737 See |:runtime|.
6738 Example: >
6739 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6740< This will use the directory "~/vimruntime" first (containing your
6741 personal Vim runtime files), then "/mygroup/vim" (shared between a
6742 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6743 files).
6744 You probably should always include $VIMRUNTIME somewhere, to use the
6745 distributed runtime files. You can put a directory before $VIMRUNTIME
6746 to find files which replace a distributed runtime files. You can put
6747 a directory after $VIMRUNTIME to find files which add to distributed
6748 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006749 When Vim is started with |--clean| the home directory entries are not
6750 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 This option cannot be set from a |modeline| or in the |sandbox|, for
6752 security reasons.
6753
6754 *'scroll'* *'scr'*
6755'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006756 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006757 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6758 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006759 changes. This may happen when enabling the |status-line| or
6760 'tabline' option after setting the 'scroll' option.
6761 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006762 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006763 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764
6765 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6766'scrollbind' 'scb' boolean (default off)
6767 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006768 See also |scroll-binding|. When this option is set, scrolling the
6769 current window also scrolls other scrollbind windows (windows that
6770 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 differences between two versions of a file, see 'diff'.
6772 See |'scrollopt'| for options that determine how this option should be
6773 interpreted.
6774 This option is mostly reset when splitting a window to edit another
6775 file. This means that ":split | edit file" results in two windows
6776 with scroll-binding, but ":split file" does not.
6777
Bram Moolenaarae20f342019-11-05 21:09:23 +01006778 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6779'scrollfocus' 'scf' boolean (default off)
6780 global
6781 {only for MS-Windows GUI}
6782 When using the scroll wheel and this option is set, the window under
6783 the mouse pointer is scrolled. With this option off the current
6784 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006785 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006786
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 *'scrolljump'* *'sj'*
6788'scrolljump' 'sj' number (default 1)
6789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 Minimal number of lines to scroll when the cursor gets off the
6791 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6792 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006793 When set to a negative number from -1 to -100 this is used as the
6794 percentage of the window height. Thus -50 scrolls half the window
6795 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 NOTE: This option is set to 1 when 'compatible' is set.
6797
6798 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006799'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006800 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 Minimal number of screen lines to keep above and below the cursor.
6802 This will make some context visible around where you are working. If
6803 you set it to a very large value (999) the cursor line will always be
6804 in the middle of the window (except at the start or end of the file or
6805 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006806 After using the local value, go back the global value with one of
6807 these two: >
6808 setlocal scrolloff<
6809 setlocal scrolloff=-1
6810< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 NOTE: This option is set to 0 when 'compatible' is set.
6812
6813 *'scrollopt'* *'sbo'*
6814'scrollopt' 'sbo' string (default "ver,jump")
6815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006817 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6818 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 The following words are available:
6820 ver Bind vertical scrolling for 'scrollbind' windows
6821 hor Bind horizontal scrolling for 'scrollbind' windows
6822 jump Applies to the offset between two windows for vertical
6823 scrolling. This offset is the difference in the first
6824 displayed line of the bound windows. When moving
6825 around in a window, another 'scrollbind' window may
6826 reach a position before the start or after the end of
6827 the buffer. The offset is not changed though, when
6828 moving back the 'scrollbind' window will try to scroll
6829 to the desired position when possible.
6830 When now making that window the current one, two
6831 things can be done with the relative offset:
6832 1. When "jump" is not included, the relative offset is
6833 adjusted for the scroll position in the new current
6834 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006835 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 2. When "jump" is included, the other windows are
6837 scrolled to keep the same relative offset. When
6838 going back to the other window, it still uses the
6839 same relative offset.
6840 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006841 When 'diff' mode is active there always is vertical scroll binding,
6842 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843
6844 *'sections'* *'sect'*
6845'sections' 'sect' string (default "SHNHH HUnhsh")
6846 global
6847 Specifies the nroff macros that separate sections. These are pairs of
6848 two letters (See |object-motions|). The default makes a section start
6849 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6850
6851 *'secure'* *'nosecure'* *E523*
6852'secure' boolean (default off)
6853 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 When on, ":autocmd", shell and write commands are not allowed in
6855 ".vimrc" and ".exrc" in the current directory and map commands are
6856 displayed. Switch it off only if you know that you will not run into
6857 problems, or when the 'exrc' option is off. On Unix this option is
6858 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006859 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 'secure' at the end of your ~/.vimrc then.
6861 This option cannot be set from a |modeline| or in the |sandbox|, for
6862 security reasons.
6863
6864 *'selection'* *'sel'*
6865'selection' 'sel' string (default "inclusive")
6866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 This option defines the behavior of the selection. It is only used
6868 in Visual and Select mode.
6869 Possible values:
6870 value past line inclusive ~
6871 old no yes
6872 inclusive yes yes
6873 exclusive yes no
6874 "past line" means that the cursor is allowed to be positioned one
6875 character past the line.
6876 "inclusive" means that the last character of the selection is included
6877 in an operation. For example, when "x" is used to delete the
6878 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006879 When "old" is used and 'virtualedit' allows the cursor to move past
6880 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 Note that when "exclusive" is used and selecting from the end
6882 backwards, you cannot include the last character of a line, when
6883 starting in Normal mode and 'virtualedit' empty.
6884
6885 The 'selection' option is set by the |:behave| command.
6886
6887 *'selectmode'* *'slm'*
6888'selectmode' 'slm' string (default "")
6889 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006890 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 Select mode instead of Visual mode, when a selection is started.
6892 Possible values:
6893 mouse when using the mouse
6894 key when using shifted special keys
6895 cmd when using "v", "V" or CTRL-V
6896 See |Select-mode|.
6897 The 'selectmode' option is set by the |:behave| command.
6898
6899 *'sessionoptions'* *'ssop'*
6900'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006901 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006903 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 feature}
6905 Changes the effect of the |:mksession| command. It is a comma
6906 separated list of words. Each word enables saving and restoring
6907 something:
6908 word save and restore ~
6909 blank empty windows
6910 buffers hidden and unloaded buffers, not just those in windows
6911 curdir the current directory
6912 folds manually created folds, opened/closed folds and local
6913 fold options
6914 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006915 and contain at least one lowercase letter. Only
6916 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 help the help window
6918 localoptions options and mappings local to a window or buffer (not
6919 global values for local options)
6920 options all options and mappings (also global values for local
6921 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006922 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 resize size of the Vim window: 'lines' and 'columns'
6924 sesdir the directory in which the session file is located
6925 will become the current directory (useful with
6926 projects accessed over a network from different
6927 systems)
6928 slash backslashes in file names replaced with forward
6929 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006930 tabpages all tab pages; without this only the current tab page
6931 is restored, so that you can make a session for each
6932 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006933 terminal include terminal windows where the command can be
6934 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 unix with Unix end-of-line format (single <NL>), even when
6936 on Windows or DOS
6937 winpos position of the whole Vim window
6938 winsize window sizes
6939
6940 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006941 When neither "curdir" nor "sesdir" is included, file names are stored
6942 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006943 If you leave out "options" many things won't work well after restoring
6944 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 "slash" and "unix" are useful on Windows when sharing session files
6946 with Unix. The Unix version of Vim cannot source dos format scripts,
6947 but the Windows version of Vim can source unix format scripts.
6948
6949 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006950'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 global
6952 Name of the shell to use for ! and :! commands. When changing the
6953 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6954 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006955 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 See |option-backslash| about including spaces and backslashes.
6957 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006958
Bram Moolenaara2baa732022-02-04 16:09:54 +00006959 In |restricted-mode| shell commands will not be possible. This mode
6960 is used if the value of $SHELL ends in "false" or "nologin".
6961
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006962 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006963 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6965< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006966 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006968 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006970 Example with escaped space (Vim will do this when initializing the
6971 option from $SHELL): >
6972 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006973< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006974 backslashes are consumed by `:set`.
6975
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 Under MS-Windows, when the executable ends in ".com" it must be
6977 included. Thus setting the shell to "command.com" or "4dos.com"
6978 works, but "command" and "4dos" do not work for all commands (e.g.,
6979 filtering).
6980 For unknown reasons, when using "4dos.com" the current directory is
6981 changed to "C:\". To avoid this set 'shell' like this: >
6982 :set shell=command.com\ /c\ 4dos
6983< This option cannot be set from a |modeline| or in the |sandbox|, for
6984 security reasons.
6985
6986 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006987'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006988 Win32, when 'shell' contains "powershell":
6989 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006990 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006993 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6994 For MS-Windows, the default is set according to the value of 'shell',
6995 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006996 On Unix it can have more than one flag. Each white space separated
6997 part is passed as an argument to the shell command.
6998 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006999 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 This option cannot be set from a |modeline| or in the |sandbox|, for
7001 security reasons.
7002
7003 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007004'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7005 "2>&1| tee", or
7006 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 {not available when compiled without the |+quickfix|
7009 feature}
7010 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007011 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 including spaces and backslashes.
7013 The name of the temporary file can be represented by "%s" if necessary
7014 (the file name is appended automatically if no %s appears in the value
7015 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007016 For the Amiga the default is ">". For MS-Windows using powershell the
7017 default is "2>&1 | Out-File -Encoding default", otherwise the default
7018 is ">%s 2>&1". The output is directly saved in a file and not echoed
7019 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007020 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 in a file and echoed to the screen. If the 'shell' option is "csh" or
7022 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007023 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007024 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7025 means that stderr is also included. Before using the 'shell' option a
7026 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007027 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7028 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 The initialization of this option is done after reading the ".vimrc"
7030 and the other initializations, so that when the 'shell' option is set
7031 there, the 'shellpipe' option changes automatically, unless it was
7032 explicitly set before.
7033 When 'shellpipe' is set to an empty string, no redirection of the
7034 ":make" output will be done. This is useful if you use a 'makeprg'
7035 that writes to 'makeef' by itself. If you want no piping, but do
7036 want to include the 'makeef', set 'shellpipe' to a single space.
7037 Don't forget to precede the space with a backslash: ":set sp=\ ".
7038 In the future pipes may be used for filtering and this option will
7039 become obsolete (at least for Unix).
7040 This option cannot be set from a |modeline| or in the |sandbox|, for
7041 security reasons.
7042
7043 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007044'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 Quoting character(s), put around the command passed to the shell, for
7047 the "!" and ":!" commands. The redirection is kept outside of the
7048 quoting. See 'shellxquote' to include the redirection. It's
7049 probably not useful to set both options.
7050 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007051 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007052 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 This option cannot be set from a |modeline| or in the |sandbox|, for
7054 security reasons.
7055
7056 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007057'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7058 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 String to be used to put the output of a filter command in a temporary
7061 file. See also |:!|. See |option-backslash| about including spaces
7062 and backslashes.
7063 The name of the temporary file can be represented by "%s" if necessary
7064 (the file name is appended automatically if no %s appears in the value
7065 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007066 The default is ">". For Unix, if the 'shell' option is "csh" or
7067 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007068 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007069 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7070 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007071 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7072 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007073 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7074 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 The initialization of this option is done after reading the ".vimrc"
7076 and the other initializations, so that when the 'shell' option is set
7077 there, the 'shellredir' option changes automatically unless it was
7078 explicitly set before.
7079 In the future pipes may be used for filtering and this option will
7080 become obsolete (at least for Unix).
7081 This option cannot be set from a |modeline| or in the |sandbox|, for
7082 security reasons.
7083
7084 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7085'shellslash' 'ssl' boolean (default off)
7086 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007087 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007089 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007090 powershell.exe. Backward slashes can still be typed, but they are
7091 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 Note that setting or resetting this option has no effect for some
7093 existing file names, thus this option needs to be set before opening
7094 any file for best results. This might change in the future.
7095 'shellslash' only works when a backslash can be used as a path
7096 separator. To test if this is so use: >
7097 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007098< Also see 'completeslash'.
7099
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007100 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7101'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7102 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007103 When on, use temp files for shell commands. When off use a pipe.
7104 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007105 Currently a pipe is only supported on Unix and MS-Windows 2K and
7106 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007107 :if has("filterpipe")
7108< The advantage of using a pipe is that nobody can read the temp file
7109 and the 'shell' command does not need to support redirection.
7110 The advantage of using a temp file is that the file type and encoding
7111 can be detected.
7112 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7113 |FilterWritePost| autocommands event are not triggered when
7114 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007115 The `system()` function does not respect this option and always uses
7116 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007117 NOTE: This option is set to the Vim default value when 'compatible'
7118 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007119
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 *'shelltype'* *'st'*
7121'shelltype' 'st' number (default 0)
7122 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007123 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 On the Amiga this option influences the way how the commands work
7125 which use a shell.
7126 0 and 1: always use the shell
7127 2 and 3: use the shell only to filter lines
7128 4 and 5: use shell only for ':sh' command
7129 When not using the shell, the command is executed directly.
7130
7131 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7132 1 and 3: use "shell cmd" to start external commands
7133
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007134 *'shellxescape'* *'sxe'*
7135'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007136 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007137 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007138 When 'shellxquote' is set to "(" then the characters listed in this
7139 option will be escaped with a '^' character. This makes it possible
7140 to execute most external commands with cmd.exe.
7141
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 *'shellxquote'* *'sxq'*
7143'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007144 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007145 for Win32, when 'shell' is
7146 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007147 for Win32, when 'shell' contains "sh"
7148 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 for Unix, when using system(): "\"")
7150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 Quoting character(s), put around the command passed to the shell, for
7152 the "!" and ":!" commands. Includes the redirection. See
7153 'shellquote' to exclude the redirection. It's probably not useful
7154 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007155 When the value is '(' then ')' is appended. When the value is '"('
7156 then ')"' is appended.
7157 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007158 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007159 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7160 pwsh.exe which automatically strips off the first and last quote on a
7161 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7162 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007163 'shell', to reduce the need to set this option by the user. See
7164 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 This option cannot be set from a |modeline| or in the |sandbox|, for
7166 security reasons.
7167
7168 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7169'shiftround' 'sr' boolean (default off)
7170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 Round indent to multiple of 'shiftwidth'. Applies to > and <
7172 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7173 a multiple of 'shiftwidth' (this is Vi compatible).
7174 NOTE: This option is reset when 'compatible' is set.
7175
7176 *'shiftwidth'* *'sw'*
7177'shiftwidth' 'sw' number (default 8)
7178 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007179 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007181 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007182 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183
7184 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007185'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7186 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007187 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 This option helps to avoid all the |hit-enter| prompts caused by file
7189 messages, for example with CTRL-G, and to avoid some other messages.
7190 It is a list of flags:
7191 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007192 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7193 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7194 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7195 m use "[+]" instead of "[Modified]" *shm-m*
7196 n use "[New]" instead of "[New File]" *shm-n*
7197 r use "[RO]" instead of "[readonly]" *shm-r*
7198 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007200 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7201 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007202 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007203 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007205 o overwrite message for writing a file with subsequent *shm-o*
7206 message for reading a file (useful for ":wn" or when
7207 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007208 O message for reading a file overwrites any previous *shm-O*
7209 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007210 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7211 "search hit TOP, continuing at BOTTOM" messages; when using
7212 the search count do not show "W" after the count message (see
7213 S below)
7214 t truncate file message at the start if it is too long *shm-t*
7215 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007216 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007217 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007218 long to fit on the command line; "..." will appear in the
7219 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007220 W don't give "written" or "[w]" when writing a file *shm-W*
7221 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007222 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007223 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007224 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007225 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007226 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7227 match", "Pattern not found", "Back at original", etc.
7228 C don't give messages while scanning for ins-completion *shm-C*
7229 items, for instance "scanning tags"
7230 q use "recording" instead of "recording @a" *shm-q*
7231 F don't give the file info when editing a file, like *shm-F*
7232 `:silent` was used for the command; note that this also
7233 affects messages from autocommands
Bram Moolenaar938ae282023-02-20 20:44:55 +00007234 S do not show search count message when searching, e.g. *shm-S*
7235 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236
7237 This gives you the opportunity to avoid that a change between buffers
7238 requires you to hit <Enter>, but still gives as useful a message as
7239 possible for the space available. To get the whole message that you
7240 would have got with 'shm' empty, use ":file!"
7241 Useful values:
7242 shm= No abbreviation of message.
7243 shm=a Abbreviation, but no loss of information.
7244 shm=at Abbreviation, and truncate message when necessary.
7245
7246 NOTE: This option is set to the Vi default value when 'compatible' is
7247 set and to the Vim default value when 'compatible' is reset.
7248
7249 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7250'shortname' 'sn' boolean (default off)
7251 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 Filenames are assumed to be 8 characters plus one extension of 3
7253 characters. Multiple dots in file names are not allowed. When this
7254 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007255 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007257 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258
7259 *'showbreak'* *'sbr'* *E595*
7260'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007261 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007262 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 feature}
7264 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007265 values are "> " or "+++ ": >
7266 :set showbreak=>\
7267< Note the backslash to escape the trailing space. It's easier like
7268 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007269 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007270< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271 comma (in a future version the comma might be used to separate the
7272 part that is shown at the end and at the start of a line).
7273 The characters are highlighted according to the '@' flag in
7274 'highlight'.
7275 Note that tabs after the showbreak will be displayed differently.
7276 If you want the 'showbreak' to appear in between line numbers, add the
7277 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007278 A window-local value overrules a global value. If the global value is
7279 set and you want no value in the current window use NONE: >
7280 :setlocal showbreak=NONE
7281<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007283'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7284 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007286 Show (partial) command in the last line of the screen. Set this
7287 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 In Visual mode the size of the selected area is shown:
7289 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007290 If the number of bytes is different it is also displayed: "2-6"
7291 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007293 - When selecting a block, the size in screen characters:
7294 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007295 This information can be displayed in an alternative location using the
7296 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 NOTE: This option is set to the Vi default value when 'compatible' is
7298 set and to the Vim default value when 'compatible' is reset.
7299
Luuk van Baalba936f62022-12-15 13:15:39 +00007300 *'showcmdloc'* *'sloc'*
7301'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007302 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007303 This option can be used to display the (partially) entered command in
7304 another location. Possible values are:
7305 last Last line of the screen (default).
7306 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007307 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007308 Setting this option to "statusline" or "tabline" means that these will
7309 be redrawn whenever the command changes, which can be on every key
7310 pressed.
7311 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7312 place the text. Without a custom 'statusline' or 'tabline' it will be
7313 displayed in a convenient location.
7314
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7316'showfulltag' 'sft' boolean (default off)
7317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318 When completing a word in insert mode (see |ins-completion|) from the
7319 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007320 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 matched a C function, you can see a template for what arguments are
7322 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007323 Note that this doesn't work well together with having "longest" in
7324 'completeopt', because the completion from the search pattern may not
7325 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326
7327 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7328'showmatch' 'sm' boolean (default off)
7329 global
7330 When a bracket is inserted, briefly jump to the matching one. The
7331 jump is only done if the match can be seen on the screen. The time to
7332 show the match can be set with 'matchtime'.
7333 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007334 seen or not).
7335 This option is reset when 'paste' is set and restored when 'paste' is
7336 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 When the 'm' flag is not included in 'cpoptions', typing a character
7338 will immediately move the cursor back to where it belongs.
7339 See the "sm" field in 'guicursor' for setting the cursor shape and
7340 blinking when showing the match.
7341 The 'matchpairs' option can be used to specify the characters to show
7342 matches for. 'rightleft' and 'revins' are used to look for opposite
7343 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007344 Also see the matchparen plugin for highlighting the match when moving
7345 around |pi_paren.txt|.
7346 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347
7348 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7349'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7350 global
7351 If in Insert, Replace or Visual mode put a message on the last line.
7352 Use the 'M' flag in 'highlight' to set the type of highlighting for
7353 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007354 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 doesn't mean XIM is really active, especially when 'imactivatekey' is
7356 not set.
7357 NOTE: This option is set to the Vi default value when 'compatible' is
7358 set and to the Vim default value when 'compatible' is reset.
7359
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007360 *'showtabline'* *'stal'*
7361'showtabline' 'stal' number (default 1)
7362 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007363 The value of this option specifies when the line with tab page labels
7364 will be displayed:
7365 0: never
7366 1: only if there are at least two tab pages
7367 2: always
7368 This is both for the GUI and non-GUI implementation of the tab pages
7369 line.
7370 See |tab-page| for more information about tab pages.
7371
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 *'sidescroll'* *'ss'*
7373'sidescroll' 'ss' number (default 0)
7374 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 The minimal number of columns to scroll horizontally. Used only when
7376 the 'wrap' option is off and the cursor is moved off of the screen.
7377 When it is zero the cursor will be put in the middle of the screen.
7378 When using a slow terminal set it to a large number or 0. When using
7379 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7380 commands.
7381
7382 *'sidescrolloff'* *'siso'*
7383'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007384 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007386 right of the cursor if 'nowrap' is set. Setting this option to a
7387 value greater than 0 while having |'sidescroll'| also at a non-zero
7388 value makes some context visible in the line you are scrolling in
7389 horizontally (except at beginning of the line). Setting this option
7390 to a large value (like 999) has the effect of keeping the cursor
7391 horizontally centered in the window, as long as one does not come too
7392 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007393 After using the local value, go back the global value with one of
7394 these two: >
7395 setlocal sidescrolloff<
7396 setlocal sidescrolloff=-1
7397< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398
7399 Example: Try this together with 'sidescroll' and 'listchars' as
7400 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007401 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402
7403 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7404 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007405<
7406 *'signcolumn'* *'scl'*
7407'signcolumn' 'scl' string (default "auto")
7408 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007409 {not available when compiled without the |+signs|
7410 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007411 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007412 "auto" only when there is a sign to display
7413 "no" never
7414 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007415 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007416 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417
7418
7419 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7420'smartcase' 'scs' boolean (default off)
7421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 Override the 'ignorecase' option if the search pattern contains upper
7423 case characters. Only used when the search pattern is typed and
7424 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007425 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7427 recalling the search pattern from history and hitting <Enter>.
7428 NOTE: This option is reset when 'compatible' is set.
7429
7430 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7431'smartindent' 'si' boolean (default off)
7432 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 Do smart autoindenting when starting a new line. Works for C-like
7434 programs, but can also be used for other languages. 'cindent' does
7435 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007436 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007437 setting 'si' has no effect. 'indentexpr' is a more advanced
7438 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 Normally 'autoindent' should also be on when using 'smartindent'.
7440 An indent is automatically inserted:
7441 - After a line ending in '{'.
7442 - After a line starting with a keyword from 'cinwords'.
7443 - Before a line starting with '}' (only with the "O" command).
7444 When typing '}' as the first character in a new line, that line is
7445 given the same indent as the matching '{'.
7446 When typing '#' as the first character in a new line, the indent for
7447 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007448 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7450 When using the ">>" command, lines starting with '#' are not shifted
7451 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007452 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007453 This option is reset when 'paste' is set and restored when 'paste' is
7454 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455
7456 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7457'smarttab' 'sta' boolean (default off)
7458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007460 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7461 <BS> will delete a 'shiftwidth' worth of space at the start of the
7462 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007463 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007464 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7465 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007466 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007468 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007469 This option is reset when 'paste' is set and restored when 'paste' is
7470 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 NOTE: This option is reset when 'compatible' is set.
7472
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007473 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7474'smoothscroll' 'sms' boolean (default off)
7475 local to window
7476 Scrolling works with screen lines. When 'wrap' is set and the first
7477 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007478 above the window. "<<<" is displayed at the start of the first line,
7479 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007480 You may also want to add "lastline" to the 'display' option to show as
7481 much of the last line as possible.
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007482 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
7483 and scrolling with the mouse.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007484
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 *'softtabstop'* *'sts'*
7486'softtabstop' 'sts' number (default 0)
7487 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 Number of spaces that a <Tab> counts for while performing editing
7489 operations, like inserting a <Tab> or using <BS>. It "feels" like
7490 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7491 used. This is useful to keep the 'ts' setting at its standard value
7492 of 8, while being able to edit like it is set to 'sts'. However,
7493 commands like "x" still work on the actual characters.
7494 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007495 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007496 'softtabstop' is set to 0 when the 'paste' option is set and restored
7497 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7499 spaces is minimized by using <Tab>s.
7500 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7501 set.
7502 NOTE: This option is set to 0 when 'compatible' is set.
7503
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007504 If Vim is compiled with the |+vartabs| feature then the value of
7505 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7506 anything other than an empty string.
7507
Bram Moolenaar217ad922005-03-20 22:37:15 +00007508 *'spell'* *'nospell'*
7509'spell' boolean (default off)
7510 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007511 {not available when compiled without the |+syntax|
7512 feature}
7513 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007514 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007515
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007516 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007517'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007518 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007519 {not available when compiled without the |+syntax|
7520 feature}
7521 Pattern to locate the end of a sentence. The following word will be
7522 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007523 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007524 When this check is not wanted make this option empty.
7525 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007526 Be careful with special characters, see |option-backslash| about
7527 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007528 To set this option automatically depending on the language, see
7529 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007530
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007531 *'spellfile'* *'spf'*
7532'spellfile' 'spf' string (default empty)
7533 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007534 {not available when compiled without the |+syntax|
7535 feature}
7536 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007537 commands. It must end in ".{encoding}.add". You need to include the
7538 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007539 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007540 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007541 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007542 |zg| and |zw| commands can be used to access each. This allows using
7543 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007544 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007545 you: Using the first directory in 'runtimepath' that is writable. If
7546 there is no "spell" directory yet it will be created. For the file
7547 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007548 ignoring the region.
7549 The resulting ".spl" file will be used for spell checking, it does not
7550 have to appear in 'spelllang'.
7551 Normally one file is used for all regions, but you can add the region
7552 name if you want to. However, it will then only be used when
7553 'spellfile' is set to it, for entries in 'spelllang' only files
7554 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007555 This option cannot be set from a |modeline| or in the |sandbox|, for
7556 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007557
Bram Moolenaar217ad922005-03-20 22:37:15 +00007558 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007559'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007560 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007561 {not available when compiled without the |+syntax|
7562 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007563 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007564 on spellchecking will be done for these languages. Example: >
7565 set spelllang=en_us,nl,medical
7566< This means US English, Dutch and medical words are recognized. Words
7567 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007568 The word list name must consist of alphanumeric characters, a dash or
7569 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007570 recommended to separate the two letter language name from a
7571 specification. Thus "en-rare" is used for rare English words.
7572 A region name must come last and have the form "_xx", where "xx" is
7573 the two-letter, lower case region name. You can use more than one
7574 region by listing them: "en_us,en_ca" supports both US and Canadian
7575 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007576 Britain. (Note: currently en_au and en_nz dictionaries are older than
7577 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007578 If the name "cjk" is included East Asian characters are excluded from
7579 spell checking. This is useful when editing text that also has Asian
7580 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007581 Note that the "medical" dictionary does not exist, it is just an
7582 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007583 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007584 As a special case the name of a .spl file can be given as-is. The
7585 first "_xx" in the name is removed and used as the region name
7586 (_xx is an underscore, two letters and followed by a non-letter).
7587 This is mainly for testing purposes. You must make sure the correct
7588 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007589 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007590 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7591 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007592 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007593
Bram Moolenaar98692072006-02-04 00:57:42 +00007594 If the |spellfile.vim| plugin is active and you use a language name
7595 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7596 will ask you if you want to download the file.
7597
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007598 After this option has been set successfully, Vim will source the files
7599 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007600 up to the first character that is not an ASCII letter or number and
7601 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007602
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007603 *'spelloptions'* *'spo'*
7604'spelloptions' 'spo' string (default "")
7605 local to buffer
7606 {not available when compiled without the |+syntax|
7607 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007608 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007609 camel When a word is CamelCased, assume "Cased" is a
7610 separate word: every upper-case character in a word
7611 that comes after a lower case character indicates the
7612 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007613
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007614 *'spellsuggest'* *'sps'*
7615'spellsuggest' 'sps' string (default "best")
7616 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007617 {not available when compiled without the |+syntax|
7618 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007619 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007620 the |spellsuggest()| function. This is a comma-separated list of
7621 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007622
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007623 best Internal method that works best for English. Finds
7624 changes like "fast" and uses a bit of sound-a-like
7625 scoring to improve the ordering.
7626
7627 double Internal method that uses two methods and mixes the
7628 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007629 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007630 word. That only works when the language specifies
7631 sound folding. Can be slow and doesn't always give
7632 better results.
7633
7634 fast Internal method that only checks for simple changes:
7635 character inserts/deletes/swaps. Works well for
7636 simple typing mistakes.
7637
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007638 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007639 Not used for |spellsuggest()|. The number of
7640 suggestions is never more than the value of 'lines'
7641 minus two.
7642
Bram Moolenaar585ee072022-01-29 11:22:17 +00007643 timeout:{millisec} Limit the time searching for suggestions to
7644 {millisec} milli seconds. Applies to the following
7645 methods. When omitted the limit is 5000. When
7646 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007647 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007648
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007649 file:{filename} Read file {filename}, which must have two columns,
7650 separated by a slash. The first column contains the
7651 bad word, the second column the suggested good word.
7652 Example:
7653 theribal/terrible ~
7654 Use this for common mistakes that do not appear at the
7655 top of the suggestion list with the internal methods.
7656 Lines without a slash are ignored, use this for
7657 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007658 The word in the second column must be correct,
7659 otherwise it will not be used. Add the word to an
7660 ".add" file if it is currently flagged as a spelling
7661 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007662 The file is used for all languages.
7663
7664 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007665 trouble with spaces. Best is to call a function
7666 without arguments, see |expr-option-function|.
7667 |v:val| holds the badly spelled word. The expression
7668 must evaluate to a List of Lists, each with a
7669 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007670 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007671 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007672 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007673 internal methods use. A lower score is better.
7674 This may invoke |spellsuggest()| if you temporarily
7675 set 'spellsuggest' to exclude the "expr:" part.
7676 Errors are silently ignored, unless you set the
7677 'verbose' option to a non-zero value.
7678
7679 Only one of "best", "double" or "fast" may be used. The others may
7680 appear several times in any order. Example: >
7681 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7682<
7683 This option cannot be set from a |modeline| or in the |sandbox|, for
7684 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007685
7686
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7688'splitbelow' 'sb' boolean (default off)
7689 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 When on, splitting a window will put the new window below the current
7691 one. |:split|
7692
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007693 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007694'splitkeep' 'spk' string (default "cursor")
7695 global
7696 The value of this option determines the scroll behavior when opening,
7697 closing or resizing horizontal splits.
7698
7699 Possible values are:
7700 cursor Keep the same relative cursor position.
7701 screen Keep the text on the same screen line.
7702 topline Keep the topline the same.
7703
7704 For the "screen" and "topline" values, the cursor position will be
7705 changed when necessary. In this case, the jumplist will be populated
7706 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007707 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007708
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7710'splitright' 'spr' boolean (default off)
7711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 When on, splitting a window will put the new window right of the
7713 current one. |:vsplit|
7714
7715 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7716'startofline' 'sol' boolean (default on)
7717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007719 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007720 (if possible). This applies to the commands:
7721 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7722 - "d", "<<" and ">>" with a linewise operator
7723 - "%" with a count
7724 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7725 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 In case of buffer changing commands the cursor is placed at the column
7727 where it was the last time the buffer was edited.
7728 NOTE: This option is set when 'compatible' is set.
7729
Bram Moolenaar00654022011-02-25 14:42:19 +01007730 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007732 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 {not available when compiled without the |+statusline|
7734 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007735 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736 Also see |status-line|.
7737
7738 The option consists of printf style '%' items interspersed with
7739 normal text. Each status line item is of the form:
7740 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007741 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007742 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743
Bram Moolenaar238a5642006-02-21 22:12:05 +00007744 When the option starts with "%!" then it is used as an expression,
7745 evaluated and the result is used as the option value. Example: >
7746 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007747< The *g:statusline_winid* variable will be set to the |window-ID| of the
7748 window that the status line belongs to.
7749 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007750 Note that the "%!" expression is evaluated in the context of the
7751 current window and buffer, while %{} items are evaluated in the
7752 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007753
7754 When there is error while evaluating the option then it will be made
7755 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007756 When the result contains unprintable characters the result is
7757 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007758
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759 Note that the only effect of 'ruler' when this option is set (and
7760 'laststatus' is 2) is controlling the output of |CTRL-G|.
7761
7762 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007763 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007765 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766 minwid Minimum width of the item, padding as set by '-' & '0'.
7767 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007768 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769 on the left for text items. Numeric items will be
7770 shifted down to maxwid-2 digits followed by '>'number
7771 where number is the amount of missing digits, much like
7772 an exponential notation.
7773 item A one letter code as described below.
7774
7775 Following is a description of the possible statusline items. The
7776 second character in "item" is the type:
7777 N for number
7778 S for string
7779 F for flags as described below
7780 - not applicable
7781
7782 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007783 f S Path to the file in the buffer, as typed or relative to current
7784 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 F S Full path to the file in the buffer.
7786 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007787 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007789 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007791 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007792 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007793 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007795 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007797 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7799 being used: "<keymap>"
7800 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007801 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 B N As above, in hexadecimal.
7803 o N Byte number in file of byte under cursor, first byte is 1.
7804 Mnemonic: Offset from start of file (with one added)
7805 {not available when compiled without |+byte_offset| feature}
7806 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007807 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 l N Line number.
7809 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007810 c N Column number (byte index).
7811 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007812 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007813 p N Percentage through file in lines as in |CTRL-G|.
7814 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007815 percentage described for 'ruler'. Always 3 in length, unless
7816 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007817 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007818 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007820 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007821 Note that there is no '%' before the closing '}'. The
7822 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007823 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007824 {% - This is almost same as { except the result of the expression is
7825 re-evaluated as a statusline format string. Thus if the
7826 return value of expr contains % items they will get expanded.
7827 The expression can contain the } character, the end of
7828 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007829 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007830 func! Stl_filename() abort
7831 return "%t"
7832 endfunc
7833< `stl=%{Stl_filename()}` results in `"%t"`
7834 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007835 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836 ( - Start of item group. Can be used for setting the width and
7837 alignment of a section. Must be followed by %) somewhere.
7838 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007839 T N For 'tabline': start of tab page N label. Use %T after the last
7840 label. This information is used for mouse clicks.
7841 X N For 'tabline': start of close tab N label. Use %X after the
7842 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7843 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007844 < - Where to truncate line if too long. Default is at the start.
7845 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007846 = - Separation point between alignment sections. Each section will
7847 be separated by an equal number of spaces. With one %= what
7848 comes after it will be right-aligned. With two %= there is a
7849 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007851 # - Set highlight group. The name must follow and then a # again.
7852 Thus use %#HLname# for highlight group HLname. The same
7853 highlighting is used, also for the statusline of non-current
7854 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007856 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007857 The difference between User{N} and StatusLine will be applied to
7858 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 The number N must be between 1 and 9. See |hl-User1..9|
7860
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007861 When displaying a flag, Vim removes the leading comma, if any, when
7862 that flag comes right after plaintext. This will make a nice display
7863 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864
Bram Moolenaar582fd852005-03-28 20:58:01 +00007865 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866 not set) and a minwid is not set for the group, the whole group will
7867 become empty. This will make a group like the following disappear
7868 completely from the statusline when none of the flags are set. >
7869 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007870< Beware that an expression is evaluated each and every time the status
7871 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007872 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007873 While evaluating %{} the current buffer and current window will be set
7874 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007875 currently being drawn. The expression will evaluate in this context.
7876 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7877 real current buffer and "g:actual_curwin" to the |window-ID| of the
7878 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007879
Bram Moolenaar30b65812012-07-12 22:01:11 +02007880 The 'statusline' option will be evaluated in the |sandbox| if set from
7881 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007882 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007883
7884 It is not allowed to change text or jump to another window while
7885 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886
7887 If the statusline is not updated when you want it (e.g., after setting
7888 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007889 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007891 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 Otherwise the result is taken as flag text and applied to the rules
7893 described above.
7894
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007895 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007897 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898
7899 Examples:
7900 Emulate standard status line with 'ruler' set >
7901 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7902< Similar, but add ASCII value of char under the cursor (like "ga") >
7903 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7904< Display byte count and byte value, modified flag in red. >
7905 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7906 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7907< Display a ,GZ flag if a compressed file is loaded >
7908 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7909< In the |:autocmd|'s: >
7910 :let b:gzflag = 1
7911< And: >
7912 :unlet b:gzflag
7913< And define this function: >
7914 :function VarExists(var, val)
7915 : if exists(a:var) | return a:val | else | return '' | endif
7916 :endfunction
7917<
7918 *'suffixes'* *'su'*
7919'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921 Files with these suffixes get a lower priority when multiple files
7922 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007923 suffixes. Spaces after the comma are ignored. A dot is also seen as
7924 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 separator, precede it with a backslash (see |option-backslash| about
7926 including spaces and backslashes).
7927 See 'wildignore' for completely ignoring files.
7928 The use of |:set+=| and |:set-=| is preferred when adding or removing
7929 suffixes from the list. This avoids problems when a future version
7930 uses another default.
7931
7932 *'suffixesadd'* *'sua'*
7933'suffixesadd' 'sua' string (default "")
7934 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007935 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 file for the "gf", "[I", etc. commands. Example: >
7937 :set suffixesadd=.java
7938<
7939 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7940'swapfile' 'swf' boolean (default on)
7941 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007942 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 swapfile is not wanted for a specific buffer. For example, with
7944 confidential information that even root must not be able to access.
7945 Careful: All text will be in memory:
7946 - Don't use this for big files.
7947 - Recovery will be impossible!
7948 A swapfile will only be present when |'updatecount'| is non-zero and
7949 'swapfile' is set.
7950 When 'swapfile' is reset, the swap file for the current buffer is
7951 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7952 non-zero, a swap file is immediately created.
7953 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007954 If you want to open a new buffer without creating a swap file for it,
7955 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007956 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957
7958 This option is used together with 'bufhidden' and 'buftype' to
7959 specify special kinds of buffers. See |special-buffers|.
7960
7961 *'swapsync'* *'sws'*
7962'swapsync' 'sws' string (default "fsync")
7963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007965 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 When this option is empty parts of the swap file may be in memory and
7967 not written to disk. When the system crashes you may lose more work.
7968 On Unix the system does a sync now and then without Vim asking for it,
7969 so the disadvantage of setting this option off is small. On some
7970 systems the swap file will not be written at all. For a unix system
7971 setting it to "sync" will use the sync() call instead of the default
7972 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007973 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974
7975 *'switchbuf'* *'swb'*
7976'switchbuf' 'swb' string (default "")
7977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01007979 This option is checked, when
7980 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
7981 etc.)
7982 - jumping to a tag using the |:stag| command.
7983 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
7984 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
7985 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007986 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01007987 useopen If included, jump to the first open window in the
7988 current tab page that contains the specified buffer
7989 (if there is one). Otherwise: Do not examine other
7990 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007991 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007992 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007994 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007995 Otherwise: do not split, use current window (when used
7996 in the quickfix window: the previously used window or
7997 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007998 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007999 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008000 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008001 uselast If included, jump to the previously used window when
8002 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008004 *'synmaxcol'* *'smc'*
8005'synmaxcol' 'smc' number (default 3000)
8006 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008007 {not available when compiled without the |+syntax|
8008 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008009 Maximum column in which to search for syntax items. In long lines the
8010 text after this column is not highlighted and following lines may not
8011 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008012 This helps to avoid very slow redrawing for an XML file that is one
8013 long line.
8014 Set to zero to remove the limit.
8015
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 *'syntax'* *'syn'*
8017'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008018 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 {not available when compiled without the |+syntax|
8020 feature}
8021 When this option is set, the syntax with this name is loaded, unless
8022 syntax highlighting has been switched off with ":syntax off".
8023 Otherwise this option does not always reflect the current syntax (the
8024 b:current_syntax variable does).
8025 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008026 not automatically recognized. Example, in an IDL file:
8027 /* vim: set syntax=idl : */ ~
8028 When a dot appears in the value then this separates two filetype
8029 names. Example:
8030 /* vim: set syntax=c.doxygen : */ ~
8031 This will use the "c" syntax first, then the "doxygen" syntax.
8032 Note that the second one must be prepared to be loaded as an addition,
8033 otherwise it will be skipped. More than one dot may appear.
8034 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 :set syntax=OFF
8036< To switch syntax highlighting on according to the current value of the
8037 'filetype' option: >
8038 :set syntax=ON
8039< What actually happens when setting the 'syntax' option is that the
8040 Syntax autocommand event is triggered with the value as argument.
8041 This option is not copied to another buffer, independent of the 's' or
8042 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008043 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008045 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008046'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008047 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008048 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008049 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008050 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008051
8052 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008053 option and only when there is no GUI tab line. When 'e' is in
8054 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008055 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008056
8057 The value is evaluated like with 'statusline'. You can use
8058 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008059 the text to be displayed. Use "%1T" for the first label, "%2T" for
8060 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008061
Bram Moolenaare12bab32019-01-08 22:02:56 +01008062 When changing something that is used in 'tabline' that does not
8063 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008064 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008065
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008066 Keep in mind that only one of the tab pages is the current one, others
8067 are invisible and you can't jump to their windows.
8068
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008069
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008070 *'tabpagemax'* *'tpm'*
8071'tabpagemax' 'tpm' number (default 10)
8072 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008073 Maximum number of tab pages to be opened by the |-p| command line
8074 argument or the ":tab all" command. |tabpage|
8075
8076
8077 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078'tabstop' 'ts' number (default 8)
8079 local to buffer
8080 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008081 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082
8083 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008084 appear wrong in many places, e.g., when printing it.
8085 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086
8087 There are four main ways to use tabs in Vim:
8088 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8089 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008090 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008092 This is the recommended way, the file will look the same with other
8093 tools and when listing it in a terminal.
8094 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8095 'expandtab'. This way you will always insert spaces. The
8096 formatting will never be messed up when 'tabstop' is changed (leave
8097 it at 8 just in case). The file will be a bit larger.
8098 You do need to check if no Tabs exist in the file. You can get rid
8099 of them by first setting 'expandtab' and using `%retab!`, making
8100 sure the value of 'tabstop' is set correctly.
8101 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102 'expandtab'. This way you will always insert spaces. The
8103 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008104 You do need to check if no Tabs exist in the file, just like in the
8105 item just above.
8106 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008107 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008108 works when using Vim to edit the file, other tools assume a tabstop
8109 is worth 8 spaces.
8110 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008111 'noexpandtab'. This should then work (for initial indents only)
8112 for any tabstop setting that people use. It might be nice to have
8113 tabs after the first non-blank inserted as spaces if you do this
8114 though. Otherwise aligned comments will be wrong when 'tabstop' is
8115 changed.
8116
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008117 If Vim is compiled with the |+vartabs| feature then the value of
8118 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8119 than an empty string.
8120
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8122'tagbsearch' 'tbs' boolean (default on)
8123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008125 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126 searching makes searching for a tag a LOT faster, but a linear search
8127 will find more tags if the tags file wasn't properly sorted.
8128 Vim normally assumes that your tags files are sorted, or indicate that
8129 they are not sorted. Only when this is not the case does the
8130 'tagbsearch' option need to be switched off.
8131
8132 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008133 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008134 certain files, or retry all files with a linear search. When
8135 'tagbsearch' is off, only a linear search is done.
8136
8137 Linear searching is done anyway, for one file, when Vim finds a line
8138 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008139 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140< [The whitespace before and after the '0' must be a single <Tab>]
8141
8142 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008143 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 instead of a normal tag name, a retry is done with a linear search.
8145 Tags in unsorted tags files, and matches with different case will only
8146 be found in the retry.
8147
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008148 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008149 linear search can be avoided when case is ignored. Use a value of '2'
8150 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8151 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008152 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8153 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8154 used for this as well. Note that case must be folded to uppercase for
8155 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008156
8157 By default, tag searches are case-sensitive. Case is ignored when
8158 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8159 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008160 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8161 'tagcase' is "smart", and the pattern contains only lowercase
8162 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163
8164 When 'tagbsearch' is off, tags searching is slower when a full match
8165 exists, but faster when no full match exists. Tags in unsorted tags
8166 files may only be found with 'tagbsearch' off.
8167 When the tags file is not sorted, or sorted in a wrong way (not on
8168 ASCII byte value), 'tagbsearch' should be off, or the line given above
8169 must be included in the tags file.
8170 This option doesn't affect commands that find all matching tags (e.g.,
8171 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008173 *'tagcase'* *'tc'*
8174'tagcase' 'tc' string (default "followic")
8175 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008176 This option specifies how case is handled when searching the tags
8177 file:
8178 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008179 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008180 ignore Ignore case
8181 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008182 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008183 NOTE: This option is set to the Vi default value when 'compatible' is
8184 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008185
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008186 *'tagfunc'* *'tfu'*
8187'tagfunc' 'tfu' string (default: empty)
8188 local to buffer
8189 {not available when compiled without the |+eval|
8190 feature}
8191 This option specifies a function to be used to perform tag searches.
8192 The function gets the tag pattern and should return a List of matching
8193 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008194 function and an example. The value can be the name of a function, a
8195 |lambda| or a |Funcref|. See |option-value-function| for more
8196 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008197
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 *'taglength'* *'tl'*
8199'taglength' 'tl' number (default 0)
8200 global
8201 If non-zero, tags are significant up to this number of characters.
8202
8203 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8204'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8205 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008206 If on and using a tags file in another directory, file names in that
8207 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 NOTE: This option is set to the Vi default value when 'compatible' is
8209 set and to the Vim default value when 'compatible' is reset.
8210
8211 *'tags'* *'tag'* *E433*
8212'tags' 'tag' string (default "./tags,tags", when compiled with
8213 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8214 global or local to buffer |global-local|
8215 Filenames for the tag command, separated by spaces or commas. To
8216 include a space or comma in a file name, precede it with a backslash
8217 (see |option-backslash| about including spaces and backslashes).
8218 When a file name starts with "./", the '.' is replaced with the path
8219 of the current file. But only when the 'd' flag is not included in
8220 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8221 |tags-option|.
8222 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008223 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8224 find all files named "tags" below "/lib". The filename itself cannot
8225 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008226 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008227 The |tagfiles()| function can be used to get a list of the file names
8228 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8230 files are also supported. They are automatically recognized. The
8231 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8232 differences are ignored (MS-Windows). |emacs-tags|
8233 The use of |:set+=| and |:set-=| is preferred when adding or removing
8234 file names from the list. This avoids problems when a future version
8235 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236
8237 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8238'tagstack' 'tgst' boolean (default on)
8239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 When on, the |tagstack| is used normally. When off, a ":tag" or
8241 ":tselect" command with an argument will not push the tag onto the
8242 tagstack. A following ":tag" without an argument, a ":pop" command or
8243 any other command that uses the tagstack will use the unmodified
8244 tagstack, but does change the pointer to the active entry.
8245 Resetting this option is useful when using a ":tag" command in a
8246 mapping which should not change the tagstack.
8247
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008248 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008249'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008250 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008251 {only available when compiled with the |+tcl/dyn|
8252 feature}
8253 Specifies the name of the Tcl shared library. The default is
8254 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008255 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008256 This option cannot be set from a |modeline| or in the |sandbox|, for
8257 security reasons.
8258
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 *'term'* *E529* *E530* *E531*
8260'term' string (default is $TERM, if that fails:
8261 in the GUI: "builtin_gui"
8262 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008263 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 on Unix: "ansi"
8266 on VMS: "ansi"
8267 on Win 32: "win32")
8268 global
8269 Name of the terminal. Used for choosing the terminal control
8270 characters. Environment variables are expanded |:set_env|.
8271 For example: >
8272 :set term=$TERM
8273< See |termcap|.
8274
8275 *'termbidi'* *'tbidi'*
8276 *'notermbidi'* *'notbidi'*
8277'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 {only available when compiled with the |+arabic|
8280 feature}
8281 The terminal is in charge of Bi-directionality of text (as specified
8282 by Unicode). The terminal is also expected to do the required shaping
8283 that some languages (such as Arabic) require.
8284 Setting this option implies that 'rightleft' will not be set when
8285 'arabic' is set and the value of 'arabicshape' will be ignored.
8286 Note that setting 'termbidi' has the immediate effect that
8287 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8288 This option is reset when the GUI is started.
8289 For further details see |arabic.txt|.
8290
8291 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008292'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 Encoding used for the terminal. This specifies what character
8295 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008296 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008297 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008298 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008299 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8301 Any attempts to set a different value will be rejected, and an error
8302 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008303 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 because the Win32 system always passes Unicode characters.
8305 When empty, the same encoding is used as for the 'encoding' option.
8306 This is the normal value.
8307 Not all combinations for 'termencoding' and 'encoding' are valid. See
8308 |encoding-table|.
8309 The value for this option must be supported by internal conversions or
8310 iconv(). When this is not possible no conversion will be done and you
8311 will probably experience problems with non-ASCII characters.
8312 Example: You are working with the locale set to euc-jp (Japanese) and
8313 want to edit a UTF-8 file: >
8314 :let &termencoding = &encoding
8315 :set encoding=utf-8
8316< You need to do this when your system has no locale support for UTF-8.
8317
Bram Moolenaar938ae282023-02-20 20:44:55 +00008318 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008319'termguicolors' 'tgc' boolean (default off)
8320 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008321 {not available when compiled without the
8322 |+termguicolors| feature}
8323 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008324 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008325
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008326 Requires a ISO-8613-3 compatible terminal. If setting this option
8327 does not work (produces a colorless UI) reading |xterm-true-color|
8328 might help.
8329
8330 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8331 is required. Use this check to find out: >
8332 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008333< This requires Vim to be built with the |+vtp| feature.
8334
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008335 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008336
8337 When using Vim with Windows Terminal, the background of Windows
8338 Terminal is normally filled with the Vim background color. Setting
8339 'termguicolors' and the guibg of the Normal highlight group to NONE
8340 will make the background transparent: >
8341 :hi Normal guibg=NONE
8342<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008343 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008344
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008345 *'termwinkey'* *'twk'*
8346'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008347 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008348 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008349 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008350 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008351 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008352< The string must be one key stroke but can be multiple bytes.
8353 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008354 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008355 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008356
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008357 *'termwinscroll'* *'twsl'*
8358'termwinscroll' 'twsl' number (default 10000)
8359 local to buffer
8360 {not available when compiled without the
8361 |+terminal| feature}
8362 Number of scrollback lines to keep. When going over this limit the
8363 first 10% of the scrollback lines are deleted. This is just to reduce
8364 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008365 Also used as a limit for text sent to the terminal in one write,
8366 multiplied by the number of columns times 3 (average number of bytes
8367 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008368
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008369 *'termwinsize'* *'tws'*
8370'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008371 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008372 Size used when opening the |terminal| window. Format:
8373 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008374 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008375 - When set with a "x" (e.g., "24x80") the terminal size is not
8376 adjusted to the window size. If the window is smaller only the
8377 top-left part is displayed.
8378 - When set with a "*" (e.g., "10*50") the terminal size follows the
8379 window size, but will not be smaller than the specified rows and/or
8380 columns.
8381 - When rows is zero then use the height of the window.
8382 - When columns is zero then use the width of the window.
8383 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008384 - Can be overruled in the |term_start()| options with "term_rows" and
8385 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008386
8387 Examples:
8388 "30x0" uses 30 rows and the current window width.
8389 "20*0" uses at least 20 rows and the current window width.
8390 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008391 Note that the command running in the terminal window may still change
8392 the size of the terminal. In that case the Vim window will be
8393 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008394
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008395 *'termwintype'* *'twt'*
8396'termwintype' 'twt' string (default "")
8397 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008398 {only available when compiled with the |terminal|
8399 feature on MS-Windows}
8400 Specify the virtual console (pty) used when opening the terminal
8401 window.
8402
8403 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008404 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008405 "winpty" use winpty, fail if not supported
8406 "conpty" use |ConPTY|, fail if not supported
8407
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008408 |ConPTY| support depends on the platform. Windows 10 October 2018
8409 Update is the first version that supports ConPTY, however it is still
8410 considered unstable. ConPTY might become stable in the next release
8411 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008412 supported then you cannot open a terminal window.
8413
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 *'terse'* *'noterse'*
8415'terse' boolean (default off)
8416 global
8417 When set: Add 's' flag to 'shortmess' option (this makes the message
8418 for a search that hits the start or end of the file not being
8419 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8420 shortens a lot of messages}
8421
8422 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8423'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8424 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 This option is obsolete. Use 'fileformats'.
8426 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8427 set to the default value for the current system. When 'textauto' is
8428 reset, 'fileformats' is made empty.
8429 NOTE: This option is set to the Vi default value when 'compatible' is
8430 set and to the Vim default value when 'compatible' is reset.
8431
8432 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008433'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 others: default off)
8435 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 This option is obsolete. Use 'fileformat'.
8437 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8438 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8439 "unix".
8440
8441 *'textwidth'* *'tw'*
8442'textwidth' 'tw' number (default 0)
8443 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 Maximum width of text that is being inserted. A longer line will be
8445 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008446 this.
8447 'textwidth' is set to 0 when the 'paste' option is set and restored
8448 when 'paste' is reset.
8449 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008451 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 NOTE: This option is set to 0 when 'compatible' is set.
8453
8454 *'thesaurus'* *'tsr'*
8455'thesaurus' 'tsr' string (default "")
8456 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008457 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008458 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8459 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008460
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008461 This option is not used if 'thesaurusfunc' is set, either for the
8462 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008463
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008464 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008466 name. See |option-backslash| about using backslashes. The use of
8467 |:set+=| and |:set-=| is preferred when adding or removing directories
8468 from the list. This avoids problems when a future version uses
8469 another default. Backticks cannot be used in this option for security
8470 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008472 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008473'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008474 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008475 {not available when compiled without the |+eval|
8476 feature}
8477 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008478 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008479 The value can be the name of a function, a |lambda| or a |Funcref|.
8480 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008481
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008482 This option cannot be set from a |modeline| or in the |sandbox|, for
8483 security reasons.
8484
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8486'tildeop' 'top' boolean (default off)
8487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488 When on: The tilde command "~" behaves like an operator.
8489 NOTE: This option is reset when 'compatible' is set.
8490
8491 *'timeout'* *'to'* *'notimeout'* *'noto'*
8492'timeout' 'to' boolean (default on)
8493 global
8494 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008495'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 These two options together determine the behavior when part of a
8498 mapped key sequence or keyboard code has been received:
8499
8500 'timeout' 'ttimeout' action ~
8501 off off do not time out
8502 on on or off time out on :mappings and key codes
8503 off on time out on key codes
8504
8505 If both options are off, Vim will wait until either the complete
8506 mapping or key sequence has been received, or it is clear that there
8507 is no mapping or key sequence for the received characters. For
8508 example: if you have mapped "vl" and Vim has received 'v', the next
8509 character is needed to see if the 'v' is followed by an 'l'.
8510 When one of the options is on, Vim will wait for about 1 second for
8511 the next character to arrive. After that the already received
8512 characters are interpreted as single characters. The waiting time can
8513 be changed with the 'timeoutlen' option.
8514 On slow terminals or very busy systems timing out may cause
8515 malfunctioning cursor keys. If both options are off, Vim waits
8516 forever after an entered <Esc> if there are key codes that start
8517 with <Esc>. You will have to type <Esc> twice. If you do not have
8518 problems with key codes, but would like to have :mapped key
8519 sequences not timing out in 1 second, set the 'ttimeout' option and
8520 reset the 'timeout' option.
8521
8522 NOTE: 'ttimeout' is reset when 'compatible' is set.
8523
8524 *'timeoutlen'* *'tm'*
8525'timeoutlen' 'tm' number (default 1000)
8526 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008527
Bram Moolenaar071d4272004-06-13 20:20:40 +00008528 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008529'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008531 The time in milliseconds that is waited for a key code or mapped key
8532 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8533 when part of a command has been typed.
8534 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8535 different timeout value for key codes is desired set 'ttimeoutlen' to
8536 a non-negative number.
8537
8538 ttimeoutlen mapping delay key code delay ~
8539 < 0 'timeoutlen' 'timeoutlen'
8540 >= 0 'timeoutlen' 'ttimeoutlen'
8541
8542 The timeout only happens when the 'timeout' and 'ttimeout' options
8543 tell so. A useful setting would be >
8544 :set timeout timeoutlen=3000 ttimeoutlen=100
8545< (time out on mapping after three seconds, time out on key codes after
8546 a tenth of a second).
8547
8548 *'title'* *'notitle'*
8549'title' boolean (default off, on when title can be restored)
8550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 When on, the title of the window will be set to the value of
8552 'titlestring' (if it is not empty), or to:
8553 filename [+=-] (path) - VIM
8554 Where:
8555 filename the name of the file being edited
8556 - indicates the file cannot be modified, 'ma' off
8557 + indicates the file was modified
8558 = indicates the file is read-only
8559 =+ indicates the file is read-only and modified
8560 (path) is the path of the file being edited
8561 - VIM the server name |v:servername| or "VIM"
8562 Only works if the terminal supports setting window titles
8563 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008564 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8566 *X11*
8567 When Vim was compiled with HAVE_X11 defined, the original title will
8568 be restored if possible. The output of ":version" will include "+X11"
8569 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8570 works for the icon name |'icon'|.
8571 But: When Vim was started with the |-X| argument, restoring the title
8572 will not work (except in the GUI).
8573 If the title cannot be restored, it is set to the value of 'titleold'.
8574 You might want to restore the title outside of Vim then.
8575 When using an xterm from a remote machine you can use this command:
8576 rsh machine_name xterm -display $DISPLAY &
8577 then the WINDOWID environment variable should be inherited and the
8578 title of the window should change back to what it should be after
8579 exiting Vim.
8580
8581 *'titlelen'*
8582'titlelen' number (default 85)
8583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008585 title. When the title is longer, only the end of the path name is
8586 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587 Using a percentage makes this adapt to the width of the window. But
8588 it won't work perfectly, because the actual number of characters
8589 available also depends on the font used and other things in the title
8590 bar. When 'titlelen' is zero the full path is used. Otherwise,
8591 values from 1 to 30000 percent can be used.
8592 'titlelen' is also used for the 'titlestring' option.
8593
8594 *'titleold'*
8595'titleold' string (default "Thanks for flying Vim")
8596 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 This option will be used for the window title when exiting Vim if the
8598 original title cannot be restored. Only happens if 'title' is on or
8599 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008600 This option cannot be set from a |modeline| or in the |sandbox|, for
8601 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 *'titlestring'*
8603'titlestring' string (default "")
8604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 When this option is not empty, it will be used for the title of the
8606 window. This happens only when the 'title' option is on.
8607 Only works if the terminal supports setting window titles (currently
8608 Amiga console, Win32 console, all GUI versions and terminals with a
8609 non-empty 't_ts' option).
8610 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008611 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008612
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613 When this option contains printf-style '%' items, they will be
8614 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008615 This option cannot be set in a modeline when 'modelineexpr' is off.
8616
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008618 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8620< The value of 'titlelen' is used to align items in the middle or right
8621 of the available space.
8622 Some people prefer to have the file name first: >
8623 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8624< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008625 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008626 separating space only when needed.
8627 NOTE: Use of special characters in 'titlestring' may cause the display
8628 to be garbled (e.g., when it contains a CR or NL character).
8629 {not available when compiled without the |+statusline| feature}
8630
8631 *'toolbar'* *'tb'*
8632'toolbar' 'tb' string (default "icons,tooltips")
8633 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008634 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008635 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 possible values are:
8637 icons Toolbar buttons are shown with icons.
8638 text Toolbar buttons shown with text.
8639 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008640 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 tooltips Tooltips are active for toolbar buttons.
8642 Tooltips refer to the popup help text which appears after the mouse
8643 cursor is placed over a toolbar button for a brief moment.
8644
8645 If you want the toolbar to be shown with icons as well as text, do the
8646 following: >
8647 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008648< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 will show icons if both are requested.
8650
8651 If none of the strings specified in 'toolbar' are valid or if
8652 'toolbar' is empty, this option is ignored. If you want to disable
8653 the toolbar, you need to set the 'guioptions' option. For example: >
8654 :set guioptions-=T
8655< Also see |gui-toolbar|.
8656
8657 *'toolbariconsize'* *'tbis'*
8658'toolbariconsize' 'tbis' string (default "small")
8659 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008660 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008662 tiny Use tiny icons.
8663 small Use small icons (default).
8664 medium Use medium-sized icons.
8665 large Use large icons.
8666 huge Use even larger icons.
8667 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008669 the current theme. Common dimensions are giant=48x48, huge=32x32,
8670 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671
8672 If 'toolbariconsize' is empty, the global default size as determined
8673 by user preferences or the current theme is used.
8674
8675 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8676'ttybuiltin' 'tbi' boolean (default on)
8677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008678 When on, the builtin termcaps are searched before the external ones.
8679 When off the builtin termcaps are searched after the external ones.
8680 When this option is changed, you should set the 'term' option next for
8681 the change to take effect, for example: >
8682 :set notbi term=$TERM
8683< See also |termcap|.
8684 Rationale: The default for this option is "on", because the builtin
8685 termcap entries are generally better (many systems contain faulty
8686 xterm entries...).
8687
8688 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008689'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 Indicates a fast terminal connection. More characters will be sent to
8692 the screen for redrawing, instead of using insert/delete line
8693 commands. Improves smoothness of redrawing when there are multiple
8694 windows and the terminal does not support a scrolling region.
8695 Also enables the extra writing of characters at the end of each screen
8696 line for lines that wrap. This helps when using copy/paste with the
8697 mouse in an xterm and other terminals.
8698
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008699 The default used to be set only for some terminal names, but these
8700 days nearly all terminals are fast, therefore the default is now "on".
8701 If you have a slow connection you may want to set this option off,
8702 e.g. depending on the host name: >
8703 if hostname() =~ 'faraway'
8704 set nottyfast
8705 endif
8706<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 *'ttymouse'* *'ttym'*
8708'ttymouse' 'ttym' string (default depends on 'term')
8709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 {only in Unix and VMS, doesn't work in the GUI; not
8711 available when compiled without |+mouse|}
8712 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008713 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714 *xterm-mouse*
8715 xterm xterm-like mouse handling. The mouse generates
8716 "<Esc>[Mscr", where "scr" is three bytes:
8717 "s" = button state
8718 "c" = column plus 33
8719 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008720 This only works up to 223 columns! See "dec",
8721 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 xterm2 Works like "xterm", but with the xterm reporting the
8723 mouse position while the mouse is dragged. This works
8724 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008725 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008726 work. See below for how Vim detects this
8727 automatically.
8728 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008729 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008731 for the row and column. No other mouse events are
8732 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 *dec-mouse*
8734 dec DEC terminal mouse handling. The mouse generates a
8735 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008736 This is also available for an Xterm, if it was
8737 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 *jsbterm-mouse*
8739 jsbterm JSB term mouse handling.
8740 *pterm-mouse*
8741 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008742 *urxvt-mouse*
8743 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008744 The mouse works only if the terminal supports this
8745 encoding style, but it does not have 223 columns limit
8746 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008747 *sgr-mouse*
8748 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008749 mouse reporting. The mouse works even in columns
8750 beyond 223. This option is backward compatible with
8751 "xterm2" because it can also decode "xterm2" style
8752 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753
8754 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008755 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8756 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8758 recognized, if enabled at compile time. DEC terminal mouse codes
8759 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008760 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8761 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008763 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8764 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8765 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008766 If the terminfo/termcap entry "XM" exists and the first number is
8767 "1006" then 'ttymouse' will be set to "sgr". This works for many
8768 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008769 Additionally, if vim is compiled with the |+termresponse| feature and
8770 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008771 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008773 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8774 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8775 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008776 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8777 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 :set t_RV=
8779<
8780 *'ttyscroll'* *'tsl'*
8781'ttyscroll' 'tsl' number (default 999)
8782 global
8783 Maximum number of lines to scroll the screen. If there are more lines
8784 to scroll the window is redrawn. For terminals where scrolling is
8785 very slow and redrawing is not slow this can be set to a small number,
8786 e.g., 3, to speed up displaying.
8787
8788 *'ttytype'* *'tty'*
8789'ttytype' 'tty' string (default from $TERM)
8790 global
8791 Alias for 'term', see above.
8792
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008793 *'undodir'* *'udir'*
8794'undodir' 'udir' string (default ".")
8795 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008796 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008797 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008798 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008799 "." means using the directory of the file. The undo file name for
8800 "file.txt" is ".file.txt.un~".
8801 For other directories the file name is the full path of the edited
8802 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008803 When writing: The first directory that exists is used. "." always
8804 works, no directories after "." will be used for writing.
8805 When reading all entries are tried to find an undo file. The first
8806 undo file that exists is used. When it cannot be read an error is
8807 given, no further entry is used.
8808 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008809 This option cannot be set from a |modeline| or in the |sandbox|, for
8810 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008811
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008812 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008813'undofile' 'udf' boolean (default off)
8814 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008815 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008816 When on, Vim automatically saves undo history to an undo file when
8817 writing a buffer to a file, and restores undo history from the same
8818 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008819 The directory where the undo file is stored is specified by 'undodir'.
8820 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008821 The undo file is not read when 'undoreload' causes the buffer from
8822 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008823 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008824 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008825
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008827'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008828 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008829 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008830 is kept in memory, higher numbers will cause more memory to be used.
8831 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8833 itself: >
8834 set ul=0
8835< But you can also get Vi compatibility by including the 'u' flag in
8836 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008837 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008838 Set to -1 for no undo at all. You might want to do this only for the
8839 current buffer: >
8840 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008841< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008842
8843 The local value is set to -123456 when the global value is to be used.
8844
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008845 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008847 *'undoreload'* *'ur'*
8848'undoreload' 'ur' number (default 10000)
8849 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008850 Save the whole buffer for undo when reloading it. This applies to the
8851 ":e!" command and reloading for when the buffer changed outside of
8852 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008853 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008854 of lines is smaller than the value of this option.
8855 Set this option to zero to disable undo for a reload.
8856
8857 When saving undo for a reload, any undo file is not read.
8858
8859 Note that this causes the whole buffer to be stored in memory. Set
8860 this option to a lower value if you run out of memory.
8861
Bram Moolenaar071d4272004-06-13 20:20:40 +00008862 *'updatecount'* *'uc'*
8863'updatecount' 'uc' number (default: 200)
8864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008865 After typing this many characters the swap file will be written to
8866 disk. When zero, no swap file will be created at all (see chapter on
8867 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8868 Vim with the "-n" option, see |startup|. When editing in readonly
8869 mode this option will be initialized to 10000.
8870 The swapfile can be disabled per buffer with |'swapfile'|.
8871 When 'updatecount' is set from zero to non-zero, swap files are
8872 created for all buffers that have 'swapfile' set. When 'updatecount'
8873 is set to zero, existing swap files are not deleted.
8874 Also see |'swapsync'|.
8875 This option has no meaning in buffers where |'buftype'| is "nofile"
8876 or "nowrite".
8877
8878 *'updatetime'* *'ut'*
8879'updatetime' 'ut' number (default 4000)
8880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008881 If this many milliseconds nothing is typed the swap file will be
8882 written to disk (see |crash-recovery|). Also used for the
8883 |CursorHold| autocommand event.
8884
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008885 *'varsofttabstop'* *'vsts'*
8886'varsofttabstop' 'vsts' string (default "")
8887 local to buffer
8888 {only available when compiled with the |+vartabs|
8889 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008890 A list of the number of spaces that a <Tab> counts for while editing,
8891 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8892 width <Tab>s are being inserted, while in fact a mixture of spaces
8893 and <Tab>s is used. Tab widths are separated with commas, with the
8894 final value applying to all subsequent tabs.
8895
8896 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008897 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008898 to use the following: >
8899 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008900< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8901 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008902
8903 Note that the value of |'softtabstop'| will be ignored while
8904 'varsofttabstop' is set.
8905
8906 *'vartabstop'* *'vts'*
8907'vartabstop' 'vts' string (default "")
8908 local to buffer
8909 {only available when compiled with the |+vartabs|
8910 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008911 A list of the number of spaces that a <Tab> in the file counts for,
8912 separated by commas. Each value corresponds to one tab, with the
8913 final value applying to all subsequent tabs. For example: >
8914 :set vartabstop=4,20,10,8
8915< This will make the first tab 4 spaces wide, the second 20 spaces,
8916 the third 10 spaces, and all following tabs 8 spaces.
8917
8918 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8919 is set.
8920
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 *'verbose'* *'vbs'*
8922'verbose' 'vbs' number (default 0)
8923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 When bigger than zero, Vim will give messages about what it is doing.
8925 Currently, these messages are given:
8926 >= 1 When the viminfo file is read or written.
8927 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008928 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008929 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 >= 8 Files for which a group of autocommands is executed.
8931 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008932 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 >= 12 Every executed function.
8934 >= 13 When an exception is thrown, caught, finished, or discarded.
8935 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008936 >= 15 Every executed Ex command from a script (truncated at 200
8937 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008938 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939
8940 This option can also be set with the "-V" argument. See |-V|.
8941 This option is also set by the |:verbose| command.
8942
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008943 When the 'verbosefile' option is set then the verbose messages are not
8944 displayed.
8945
8946 *'verbosefile'* *'vfile'*
8947'verbosefile' 'vfile' string (default empty)
8948 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008949 When not empty all messages are written in a file with this name.
8950 When the file exists messages are appended.
8951 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008952 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008953 Setting 'verbosefile' to a new value is like making it empty first.
8954 The difference with |:redir| is that verbose messages are not
8955 displayed when 'verbosefile' is set.
8956
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 *'viewdir'* *'vdir'*
Christian Brabandtb8b1c8e2023-06-23 22:23:01 +01008958'viewdir' 'vdir' string (default for Amiga "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008959 for Win32: "$HOME/vimfiles/view",
Christian Brabandtb8b1c8e2023-06-23 22:23:01 +01008960 for Unix: "$HOME/.vim/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01008961 for macOS: "$VIM/vimfiles/view"
8962 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008963 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008964 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 feature}
8966 Name of the directory where to store files for |:mkview|.
8967 This option cannot be set from a |modeline| or in the |sandbox|, for
8968 security reasons.
8969
8970 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008971'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008973 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008974 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008975 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008976 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008977 word save and restore ~
8978 cursor cursor position in file and in window
8979 folds manually created folds, opened/closed folds and local
8980 fold options
8981 options options and mappings local to a window or buffer (not
8982 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008983 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984 slash backslashes in file names replaced with forward
8985 slashes
8986 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008987 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008988 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008989
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008990 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008992 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993
8994 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008995'viminfo' 'vi' string (Vi default: "", Vim default for
8996 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008997 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8998 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009000 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 feature}
9002 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009003 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9004 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009005 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009006 consisting of a single character identifying the particular parameter,
9007 followed by a number or string which specifies the value of that
9008 parameter. If a particular character is left out, then the default
9009 value is used for that parameter. The following is a list of the
9010 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009012 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 ! When included, save and restore global variables that start
9014 with an uppercase letter, and don't contain a lowercase
9015 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009016 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009017 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009018 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 " Maximum number of lines saved for each register. Old name of
9020 the '<' item, with the disadvantage that you need to put a
9021 backslash before the ", otherwise it will be recognized as the
9022 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009023 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 % When included, save and restore the buffer list. If Vim is
9025 started with a file name argument, the buffer list is not
9026 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009027 buffer list is restored from the viminfo file. Quickfix
9028 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9029 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009030 When followed by a number, the number specifies the maximum
9031 number of buffers that are stored. Without a number all
9032 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009033 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009034 ' Maximum number of previously edited files for which the marks
9035 are remembered. This parameter must always be included when
9036 'viminfo' is non-empty.
9037 Including this item also means that the |jumplist| and the
9038 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009039 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009040 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009041 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009042 patterns are also saved. When not included, the value of
9043 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009044 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009045 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009046 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009047 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 < Maximum number of lines saved for each register. If zero then
9049 registers are not saved. When not included, all lines are
9050 saved. '"' is the old name for this item.
9051 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009052 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009054 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009055 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056 c When included, convert the text in the viminfo file from the
9057 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009058 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009059 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060 f Whether file marks need to be stored. If zero, file marks ('0
9061 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009062 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009064 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009065 h Disable the effect of 'hlsearch' when loading the viminfo
9066 file. When not included, it depends on whether ":nohlsearch"
9067 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009068 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009070 the 'n'. Must be at the end of the option! If the
9071 'viminfofile' option is set, that file name overrides the one
9072 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009073 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009074 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 r Removable media. The argument is a string (up to the next
9076 ','). This parameter can be given several times. Each
9077 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009078 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9080 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9081 ignored. Maximum length of each 'r' argument is 50
9082 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009083 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009084 s Maximum size of an item in Kbyte. If zero then registers are
9085 not saved. Currently only applies to registers. The default
9086 "s10" will exclude registers with more than 10 Kbyte of text.
9087 Also see the '<' item above: line count limit.
9088
9089 Example: >
9090 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9091<
9092 '50 Marks will be remembered for the last 50 files you
9093 edited.
9094 <1000 Contents of registers (up to 1000 lines each) will be
9095 remembered.
9096 s100 Registers with more than 100 Kbyte text are skipped.
9097 :0 Command-line history will not be saved.
9098 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9099 no / Since '/' is not specified, the default will be used,
9100 that is, save all of the search history, and also the
9101 previous search and substitute patterns.
9102 no % The buffer list will not be saved nor read back.
9103 no h 'hlsearch' highlighting will be restored.
9104
9105 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9106 load the contents of the file, this is not done automatically.
9107
9108 This option cannot be set from a |modeline| or in the |sandbox|, for
9109 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009110 NOTE: This option is set to the Vim default value when 'compatible'
9111 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009113 *'viminfofile'* *'vif'*
9114'viminfofile' 'vif' string (default: "")
9115 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009116 {not available when compiled without the |+viminfo|
9117 feature}
9118 When non-empty, overrides the file name used for viminfo.
9119 When equal to "NONE" no viminfo file will be read or written.
9120 This option can be set with the |-i| command line flag. The |--clean|
9121 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009122 This option cannot be set from a |modeline| or in the |sandbox|, for
9123 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009124
Bram Moolenaar071d4272004-06-13 20:20:40 +00009125 *'virtualedit'* *'ve'*
9126'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009127 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009128 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009129 block Allow virtual editing in Visual block mode.
9130 insert Allow virtual editing in Insert mode.
9131 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009132 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009133 none When used as the local value, do not allow virtual
9134 editing even when the global value is set. When used
9135 as the global value, "none" is the same as "".
9136 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009137
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009139 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009140 of the line. Useful for selecting a rectangle in Visual mode and
9141 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009142 "onemore" is not the same, it will only allow moving the cursor just
9143 after the last character of the line. This makes some commands more
9144 consistent. Previously the cursor was always past the end of the line
9145 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009146 break some plugins or Vim scripts. For example because |l| can move
9147 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009148 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009149 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009150 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009151 It doesn't make sense to combine "all" with "onemore", but you will
9152 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009153 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009154 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009155
9156 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9157'visualbell' 'vb' boolean (default off)
9158 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009159 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009160 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009161 use: >
9162 :set vb t_vb=
9163< If you want a short flash, you can use this on many terminals: >
9164 :set vb t_vb=[?5h$<100>[?5l
9165< Here $<100> specifies the time, you can use a smaller or bigger value
9166 to get a shorter or longer flash.
9167
9168 Note: Vim will limit the bell to once per half a second. This avoids
9169 having to wait for the flashing to finish when there are lots of
9170 bells, e.g. on key repeat. This also happens without 'visualbell'
9171 set.
9172
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9174 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9175 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009176
9177 Note: When the GUI starts, 't_vb' is reset to its default value. You
9178 might want to set it again in your |gvimrc|.
9179
Bram Moolenaar071d4272004-06-13 20:20:40 +00009180 Does not work on the Amiga, you always get a screen flash.
9181 Also see 'errorbells'.
9182
9183 *'warn'* *'nowarn'*
9184'warn' boolean (default on)
9185 global
9186 Give a warning message when a shell command is used while the buffer
9187 has been changed.
9188
9189 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9190'weirdinvert' 'wiv' boolean (default off)
9191 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009192 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009193 It is provided for backwards compatibility with version 4.x.
9194 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9195 vice versa. Has no effect when the GUI is running.
9196
9197 *'whichwrap'* *'ww'*
9198'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009200 Allow specified keys that move the cursor left/right to move to the
9201 previous/next line when the cursor is on the first/last character in
9202 the line. Concatenate characters to allow this for these keys:
9203 char key mode ~
9204 b <BS> Normal and Visual
9205 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009206 h "h" Normal and Visual (not recommended)
9207 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208 < <Left> Normal and Visual
9209 > <Right> Normal and Visual
9210 ~ "~" Normal
9211 [ <Left> Insert and Replace
9212 ] <Right> Insert and Replace
9213 For example: >
9214 :set ww=<,>,[,]
9215< allows wrap only when cursor keys are used.
9216 When the movement keys are used in combination with a delete or change
9217 operator, the <EOL> also counts for a character. This makes "3h"
9218 different from "3dh" when the cursor crosses the end of a line. This
9219 is also true for "x" and "X", because they do the same as "dl" and
9220 "dh". If you use this, you may also want to use the mapping
9221 ":map <BS> X" to make backspace delete the character in front of the
9222 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009223 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009224 line (not an empty line) then it will not move to the next line. This
9225 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009226 NOTE: This option is set to the Vi default value when 'compatible' is
9227 set and to the Vim default value when 'compatible' is reset.
9228
9229 *'wildchar'* *'wc'*
9230'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232 Character you have to type to start wildcard expansion in the
9233 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009234 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009235 The character is not recognized when used inside a macro. See
9236 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009237 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009238 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009239 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240< NOTE: This option is set to the Vi default value when 'compatible' is
9241 set and to the Vim default value when 'compatible' is reset.
9242
9243 *'wildcharm'* *'wcm'*
9244'wildcharm' 'wcm' number (default: none (0))
9245 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009246 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009247 recognized when used inside a macro. You can find "spare" command-line
9248 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249 you'll never actually type 'wildcharm', just use it in mappings that
9250 automatically invoke completion mode, e.g.: >
9251 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009252 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009253< Then after typing :ss you can use CTRL-P & CTRL-N.
9254
9255 *'wildignore'* *'wig'*
9256'wildignore' 'wig' string (default "")
9257 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009258 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009259 patterns is ignored when expanding |wildcards|, completing file or
9260 directory names, and influences the result of |expand()|, |glob()| and
9261 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009262 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9263 Also see 'suffixes'.
9264 Example: >
9265 :set wildignore=*.o,*.obj
9266< The use of |:set+=| and |:set-=| is preferred when adding or removing
9267 a pattern from the list. This avoids problems when a future version
9268 uses another default.
9269
Bram Moolenaar94950a92010-12-02 16:01:29 +01009270
Bram Moolenaar81af9252010-12-10 20:35:50 +01009271 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009272'wildignorecase' 'wic' boolean (default off)
9273 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009274 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009275 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009276 Does not apply when the shell is used to expand wildcards, which
9277 happens when there are special characters.
9278
9279
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009281'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009282 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009283 When 'wildmenu' is on, command-line completion operates in an enhanced
9284 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009285 the possible matches are shown.
9286 When 'wildoptions' contains "pum", then the completion matches are
9287 shown in a popup menu. Otherwise they are displayed just above the
9288 command line, with the first match highlighted (overwriting the status
9289 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009290 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009291 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9292 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9293 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009294 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009295 If there are more matches than can fit in the line, a ">" is shown on
9296 the right and/or a "<" is shown on the left. The status line scrolls
9297 as needed.
9298 The "wildmenu" mode is abandoned when a key is hit that is not used
9299 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009300 While the "wildmenu" is active, not using the popup menu, the
9301 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009302
9303 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9304 <Down> - in filename/menu name completion: move into a
9305 subdirectory or submenu.
9306 <CR> - in menu completion, when the cursor is just after a
9307 dot: move into a submenu.
9308 <Up> - in filename/menu name completion: move up into
9309 parent directory or parent menu.
9310
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009311 When using the popup menu for command line completion, the following
9312 keys have special meanings:
9313 <Down> - select next match (like CTRL-N)
9314 <Left> - in filename/menu name completion: move up into
9315 parent directory or parent menu.
9316 <Right> - in filename/menu name completion: move into a
9317 subdirectory or submenu.
9318 <Up> - select previous match (like CTRL-P)
9319 CTRL-E - end completion, go back to what was there before
9320 selecting a match.
9321 CTRL-N - go to the next entry
9322 CTRL-P - go to the previous entry
9323 CTRL-Y - accept the currently selected match and stop
9324 completion.
9325
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326 This makes the menus accessible from the console |console-menus|.
9327
9328 If you prefer the <Left> and <Right> keys to move the cursor instead
9329 of selecting a different match, use this: >
9330 :cnoremap <Left> <Space><BS><Left>
9331 :cnoremap <Right> <Space><BS><Right>
9332<
9333 The "WildMenu" highlighting is used for displaying the current match
9334 |hl-WildMenu|.
9335
9336 *'wildmode'* *'wim'*
9337'wildmode' 'wim' string (Vim default: "full")
9338 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009339 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009340 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009341 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009342 first part specifies the behavior for the first use of 'wildchar',
9343 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009344
9345 Each part consists of a colon separated list consisting of the
9346 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009347 "" Complete only the first match.
9348 "full" Complete the next full match. After the last match,
9349 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009350 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009351 "longest" Complete till longest common string. If this doesn't
9352 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009353 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009354 "lastused" When completing buffer names and more than one buffer
9355 matches, sort buffers by time last used (other than
9356 the current buffer).
9357 When there is only a single match, it is fully completed in all cases.
9358
9359 Examples of useful colon-separated values:
9360 "longest:full" Like "longest", but also start 'wildmenu' if it is
9361 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009362 "list:full" When more than one match, list all matches and
9363 complete first match.
9364 "list:longest" When more than one match, list all matches and
9365 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009366 "list:lastused" When more than one buffer matches, list all matches
9367 and sort buffers by time last used (other than the
9368 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009369
9370 Examples: >
9371 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009372< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009373 :set wildmode=longest,full
9374< Complete longest common string, then each full match >
9375 :set wildmode=list:full
9376< List all matches and complete each full match >
9377 :set wildmode=list,full
9378< List all matches without completing, then each full match >
9379 :set wildmode=longest,list
9380< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009381 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009382
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009383 *'wildoptions'* *'wop'*
9384'wildoptions' 'wop' string (default "")
9385 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009386 A list of words that change how |cmdline-completion| is done.
9387 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009388 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009389 this value is specified, wildcard expansion will not
9390 be used for completion. The matches will be sorted by
9391 the "best match" rather than alphabetically sorted.
9392 This will find more matches than the wildcard
9393 expansion. Currently fuzzy matching based completion
9394 is not supported for file and directory names and
9395 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009396 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009397 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009398 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009399 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009400 is displayed per line. Often used tag kinds are:
9401 d #define
9402 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009403
Bram Moolenaar071d4272004-06-13 20:20:40 +00009404 *'winaltkeys'* *'wak'*
9405'winaltkeys' 'wak' string (default "menu")
9406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009407 {only used in Win32, Motif, GTK and Photon GUI}
9408 Some GUI versions allow the access to menu entries by using the ALT
9409 key in combination with a character that appears underlined in the
9410 menu. This conflicts with the use of the ALT key for mappings and
9411 entering special characters. This option tells what to do:
9412 no Don't use ALT keys for menus. ALT key combinations can be
9413 mapped, but there is no automatic handling. This can then be
9414 done with the |:simalt| command.
9415 yes ALT key handling is done by the windowing system. ALT key
9416 combinations cannot be mapped.
9417 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009418 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009419 keys can be mapped.
9420 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9421 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009422 This option is not used for <F10>; on Win32 and with GTK <F10> will
9423 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009424
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009425 *'wincolor'* *'wcr'*
9426'wincolor' 'wcr' string (default empty)
9427 local to window
9428 Highlight group name to use for this window instead of the Normal
9429 color |hl-Normal|.
9430
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009431 *'window'* *'wi'*
9432'window' 'wi' number (default screen height - 1)
9433 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009434 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9435 window and the value is smaller than 'lines' minus one. The screen
9436 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009437 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9438 in a much smarter way, taking care of wrapping lines.
9439 When resizing the Vim window, the value is smaller than 1 or more than
9440 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009441 Note: Do not confuse this with the height of the Vim window, use
9442 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009443
Bram Moolenaar071d4272004-06-13 20:20:40 +00009444 *'winheight'* *'wh'* *E591*
9445'winheight' 'wh' number (default 1)
9446 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009447 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009448 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009449 focus goes to a window that is smaller, its size is increased, at the
9450 cost of the height of other windows.
9451 Set 'winheight' to a small number for normal editing.
9452 Set it to 999 to make the current window fill most of the screen.
9453 Other windows will be only 'winminheight' high. This has the drawback
9454 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9455 to create only two windows, set the option after startup is done,
9456 using the |VimEnter| event: >
9457 au VimEnter * set winheight=999
9458< Minimum value is 1.
9459 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009460 height of the current window.
9461 'winheight' applies to the current window. Use 'winminheight' to set
9462 the minimal height for other windows.
9463
9464 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9465'winfixheight' 'wfh' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02009466 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009467 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009468 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9469 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009470 The height may be changed anyway when running out of room.
9471
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009472 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9473'winfixwidth' 'wfw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02009474 local to window |local-noglobal|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009475 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009476 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009477 The width may be changed anyway when running out of room.
9478
Bram Moolenaar071d4272004-06-13 20:20:40 +00009479 *'winminheight'* *'wmh'*
9480'winminheight' 'wmh' number (default 1)
9481 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009482 The minimal height of a window, when it's not the current window.
9483 This is a hard minimum, windows will never become smaller.
9484 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9485 status bar) if necessary. They will return to at least one line when
9486 they become active (since the cursor has to have somewhere to go.)
9487 Use 'winheight' to set the minimal height of the current window.
9488 This option is only checked when making a window smaller. Don't use a
9489 large number, it will cause errors when opening more than a few
9490 windows. A value of 0 to 3 is reasonable.
9491
9492 *'winminwidth'* *'wmw'*
9493'winminwidth' 'wmw' number (default 1)
9494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009495 The minimal width of a window, when it's not the current window.
9496 This is a hard minimum, windows will never become smaller.
9497 When set to zero, windows may be "squashed" to zero columns (i.e. just
9498 a vertical separator) if necessary. They will return to at least one
9499 line when they become active (since the cursor has to have somewhere
9500 to go.)
9501 Use 'winwidth' to set the minimal width of the current window.
9502 This option is only checked when making a window smaller. Don't use a
9503 large number, it will cause errors when opening more than a few
9504 windows. A value of 0 to 12 is reasonable.
9505
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009506 *'winptydll'*
9507'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9508 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009509 {only available when compiled with the |terminal|
9510 feature on MS-Windows}
9511 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009512 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009513 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009514 a fallback.
9515 Environment variables are expanded |:set_env|.
9516 This option cannot be set from a |modeline| or in the |sandbox|, for
9517 security reasons.
9518
Bram Moolenaar071d4272004-06-13 20:20:40 +00009519 *'winwidth'* *'wiw'* *E592*
9520'winwidth' 'wiw' number (default 20)
9521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009522 Minimal number of columns for the current window. This is not a hard
9523 minimum, Vim will use fewer columns if there is not enough room. If
9524 the current window is smaller, its size is increased, at the cost of
9525 the width of other windows. Set it to 999 to make the current window
9526 always fill the screen. Set it to a small number for normal editing.
9527 The width is not adjusted after one of the commands to change the
9528 width of the current window.
9529 'winwidth' applies to the current window. Use 'winminwidth' to set
9530 the minimal width for other windows.
9531
9532 *'wrap'* *'nowrap'*
9533'wrap' boolean (default on)
9534 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009535 This option changes how text is displayed. It doesn't change the text
9536 in the buffer, see 'textwidth' for that.
9537 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009538 displaying continues on the next line. When off lines will not wrap
9539 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009540 moved to a part that is not shown, the screen will scroll
9541 horizontally.
9542 The line will be broken in the middle of a word if necessary. See
9543 'linebreak' to get the break at a word boundary.
9544 To make scrolling horizontally a bit more useful, try this: >
9545 :set sidescroll=5
9546 :set listchars+=precedes:<,extends:>
9547< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009548 This option can't be set from a |modeline| when the 'diff' option is
9549 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009550
9551 *'wrapmargin'* *'wm'*
9552'wrapmargin' 'wm' number (default 0)
9553 local to buffer
9554 Number of characters from the right window border where wrapping
9555 starts. When typing text beyond this limit, an <EOL> will be inserted
9556 and inserting continues on the next line.
9557 Options that add a margin, such as 'number' and 'foldcolumn', cause
9558 the text width to be further reduced. This is Vi compatible.
9559 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009560 This option is set to 0 when 'paste' is set and restored when 'paste'
9561 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009562 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009563
9564 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9565'wrapscan' 'ws' boolean (default on) *E384* *E385*
9566 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009567 Searches wrap around the end of the file. Also applies to |]s| and
9568 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009569
9570 *'write'* *'nowrite'*
9571'write' boolean (default on)
9572 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009573 Allows writing files. When not set, writing a file is not allowed.
9574 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009575 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009576 argument. Filtering text is still possible, even though this requires
9577 writing a temporary file.
9578
9579 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9580'writeany' 'wa' boolean (default off)
9581 global
9582 Allows writing to any file with no need for "!" override.
9583
9584 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9585'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9586 otherwise)
9587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009588 Make a backup before overwriting a file. The backup is removed after
9589 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009590 also on.
9591 WARNING: Switching this option off means that when Vim fails to write
9592 your buffer correctly and then, for whatever reason, Vim exits, you
9593 lose both the original file and what you were writing. Only reset
9594 this option if your file system is almost full and it makes the write
9595 fail (and make sure not to exit Vim until the write was successful).
9596 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009597 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009598 Depending on 'backupcopy' the backup is a new file or the original
9599 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009600 NOTE: This option is set to the default value when 'compatible' is
9601 set.
9602
9603 *'writedelay'* *'wd'*
9604'writedelay' 'wd' number (default 0)
9605 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009606 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009607 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009608 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009609
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009610 *'xtermcodes'* *'noxtermcodes'*
9611'xtermcodes' boolean (default on)
9612 global
9613 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009614 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009615 key codes and number of colors from the terminal. This takes care of
9616 various configuration options of the terminal that cannot be obtained
9617 from the termlib/terminfo entry, see |xterm-codes|.
9618 A side effect may be that t_Co changes and Vim will redraw the
9619 display.
9620
9621
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009622 vim:tw=78:ts=8:noet:ft=help:norl: